PowerShell / PowerShell/PSScriptAnalyzer

SuppressMessageAttribute is not recognized by PSA with "using namespace" import

Open
#1,295 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Area - Engine Up-for-Grabs
Dominant language
C#
Stars
2.2k
Forks
414
Avg merge
13h 1m
Merged PRs (30d)
2

Description

Before submitting a bug report:

  • Make sure you are able to repro it on the latest released version
  • Perform a quick search for existing issues to check if this bug has already been reported

Steps to reproduce

#requires -version 6.1

using namespace Diagnostics.CodeAnalysis;

[SuppressMessage("PSAvoidUsingPlainTextForPassword", "", Justification="Azure Pipelines will obscure the password")]
[CmdletBinding()]
param(
    [Parameter(Mandatory)]
    [ValidateNotNullOrEmpty()]
    [string]$Password, # will be obfuscated by Azure Pipelines

Expected behavior

PSA should not highlight $Password as an violation.

Actual behavior

PSA highlights parameter as being in violation. Using long form [Diagnostics.CodeAnalysis.SuppressMessageAttribute(...)] works as expected.

Environment data

> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      6.2.2
PSEdition                      Core
GitCommitId                    6.2.2
OS                             Microsoft Windows 10.0.17763 
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.18.0

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Run the supplied PowerShell reproduction with PSScriptAnalyzer and compare the using-namespace attribute form with the fully qualified form. Trace how PSScriptAnalyzer resolves SuppressMessageAttribute; done when the short form suppresses PSAvoidUsingPlainTextForPassword for the Password parameter.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.