PowerShell / PowerShell/vscode-powershell
Allow VSCode configuration of PSScriptAnalyzer rules
Open
Nobody has claimed this yet.
Area-Configuration
Area-Script Analysis
Issue-Discussion
Issue-Enhancement
Up for Grabs
- Dominant language
- TypeScript
- Stars
- 1.9k
- Forks
- 547
- PR merge metrics
- No merged PRs in 30d
Description
To follow on from the comments starting at https://github.com/PowerShell/vscode-powershell/issues/1429#issuecomment-404695963...
PSSA rules should be enable-able and disable-able in VSCode configuration. The current proposal is:
- Disabled rules turn off default rules, but not a local PSSA settings file
- Enabled rules add to the default rules
Current proposed format is:
{
"powershell.scriptAnalysis.rules": {
"disable": [
"PSAvoidTrailingWhitespace"
],
"enable": [
"RuleThatILikeButMyColleaguesDont",
]
}
}
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 with the discussion linked from issue #1429 and trace how the powershell.scriptAnalysis.rules configuration is currently handled. The proposed format defines disable and enable lists; done means VSCode configuration can apply those lists with the stated interaction with default rules and a local PSSA settings file.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell, typescript, vscode
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100