PowerShell / PowerShell/PSScriptAnalyzer

Suppression with `SuppressMessageAttribute` is completely broken for variables

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

还没有人认领这个 Issue。

主要语言
C#
星标
2.2k
派生
414
平均合并
13 小时 1 分钟
30 天内合并 PR
2

描述

Steps to reproduce

Consider this code:

$foo = "never used" # Should generate PSUseDeclaredVarsMoreThanAssignments

$global:var1 = $null # Should generate PSAvoidGlobalVars

Now let's try to add these suppressions:

[Diagnostics.CodeAnalysis.SuppressMessage('NonexistentRule', '')]
$foo = "never used" # Should still generate PSUseDeclaredVarsMoreThanAssignments

[Diagnostics.CodeAnalysis.SuppressMessage('PSAvoidGlobalVars', '')]
$global:var1 = $null # Should NOT generate PSAvoidGlobalVars

Expected behavior

I should still see the PSUseDeclaredVarsMoreThanAssignments warning, but not the PSAvoidGlobalVars one.

Actual behavior

The opposite happens, the first message is suppressed, but the second is not:

RuleName                             Severity     ScriptName Line  Message
--------                             --------     ---------- ----  -------
PSAvoidGlobalVars                    Warning      Test.ps1      5     Found global variable 'global:var1'.

Environment data

> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      7.4.5
PSEdition                      Core
GitCommitId                    7.4.5
OS                             Microsoft Windows 10.0.22631
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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先,针对 PSScriptAnalyzer 1.23.0 运行 PowerShell 复现,并跟踪 SuppressMessageAttribute 如何处理变量。比较 NonexistentRule 和 PSAvoidGlobalVars 的规则名称匹配;完成的标准是,不存在的规则不会抑制 PSUseDeclaredVarsMoreThanAssignments,而有效规则会抑制 PSAvoidGlobalVars。

由索引模型根据 Issue 内容生成。

评估

技术栈
csharp, powershell
领域
tooling
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
描述清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。