PowerShell / PowerShell/PSScriptAnalyzer

Suppression with `SuppressMessageAttribute` is completely broken for variables

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

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

主要言語
C#
スター
2.2k
フォーク
414
平均マージ
13時間 1分
マージ済み PR(30日)
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. リポジトリをフォークし、ブランチを切って変更します。
  4. 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 を短くまとめたダイジェスト。