PowerShell / PowerShell/PSScriptAnalyzer

Suppression with `SuppressMessageAttribute` is completely broken for variables

Aberta
#2,040 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
C#
Estrelas
2.2k
Forks
415
Merge médio
13h 1min
PRs com merge (30d)
2

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece executando a reprodução em PowerShell com o PSScriptAnalyzer 1.23.0 e rastreie como SuppressMessageAttribute é tratado para variáveis. Compare a correspondência de nomes de regra para NonexistentRule e PSAvoidGlobalVars; considera-se concluído quando a regra inexistente não suprime PSUseDeclaredVarsMoreThanAssignments, enquanto a regra válida suprime PSAvoidGlobalVars.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
csharp, powershell
Domínio
tooling
Tipo de issue
Bug
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.