PowerShell / PowerShell/PSScriptAnalyzer

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

未关闭
#2,047 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
C#
星标
2.2k
派生
414
平均合并
13 小时 1 分钟
30 天内合并 PR
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. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 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 摘要。