Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider using standard verbs for your cmdlets #10

Closed
jhoek opened this issue Jul 6, 2021 · 4 comments
Closed

Consider using standard verbs for your cmdlets #10

jhoek opened this issue Jul 6, 2021 · 4 comments
Labels
enhancement New feature or request shipped Issue is available in the public release.

Comments

@jhoek
Copy link
Contributor

jhoek commented Jul 6, 2021

Microsoft strongly encourages PowerShell developers to follow certain guidelines when it comes to naming cmdlets to facilitate their discoverability. Use Get-Verb in PowerShell to get a list of approved verbs and their typical usages.

Since your module is already published, changing your cmdlet names now may break existing user scripts. However, what you may want to consider is to change your cmdlet names to comply with Microsofts guidelines, and, where appropriate, give each cmdlet a so called alias that contains the old, non-compliant name. That way, user scripts will not be broken.

@rvanbekkum rvanbekkum added the enhancement New feature or request label Jul 12, 2021
@rvanbekkum
Copy link
Owner

Thank you for filing the issue. I will have a look at that as well. Do you have certain suggestions for cmdlet-names?

@jhoek
Copy link
Contributor Author

jhoek commented Jul 12, 2021

Sync-XliffTranslations and Get-XliffTranslations already comply with Microsoft's guidelines. Check-XliffTranslations should perhaps be called Test-XliffTranslations.

@jhoek
Copy link
Contributor Author

jhoek commented Jul 12, 2021

For Trans-XLiffTranslations, I would consider the verbs Set or Update? Also, nouns in cmdlet names should be singular, so when introducing new names and aliases, you could consider giving the official cmdlet names singular nouns.

@rvanbekkum rvanbekkum added the in-progress One of the contributors is working on this. label Sep 21, 2021
@rvanbekkum rvanbekkum added ships-in-future-update Resolution will be available in the next release. shipped Issue is available in the public release. and removed in-progress One of the contributors is working on this. ships-in-future-update Resolution will be available in the next release. labels Sep 29, 2021
@rvanbekkum
Copy link
Owner

Changes for this have been shipped in the newly release, version 1.3.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request shipped Issue is available in the public release.
Projects
None yet
Development

No branches or pull requests

2 participants