PowerShell / PowerShell/PSScriptAnalyzer
PSProvideCommentHelp should also warn on script param blocks
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- C#
- Estrellas
- 2.2k
- Forks
- 414
- Merge medio
- 13 h 1 min
- PR fusionados (30 d)
- 2
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con la regla PSProvideCommentHelp y usa Invoke-ScriptAnalyzer con la definición de script param($foo) de nivel superior como reproducción. Compárala con el ejemplo existente de function param; se considera completado cuando el bloque de parámetros del script produce el mismo diagnóstico de comentario de ayuda.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- powershell
- Área
- tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100