知識マップ: PSScriptAnalyzerでPowerShellスクリプトの品質を守る ── ルール選定とCI導入

記事「PSScriptAnalyzerでPowerShellスクリプトの品質を守る ── ルール選定とCI導入」の主張を、概念と関係(エッジ)に分解した知識グラフの全体です。各関係には根拠・確認日・確度が付いています。

この記事は、PowerShell公式の静的解析モジュールPSScriptAnalyzerを社内スクリプトへ導入する実務手順を扱う。PSScriptAnalyzerSettings.psd1という1つの設定ファイルをリポジトリに置くことで、VS Codeの拡張機能とGitHub ActionsのCIが同じ基準で解析するように整える。重大度はルールごとに決まっており、平文パスワード検出などのルールはError指定だけでは素通りするため、資格情報系のルールは名前を明示してCIの失敗条件に加えるべきだとしている。既存資産には、まずErrorをゼロにし、次に変更ファイルだけを厳格に解析する段階導入を勧め、テストを書かずに初日から効果が出るPSScriptAnalyzerをPesterより先に導入する順序を推奨している。

flowchart LR
    accTitle: PSScriptAnalyzer導入とCI化の知識マップ
    accDescr: PSScriptAnalyzerがInvoke-ScriptAnalyzerや設定ファイルを介してVS CodeとGitHub Actionsの双方に基準をそろえ、重大度に関係なく落とすべきルールを名指しし、段階導入を経てPesterより先に効果を出す様子を示す図。
    psscriptanalyzer["PSScriptAnalyzer"]
    github_actions["GitHub Actions"]
    invoke_scriptanalyzer["Invoke-ScriptAnalyzer"]
    suppressmessageattribute["SuppressMessageAttribute"]
    psscriptanalyzer_settings["PSScriptAnalyzerSettings.psd1"]
    vscode_powershell_extension["VS CodeのPowerShell拡張機能"]
    psavoidusingplaintextforpassword["PSAvoidUsingPlainTextForPassword"]
    psusedeclaredvarsmorethanassignments["PSUseDeclaredVarsMoreThanAssignments"]
    invoke_formatter["Invoke-Formatter"]
    pester["Pester"]
    psscriptanalyzer_staged_adoption["PSScriptAnalyzerの段階導入"]
    changed_file_only_analysis["変更ファイルのみを対象にした差分解析"]
    github_actions_fetch_depth_zero["actions/checkoutのfetch-depth: 0"]
    github_base_ref["GITHUB_BASE_REF"]
    psavoidusingconverttosecurestringwithplaintext["PSAvoidUsingConvertToSecureStringWithPlainText"]
    psavoidusingusernameandpasswordparams["PSAvoidUsingUsernameAndPasswordParams"]
    psscriptanalyzer_mustfix_rules["重大度に関係なく落とすルールの明示リスト"]
    psscriptanalyzer -->|"利用する"| invoke_scriptanalyzer
    psscriptanalyzer -->|"利用する"| suppressmessageattribute
    psscriptanalyzer -->|"で構成できる"| psscriptanalyzer_settings
    vscode_powershell_extension -->|"利用する"| psscriptanalyzer
    vscode_powershell_extension -->|"で構成できる"| psscriptanalyzer_settings
    github_actions -.->|"利用する"| invoke_scriptanalyzer
    psscriptanalyzer -->|"利用する"| psavoidusingplaintextforpassword
    psscriptanalyzer -->|"利用する"| psusedeclaredvarsmorethanassignments
    invoke_scriptanalyzer -->|"利用する"| invoke_formatter
    psscriptanalyzer -->|"より先に行うべき"| pester
    psscriptanalyzer_staged_adoption -->|"前提とする"| psscriptanalyzer
    psscriptanalyzer_staged_adoption -->|"前提とする"| changed_file_only_analysis
    changed_file_only_analysis -.->|"前提とする"| github_actions_fetch_depth_zero
    changed_file_only_analysis -.->|"前提とする"| github_base_ref
    changed_file_only_analysis -.->|"利用する"| github_actions
    changed_file_only_analysis -->|"利用する"| invoke_scriptanalyzer
    psscriptanalyzer -->|"利用する"| psavoidusingconverttosecurestringwithplaintext
    psscriptanalyzer -->|"利用する"| psavoidusingusernameandpasswordparams
    psscriptanalyzer_mustfix_rules -->|"前提とする"| psavoidusingplaintextforpassword
    psscriptanalyzer_mustfix_rules -->|"前提とする"| psavoidusingconverttosecurestringwithplaintext
    psscriptanalyzer_mustfix_rules -->|"前提とする"| psavoidusingusernameandpasswordparams
    github_actions -.->|"利用する"| psscriptanalyzer_mustfix_rules

