PowerShell
PSScriptAnalyzer - PowerShellスクリプトアナライザ
サーチ…
前書き
PSScriptAnalyzer、 https://github.com/PowerShell/PSScriptAnalyzerは、Windows PowerShellモジュールとスクリプトの静的コードチェッカーです。 PSScriptAnalyzerは、PowerShellチームおよびコミュニティによって特定されたPowerShellのベストプラクティスに基づいて一連のルールを実行することにより、Windows PowerShellコードの品質をチェックします。 DiagnosticResults(エラーと警告)を生成して潜在的なコードの不具合をユーザーに通知し、改善のための解決策を提案します。
PS> Install-Module -Name PSScriptAnalyzer
構文
-
Get-ScriptAnalyzerRule [-CustomizedRulePath <string[]>] [-Name <string[]>] [-Severity <string[]>] [<CommonParameters>]
-
Invoke-ScriptAnalyzer [-Path] <string> [-CustomizedRulePath <string[]>] [-ExcludeRule <string[]>] [-IncludeRule<string[]>] [-Severity <string[]>] [-Recurse] [-SuppressedOnly] [<CommonParameters>]
組み込みプリセットルールセットを使用したスクリプトの分析
ScriptAnalyzerには、スクリプトを分析するためのプリセットルールが組み込まれています。 PSGallery
、 DSC
、 CodeFormatting
などがありCodeFormatting
。それらは次のように実行できます:
PowerShell Galleryのルール
PowerShell Galleryルールを実行するには、次のコマンドを使用します。
Invoke-ScriptAnalyzer -Path /path/to/module/ -Settings PSGallery -Recurse
DSCルール
DSCルールを実行するには、次のコマンドを使用します。
Invoke-ScriptAnalyzer -Path /path/to/module/ -Settings DSC -Recurse
コードの書式設定の規則
コードの書式設定ルールを実行するには、次のコマンドを使用します。
Invoke-ScriptAnalyzer -Path /path/to/module/ -Settings CodeFormatting -Recurse
すべてのビルトインルールに対するスクリプトの分析
スクリプト・アナライザを単一のスクリプト・ファイルに対して実行するには、次のコマンドを実行します。
Invoke-ScriptAnalyzer -Path myscript.ps1
これにより、組み込みルールごとにスクリプトが分析されます。スクリプトが十分に大きい場合、警告やエラーが発生する可能性があります。
スクリプトアナライザをディレクトリ全体に対して実行するには、解析するスクリプト、モジュール、およびDSCファイルを含むフォルダを指定します。サブディレクトリでファイルを検索して分析する場合は、Recurseパラメータを指定します。
Invoke-ScriptAnalyzer -Path . -Recurse
すべてのビルトインルールを一覧表示する
組み込みルールをすべて表示するには、次のようにします。
Get-ScriptAnalyzerRule