PowerShell

Language-specific information about the way that SonarQube Cloud supports the analysis of PowerShell.

Analysis Overview

The PowerShell analyzer is designed to perform static code analysis on PowerShell source code and scripts.

Language-specific properties

You can discover and update the PowerShell-specific properties in Your project > Administration > General Settings > Languages > PowerShell. See Configuration overview for more information about setting properties.

In-line suppression of issues

Adding the #NOSONAR comment at the end of the line will suppress all issues on that line.

SuppressMessage attribute

Use Diagnostics.CodeAnalysis.SuppressMessageAttribute to suppress a specific rule for a script, function, or parameter. The first argument is the rule key and the second argument should be an empty string.

function Invoke-Example {
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute('SXXXX', '', Justification = 'Because ...')]
    param()

    # ...
}

Rather than relying on this method, we suggest refining your analysis scope to avoid creating major gaps in your code review. Because the NOSONAR comment silences all current and future issues on a line without regard for their severity, it is an imprecise tool. Even if you only intend to hide a minor stylistic point, you could unintentionally obscure a serious security flaw.

Related Pages

• Analysis parameters

• Analysis scope