PowerShell / PowerShell/PSScriptAnalyzer
Setting file keys are not matching cmdlet parameters exactly
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
Raised due to this comment:
Invoke-ScriptAnalyzer has parameters IncludeRule and ExcludeRule parameters and the equivalent of those in the settings file are IncludeRules and ExcludeRules with an additional s, which makes it inconsistent, confusing and not intuitive to work with. The settings file also needs to support the singular form (since the plural form should not be removed for backcompat reasons)
Environment data
> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.17.1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Invoke-ScriptAnalyzer parameters and the settings-file handling for IncludeRule, ExcludeRule, IncludeRules, and ExcludeRules. Confirm how the existing plural names are parsed, then make the singular forms work without removing backward compatibility with the plural forms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, powershell
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100