PowerShell / PowerShell/PSScriptAnalyzer

Improve rule suppression documentation

Offen
#697 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Existing documentation doesn't provide any information regarding rule-wise behavior of code suppression.

For example, PSSA cannot suppress PSAvoidUsingUserNameAndPassWordParams violations based on given rulesuppressionid.

    Configuration Foo
    {             
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordParams", "UserName", Scope="Function")]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordPara", "EncryptedPassword", Scope="Function")]
        param (
            [Parameter(Mandatory)]
            [String]$UserName,

            [Parameter(Mandatory)]
            [String]$Password
        )

    }

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

Der Issue nennt keine Dokumentationsdatei oder keinen Test. Beginne damit, die vorhandene Dokumentation zur Regelunterdrückung zu finden und zu überprüfen, wie PSSA mit dem gezeigten Beispiel für SuppressMessageAttribute umgeht, einschließlich der Werte von rulesuppressionid. Als erledigt gilt die Aufgabe, wenn die Dokumentation das Unterdrückungsverhalten auf Regelbasis erklärt und das Beispiel PSavoidUsingUserNameAndPassWordParams abdeckt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
powershell
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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