PowerShell / PowerShell/PSScriptAnalyzer

Suppressing PSAvoidGlobalVars for a single variable

Offen
#822 2 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Hi, I've got a legacy script which I've started running through PSScriptAnalyzer, and I've got a bunch of global variables which I'm gradually refactoring away. However, one of them is proving difficult to deal with so I'd like to suppress the PSAvoidGlobalVars error on just that one for now, while leaving the others still erroring to remind me I need to come back and fix them later.

I don't really want to exclude the rule entirely, so I've tried this...

myScript.ps1

$global:myGlobalVar1 = "abc";

[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidGlobalVars", "")]
$global:myGlobalVar2 = "pqr";

$global:myGlobalVar3 = "xyz";

... but it doesn't seem to suppress the error for $global:myGlobalVar2.

Is there another way to do this?

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

Beginne mit dem Unterdrückungsbeispiel in myScript.ps1 und untersuche, wie die Regel PSAvoidGlobalVars mit SuppressMessageAttribute umgeht. Überprüfe das dokumentierte Unterdrückungsverhalten des Projekts und die zugehörigen Tests, sofern vorhanden. Als abgeschlossen gilt die Aufgabe, wenn festgestellt wurde, ob nur $global:myGlobalVar2 unterdrückt werden kann, und der unterstützte Ansatz dokumentiert oder validiert wurde, ohne die Regel global zu deaktivieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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