Add UseConsistentParameterSetName Rule #2124
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
liamjpeters
requested review from
andyleejordan,
bergmeister,
michaeltlombardi and
sdwheeler
as code owners
Comment on lines
+18
to
+22
| 1. **Missing DefaultParameterSetName** - Warns when parameter sets are used but no default is specified | ||
| 2. **Multiple parameter declarations** - Detects when a parameter is declared multiple times in the same parameter set. This is ultimately a runtime exception - this check helps catch it sooner. | ||
| 3. **Case mismatch between DefaultParameterSetName and ParameterSetName** - Ensures consistent casing | ||
| 4. **Case mismatch between different ParameterSetName values** - Ensures all references to the same parameter set use identical casing | ||
| 5. **Parameter set names containing newlines** - Warns against using newline characters in parameter set names |
There was a problem hiding this comment.
We need to verify our understanding of parameter sets to review this better, we'll get back to it Liam!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Add UseConsistentParameterSetName rule to detect potential parameter set issues
Parameter set names are case-sensitive in PowerShell (unlike most other elements), which can lead to runtime errors and unexpected behavior when not handled correctly.
The rule performs five key validations:
Fixes #396 with the exception of
ParameterSets that don't have at least one unique parameter.This won't help with Dynamic Parameters.
PR Checklist
.cs,.ps1and.psm1files have the correct copyright headerWIP:to the beginning of the title and remove the prefix when the PR is ready.