PowerShell / PowerShell/PSScriptAnalyzer

Need link to RuleDocumentation with PSSA results

Offen
#816 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Area - Rules Issue - Enhancement Up-for-Grabs
Vorherrschende Sprache
C#
Sterne
2.2k
Forks
414
Ø Merge
13 Std. 1 Min.
Gemergte PRs (30 T.)
2

Beschreibung

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 :

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit der im Issue gezeigten Ausgabe von Invoke-ScriptAnalyzer und verfolgen Sie, wie jede Diagnose, insbesondere RuleName PSUseDeclaredVarsMoreThanAssignments, formatiert wird. Ermitteln Sie, wie RuleDocumentation in dieser Ausgabe als Hyperlink verfügbar gemacht werden kann, und überprüfen Sie anschließend, dass die angezeigten Diagnosen einen funktionierenden Dokumentationslink enthalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, powershell
Bereich
tooling
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.