PowerShell
PSScriptAnalyzer - Analizator skryptów PowerShell
Szukaj…
Wprowadzenie
PSScriptAnalyzer, https://github.com/PowerShell/PSScriptAnalyzer , jest statycznym narzędziem do sprawdzania kodu modułów i skryptów Windows PowerShell. PSScriptAnalyzer sprawdza jakość kodu Windows PowerShell, uruchamiając zestaw reguł opartych na najlepszych praktykach PowerShell określonych przez zespół i społeczność PowerShell. Generuje wyniki diagnostyczne (błędy i ostrzeżenia), aby informować użytkowników o potencjalnych wadach kodu i sugerować możliwe rozwiązania ulepszeń.
PS> Install-Module -Name PSScriptAnalyzer
Składnia
-
Get-ScriptAnalyzerRule [-CustomizedRulePath <string[]>] [-Name <string[]>] [-Severity <string[]>] [<CommonParameters>] -
Invoke-ScriptAnalyzer [-Path] <string> [-CustomizedRulePath <string[]>] [-ExcludeRule <string[]>] [-IncludeRule<string[]>] [-Severity <string[]>] [-Recurse] [-SuppressedOnly] [<CommonParameters>]
Analizowanie skryptów za pomocą wbudowanych zestawów reguł
ScriptAnalyzer jest dostarczany z zestawami wbudowanych reguł, które można wykorzystać do analizy skryptów. Należą do nich: PSGallery , DSC i CodeFormatting . Można je wykonać w następujący sposób:
Zasady Galerii PowerShell
Aby wykonać reguły Galerii PowerShell, użyj następującego polecenia:
Invoke-ScriptAnalyzer -Path /path/to/module/ -Settings PSGallery -Recurse
Zasady DSC
Aby wykonać reguły DSC, użyj następującego polecenia:
Invoke-ScriptAnalyzer -Path /path/to/module/ -Settings DSC -Recurse
Reguły formatowania kodu
Aby wykonać reguły formatowania kodu, użyj następującego polecenia:
Invoke-ScriptAnalyzer -Path /path/to/module/ -Settings CodeFormatting -Recurse
Analizowanie skryptów pod kątem każdej wbudowanej reguły
Aby uruchomić analizator skryptów dla pojedynczego pliku skryptu, wykonaj:
Invoke-ScriptAnalyzer -Path myscript.ps1
Spowoduje to przeanalizowanie skryptu pod kątem każdej wbudowanej reguły. Jeśli twój skrypt jest wystarczająco duży, może to spowodować wiele ostrzeżeń i / lub błędów.
Aby uruchomić analizator skryptów dla całego katalogu, określ folder zawierający pliki skryptu, modułu i DSC, które chcesz przeanalizować. Podaj parametr Recurse, jeśli chcesz, aby podkatalogi wyszukiwały pliki do analizy.
Invoke-ScriptAnalyzer -Path . -Recurse
Wyświetl wszystkie wbudowane reguły
Aby zobaczyć wykonanie wszystkich wbudowanych reguł:
Get-ScriptAnalyzerRule