PowerShell
PSScriptAnalyzer - PowerShell Script Analyzer
Suche…
Einführung
PSScriptAnalyzer, https://github.com/PowerShell/PSScriptAnalyzer , ist ein statischer Code-Checker für Windows PowerShell-Module und -Scripts. PSScriptAnalyzer überprüft die Qualität von Windows PowerShell-Code, indem es eine Reihe von Regeln ausführt, die auf den vom PowerShell-Team und der Community ermittelten Best Practices basieren. Es generiert Diagnose-Ergebnisse (Fehler und Warnungen), um Benutzer über mögliche Codefehler zu informieren, und schlägt mögliche Lösungen für Verbesserungen vor.
PS> Install-Module -Name PSScriptAnalyzer
Syntax
-
Get-ScriptAnalyzerRule [-CustomizedRulePath <string[]>] [-Name <string[]>] [-Severity <string[]>] [<CommonParameters>]
-
Invoke-ScriptAnalyzer [-Path] <string> [-CustomizedRulePath <string[]>] [-ExcludeRule <string[]>] [-IncludeRule<string[]>] [-Severity <string[]>] [-Recurse] [-SuppressedOnly] [<CommonParameters>]
Analysieren von Skripts mit den integrierten voreingestellten Regelsätzen
Im Lieferumfang von ScriptAnalyzer sind vordefinierte Regeln enthalten, die zur Analyse von Skripts verwendet werden können. Dazu gehören: PSGallery
, DSC
und CodeFormatting
. Sie können wie folgt ausgeführt werden:
Regeln für die PowerShell-Galerie
Verwenden Sie zum Ausführen der PowerShell Gallery-Regeln den folgenden Befehl:
Invoke-ScriptAnalyzer -Path /path/to/module/ -Settings PSGallery -Recurse
DSC-Regeln
Um die DSC-Regeln auszuführen, verwenden Sie den folgenden Befehl:
Invoke-ScriptAnalyzer -Path /path/to/module/ -Settings DSC -Recurse
Code-Formatierungsregeln
Verwenden Sie zum Ausführen der Code-Formatierungsregeln den folgenden Befehl:
Invoke-ScriptAnalyzer -Path /path/to/module/ -Settings CodeFormatting -Recurse
Analysieren von Skripts anhand jeder integrierten Regel
So führen Sie den Skriptanalysator für eine einzelne Skriptdatei aus:
Invoke-ScriptAnalyzer -Path myscript.ps1
Dadurch wird Ihr Skript anhand jeder integrierten Regel analysiert. Wenn Ihr Skript ausreichend groß ist, kann dies zu zahlreichen Warnungen und / oder Fehlern führen.
Um den Skriptanalysator für ein gesamtes Verzeichnis auszuführen, geben Sie den Ordner an, der die zu analysierenden Skript-, Modul- und DSC-Dateien enthält. Geben Sie den Parameter Recurse an, wenn Sie auch die Unterverzeichnisse nach zu analysierenden Dateien durchsuchen möchten.
Invoke-ScriptAnalyzer -Path . -Recurse
Listet alle integrierten Regeln auf
Um zu sehen, wie alle integrierten Regeln ausgeführt werden:
Get-ScriptAnalyzerRule