PowerShell / PowerShell/PSScriptAnalyzer

Need link to RuleDocumentation with PSSA results

Abierto
#816 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Area - Rules Issue - Enhancement Up-for-Grabs
Lenguaje dominante
C#
Estrellas
2.2k
Forks
414
Merge medio
13 h 1 min
PR fusionados (30 d)
2

Descripción

It will be great if there is a hyperlink in the output pointing to rule documentation for guidelines.

Invoke-ScriptAnalyzer C:\Temp\temp.ps1 | fl * -f

Line : 38
Column : 1
Message : The variable 'src1' is assigned but never used.
Extent : $src1
RuleName : PSUseDeclaredVarsMoreThanAssignments
Severity : Warning
ScriptName : temp.ps1
ScriptPath : C:\Temp\temp.ps1
RuleSuppressionID : src1
SuggestedCorrections :

Line : 54
Column : 1
Message : The variable 'src2' is assigned but never used.
Extent : $src2
RuleName : PSUseDeclaredVarsMoreThanAssignments
Severity : Warning
ScriptName : temp.ps1
ScriptPath : C:\Temp\temp.ps1
RuleSuppressionID : src2
SuggestedCorrections :

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza con la salida de Invoke-ScriptAnalyzer mostrada en el issue y rastrea cómo se formatea cada diagnóstico, especialmente RuleName PSUseDeclaredVarsMoreThanAssignments. Determina cómo se puede exponer RuleDocumentation como un hipervínculo en esa salida y, a continuación, verifica que los diagnósticos mostrados incluyan un enlace de documentación funcional.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
csharp, 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
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.