PowerShell / PowerShell/PSScriptAnalyzer
PSProvideCommentHelp should also warn on script param blocks
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
Summary of the new feature
As a user, I want the ## comment generation feature in the PowerShell extension for VSCode to also generate comment based help for param blocks at the top of scripts. The PowerShell extension leverages the PSProvideCommentHelp rule to do this.
Proposed technical implementation details (optional)
Invoke-ScriptAnalyzer -ScriptDefinition 'param($foo)' -Settings @{
Rules = @{
PSProvideCommentHelp = @{
Enable = $true
ExportedOnly = $false
BlockComment = $true
VSCodeSnippetCorrection = $false
Placement = "before"
}
}
}
This should yield a diagnostic record just like this does:
Invoke-ScriptAnalyzer -ScriptDefinition 'function asdf { param($foo) }' -Settings @{
Rules = @{
PSProvideCommentHelp = @{
Enable = $true
ExportedOnly = $false
BlockComment = $true
VSCodeSnippetCorrection = $false
Placement = "before"
}
}
}
RuleName Severity ScriptName Line Message
-------- -------- ---------- ---- -------
PSProvideCommentHelp Information 1 The cmdlet 'asdf' does not have a help comment.
What is the latest version of PSScriptAnalyzer at the point of writing
1.18.3
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 PSProvideCommentHelp rule and use Invoke-ScriptAnalyzer with the top-level param($foo) script definition as the reproduction. Compare it with the existing function param example; done means the script param block produces the same help-comment diagnostic.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100