PowerShell / PowerShell/PSScriptAnalyzer

Unable to run rules with hashtable that run fine with settings file

オープン
#2,047 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
C#
スター
2.2k
フォーク
414
平均マージ
13時間 1分
マージ済み PR(30日)
2

説明

Steps to reproduce

This is essentially the opposite of #1160

The attached zip file concisely contains the repro:

PSScriptAnalyzerSettingsHashtableRepro.zip

But here it is in plain text too

# repro.ps1

Write-Output "Using settings file"

Invoke-ScriptAnalyzer -Path .\repro.ps1 -Settings '.\PSScriptAnalyzerSettings.psd1'

# Create an unused variable which triggers a warning that the settings file should suppress
$unusedVariable = 1

$settings = Import-PowerShellDataFile -Path '.\PSScriptAnalyzerSettings.psd1'

Write-Output "Loaded settings to hashtable:"

$settings | ConvertTo-Json | Write-Output

Write-Output "Using setting hashtable"

Invoke-ScriptAnalyzer -Path .\repro.ps1 -Settings $settings
# PSScriptAnalyzerSettings.psd1

@{
    ExcludeRules = @(
        'PSUseDeclaredVarsMoreThanAssignments'
    )
}

Expected behavior

The warning should be suppressed in both calls to Invoke-ScriptAnalyzer. Output from the repro script should be this:

Using settings file
Loaded settings to hashtable:
{
    "ExcludeRules":  [
                         "PSUseDeclaredVarsMoreThanAssignments"
                     ]
}
Using setting hashtable

Actual behavior

The warning is only suppressed in the first call (the one that references the file directly). The call that passes the settings hashtable does not suppress the error. Output from the repro script is this:

Using settings file
Loaded settings to hashtable:
{
  "ExcludeRules": [
    "PSUseDeclaredVarsMoreThanAssignments"
  ]
}
Using setting hashtable

RuleName                            Severity     ScriptName Line  Message
--------                            --------     ---------- ----  -------
PSUseDeclaredVarsMoreThanAssignment Warning      repro.ps1  6     The variable 'unusedVariable' is assigned but never
s                                                                 used.

Environment data

> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      7.4.6
PSEdition                      Core
GitCommitId                    7.4.6
OS                             Microsoft Windows 10.0.26100
Platform                       Win32NT
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.23.0

Note that this issue does NOT happen in this environment (i.e. the warning is suppressed in both calls):

> $PSVersionTable
Name                           Value
----                           -----
PSVersion                      5.1.26100.2161
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.26100.2161
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

> (Get-Module -ListAvailable PSScriptAnalyzer).
Version | ForEach-Object { $_.ToString() }
1.23.0

It appears to be related to the Powershell version.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、報告されている PowerShell 7.4.6 および 5.1 環境で PSScriptAnalyzerSettings.psd1 を使用して repro.ps1 を実行し、次に Invoke-ScriptAnalyzer がファイル パスとインポートされた settings hashtable をどのように扱うかを追跡します。完了条件は、両方の呼び出しで ExcludeRules エントリが PSUseDeclaredVarsMoreThanAssignments を抑制し、PowerShell の異なる動作に対する回帰テストのカバレッジがあることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
powershell
領域
tooling
issue の種類
バグ
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。