概念間の関係(全22件)

図と同じ関係を文章でも列挙します。表示している文と機械可読な意味データ(RDFa)は同じ要素に載っています。確度が「確立した関係」のものは直接の関係として、「条件付きの関係」のものは成立条件つきの言明(rdf:Statement)として表現しています。

• PSScriptAnalyzerはInvoke-ScriptAnalyzerを利用します。PSScriptAnalyzerはInvoke-ScriptAnalyzerコマンドレットでスクリプトやモジュールを解析する / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• PSScriptAnalyzerはSuppressMessageAttributeを利用します。PSScriptAnalyzerはSuppressMessageAttributeによる指摘の個別抑止を提供する / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• PSScriptAnalyzerはPSScriptAnalyzerSettings.psd1で構成できます。PSScriptAnalyzerの解析対象ルールと重大度はPSScriptAnalyzerSettings.psd1で構成できる / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• VS CodeのPowerShell拡張機能はPSScriptAnalyzerを利用します。VS CodeのPowerShell拡張機能はPSScriptAnalyzerを内蔵し、編集中にその場で警告を表示する / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• VS CodeのPowerShell拡張機能はPSScriptAnalyzerSettings.psd1で構成できます。VS Code拡張機能の設定powershell.scriptAnalysis.settingsPathの既定値がPSScriptAnalyzerSettings.psd1のため、この名前でリポジトリ直下に置くと編集中の警告とCIの判定基準がそろう / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• GitHub ActionsはInvoke-ScriptAnalyzerを利用します。本記事が組み立てるPSScriptAnalyzerのCIワークフローでは、GitHub Actionsのワークフローはステップの中でInvoke-ScriptAnalyzerを呼び出して解析を実行する / 確度: 条件付きの関係 / 確認日: 2026-08-01 出典
• PSScriptAnalyzerはPSAvoidUsingPlainTextForPasswordを利用します。PSScriptAnalyzerは平文パスワード検出ルールPSAvoidUsingPlainTextForPasswordを組み込みルールとして持つ / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• PSScriptAnalyzerはPSUseDeclaredVarsMoreThanAssignmentsを利用します。PSScriptAnalyzerは未使用変数検出ルールPSUseDeclaredVarsMoreThanAssignmentsを持ち、変数名のタイプミスという実バグを拾える / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• Invoke-ScriptAnalyzerはInvoke-Formatterを利用します。Invoke-ScriptAnalyzerの-Fixによる自動修正のうち、整形の処理はInvoke-Formatterが担う / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• PSScriptAnalyzerはPesterより先に行うべきです。テストコードを書かずに初日から効果が出るPSScriptAnalyzerを、テストを書く作業が必要なPesterより先に導入するのが実務的だとされる / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• PSScriptAnalyzerの段階導入はPSScriptAnalyzerを前提とします。段階導入はPSScriptAnalyzerによる解析の実行を前提とする / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• PSScriptAnalyzerの段階導入は変更ファイルのみを対象にした差分解析を前提とします。段階導入の第2段階は、変更ファイルのみを厳格に解析する差分チェックを前提とする / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• 変更ファイルのみを対象にした差分解析はactions/checkoutのfetch-depth: 0を前提とします。GitHub Actionsで差分解析を行う場合、ベースブランチとの比較に履歴が必要なため、actions/checkoutでfetch-depth: 0を指定するか、ベースブランチを明示的にfetchすることを前提とする。GitHub Actions以外の実行環境や手元での差分解析には当てはまらない / 確度: 条件付きの関係 / 確認日: 2026-08-01 出典
• 変更ファイルのみを対象にした差分解析はGITHUB_BASE_REFを前提とします。GitHub Actionsで差分解析を行う場合、比較先をmainに固定せずPRのターゲットブランチを使うため、GITHUB_BASE_REFの参照を前提とする。GitHub Actions以外の実行環境ではこの変数は存在しない / 確度: 条件付きの関係 / 確認日: 2026-08-01 出典
• 変更ファイルのみを対象にした差分解析はGitHub Actionsを利用します。本記事が想定するCI環境では、変更ファイルのみの差分解析はGitHub Actionsのワークフローの中で実行される / 確度: 条件付きの関係 / 確認日: 2026-08-01 出典
• 変更ファイルのみを対象にした差分解析はInvoke-ScriptAnalyzerを利用します。差分解析は取得した変更ファイルを1つずつInvoke-ScriptAnalyzerに渡して結果を集約する / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• PSScriptAnalyzerはPSAvoidUsingConvertToSecureStringWithPlainTextを利用します。PSScriptAnalyzerは平文からSecureStringを生成する行為を検出するPSAvoidUsingConvertToSecureStringWithPlainTextを持つ / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• PSScriptAnalyzerはPSAvoidUsingUsernameAndPasswordParamsを利用します。PSScriptAnalyzerはユーザー名とパスワードを別パラメーターで受け取る設計を検出するPSAvoidUsingUsernameAndPasswordParamsを持つ / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• 重大度に関係なく落とすルールの明示リストはPSAvoidUsingPlainTextForPasswordを前提とします。重大度に関係なく落とすルール名の明示リストには、重大度Warningでも見逃せないPSAvoidUsingPlainTextForPasswordが含まれる / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• 重大度に関係なく落とすルールの明示リストはPSAvoidUsingConvertToSecureStringWithPlainTextを前提とします。重大度に関係なく落とすルール名の明示リストには、PSAvoidUsingConvertToSecureStringWithPlainTextが含まれる / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• 重大度に関係なく落とすルールの明示リストはPSAvoidUsingUsernameAndPasswordParamsを前提とします。重大度に関係なく落とすルール名の明示リストには、PSAvoidUsingUsernameAndPasswordParamsが含まれる / 確度: 確立した関係 / 確認日: 2026-08-01 出典
• GitHub Actionsは重大度に関係なく落とすルールの明示リストを利用します。本記事が組み立てるCIワークフローでは、失敗条件は重大度Errorに加え、この明示リストのルールに一致した指摘も含める / 確度: 条件付きの関係 / 確認日: 2026-08-01 出典

主要概念の定義

PSScriptAnalyzer

PowerShellスクリプトを静的解析するMicrosoft公式のツール。

GitHub Actions

GitHubが提供する、リポジトリのイベントをトリガーにワークフローを実行するCI/CDサービス。

VS CodeのPowerShell拡張機能

Visual Studio Code上でPowerShellの編集・デバッグを支援する拡張機能。PSScriptAnalyzerを内蔵し、編集中にその場で警告を表示する。

Invoke-ScriptAnalyzer

PSScriptAnalyzerのルールに基づいてスクリプトやモジュールを解析するコマンドレット。

PSScriptAnalyzerの段階導入

重大度Errorをゼロにする第1段階、変更ファイルのみを厳格に解析する第2段階、除外ルールを徐々に外す第3段階という順で既存資産へ静的解析を導入していく進め方。

変更ファイルのみを対象にした差分解析

ベースブランチとの差分を取り、変更されたps1/psm1/psd1ファイルだけをPSScriptAnalyzerの解析対象にすることで、既存の負債を残したまま新しい問題の増加だけを止める手法。

重大度に関係なく落とすルールの明示リスト

重大度がWarningでも資格情報関連など常に失敗条件へ含めたいPSScriptAnalyzerのルール名を、CIの判定コードに明示的に列挙したもの。

機械可読データ

• JSON-LD / Turtle ── この記事の知識グラフ全体
• 概念一覧 / 語彙(述語)の定義

このページはサイトの知識グラフ(_data/knowledge/)から自動生成されています。誤りの指摘はお問い合わせからお願いします。