Skip to content

Add StaticAnalysis rule for plural nouns in cmdlet and parameter names #3349

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

Merged
merged 4 commits into from
Feb 1, 2017

Conversation

cormacpayne
Copy link
Member

@cormacpayne cormacpayne commented Jan 4, 2017

Description

Fix for issue #2919

Add rule to check for plural nouns in a cmdlet name and parameter name. There is an exception list for nouns that end with "s", but aren't plural, so any future cmdlet/parameter that uses a noun that is flagged as plural but is singular can add that noun to that list.


This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.

General Guidelines

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
  • The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

  • Pull request includes test coverage for the included changes.
  • PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

  • New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
  • Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThrough parameter.

Cmdlet Parameter Guidelines

  • Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
  • Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
  • Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

@shahabhijeet
Copy link
Contributor

@cormacpayne looks good

@markcowl
Copy link
Member

@azuresdkci retest this please

@markcowl
Copy link
Member

LGTM, just want to make sure no additional exceptions are necessary

@markcowl
Copy link
Member

@azuresdkci retest this please

@cormacpayne
Copy link
Member Author

@markcowl any other comments?

@markcowl markcowl merged commit 8c7e2ff into Azure:dev Feb 1, 2017
@cormacpayne cormacpayne deleted the plural-noun-check branch August 7, 2017 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants