Invoke-ScriptAnalyzer

Syntax

Invoke-ScriptAnalyzer
      [-Path] <string>
      [-CustomRulePath <string[]>]
      [-RecurseCustomRulePath]
      [-IncludeDefaultRules]
      [-ExcludeRule <string[]>]
      [-IncludeRule <string[]>]
      [-Severity <string[]>]
      [-Recurse]
      [-SuppressedOnly]
      [-Fix]
      [-EnableExit]
      [-Settings <Object>]
      [-SaveDscDependency]
      [-ReportSummary]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ScriptAnalyzer
      [-Path] <string>
      -IncludeSuppressed
      [-CustomRulePath <string[]>]
      [-RecurseCustomRulePath]
      [-IncludeDefaultRules]
      [-ExcludeRule <string[]>]
      [-IncludeRule <string[]>]
      [-Severity <string[]>]
      [-Recurse]
      [-Fix]
      [-EnableExit]
      [-Settings <Object>]
      [-SaveDscDependency]
      [-ReportSummary]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ScriptAnalyzer
      [-ScriptDefinition] <string>
      -IncludeSuppressed
      [-CustomRulePath <string[]>]
      [-RecurseCustomRulePath]
      [-IncludeDefaultRules]
      [-ExcludeRule <string[]>]
      [-IncludeRule <string[]>]
      [-Severity <string[]>]
      [-Recurse]
      [-EnableExit]
      [-Settings <Object>]
      [-SaveDscDependency]
      [-ReportSummary]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-ScriptAnalyzer
      [-ScriptDefinition] <string>
      [-CustomRulePath <string[]>]
      [-RecurseCustomRulePath]
      [-IncludeDefaultRules]
      [-ExcludeRule <string[]>]
      [-IncludeRule <string[]>]
      [-Severity <string[]>]
      [-Recurse]
      [-SuppressedOnly]
      [-EnableExit]
      [-Settings <Object>]
      [-SaveDscDependency]
      [-ReportSummary]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Beschreibung

Invoke-ScriptAnalyzer wertet Skripts oder Moduldateien (.ps1, .psm1, und .psd1 Dateien) basierend auf einer Auflistung bewährter Methoden aus und gibt Objekte zurück, die Regelverletzungen darstellen. Es enthält auch spezielle Regeln zum Analysieren von DSC-Ressourcen.

Invoke-ScriptAnalyzer enthält eine Reihe von integrierten Regeln. Standardmäßig werden alle Regeln verwendet. Sie können die Parameter IncludeRule und ExcludeRule verwenden, um die gewünschten Regeln auszuwählen. Sie können das Get-ScriptAnalyzerRule Cmdlet verwenden, um die Regeln zu untersuchen und auszuwählen, die Sie einschließen oder aus der Auswertung ausschließen möchten.

Sie können auch benutzerdefinierte Regeln verwenden, die Sie in PowerShell-Skripts schreiben, oder in Assemblys mit C# kompilieren. Benutzerdefinierte Regeln können auch mit den Parametern IncludeRule und ExcludeRule ausgewählt werden.

Sie können auch eine Regel in die Analyse einschließen, aber die Ausgabe dieser Regel für ausgewählte Funktionen oder Skripts unterdrücken. Dieses Feature sollte nur bei Bedarf verwendet werden. Um unterdrückte Regeln abzurufen, führen Sie mit dem Parameter SuppressedOnly ausInvoke-ScriptAnalyzer.

Für die Verwendung in CI-Systemen beendet EnableExit die Shell mit einem Exitcode, der der Anzahl der Fehlerdatensätze entspricht.

Beispiele

BEISPIEL 1: Ausführen aller Script Analyzer-Regeln für ein Skript

Invoke-ScriptAnalyzer -Path C:\Scripts\Get-LogData.ps1

BEISPIEL 2: Ausführen aller Script Analyzer-Regeln für alle Dateien im Verzeichnis Modules

In diesem Beispiel werden alle Script Analyzer-Regeln für alle .ps1 und .psm1 Dateien in Ihrem benutzerbasierten Modules Verzeichnis und den zugehörigen Unterverzeichnissen ausgeführt.

Invoke-ScriptAnalyzer -Path $home\Documents\WindowsPowerShell\Modules -Recurse

BEISPIEL 3: Ausführen einer einzelnen Regel für ein Modul

In diesem Beispiel wird nur die PSAvoidUsingPositionalParameters-Regel für die Dateien im PSDiagnostics Modulordner ausgeführt. Sie können einen Befehl wie diesen verwenden, um alle Instanzen einer bestimmten Regelverletzung zu finden.

Invoke-ScriptAnalyzer -Path C:\Windows\System32\WindowsPowerShell\v1.0\Modules\PSDiagnostics -IncludeRule PSAvoidUsingPositionalParameters

BEISPIEL 4: Ausführen aller Regeln mit Ausnahme von zwei in Ihren Modulen

In diesem Beispiel werden alle Regeln mit Ausnahme von PSAvoidUsingCmdletAliases und PSAvoidUsingInternalURLs für die .ps1 Dateien und .psm1 im Verzeichnis und in den MyModules zugehörigen Unterverzeichnissen ausgeführt.

Invoke-ScriptAnalyzer -Path C:\ps-test\MyModule -Recurse -ExcludeRule PSAvoidUsingCmdletAliases, PSAvoidUsingInternalURLs

BEISPIEL 5: Ausführen von Script Analyzer mit benutzerdefinierten Regeln

In diesem Beispiel wird Script Analyzer Test-Script.ps1 mit den Standardregeln und -regeln im C:\CommunityAnalyzerRules Pfad ausgeführt.

Invoke-ScriptAnalyzer -Path D:\test_scripts\Test-Script.ps1 -CustomRulePath C:\CommunityAnalyzerRules -IncludeDefaultRules

BEISPIEL 6: Führen Sie nur die Regeln aus, die den Fehlerschweregrad aufweisen und den PSDSC-Quellnamen haben.

$DSCError = Get-ScriptAnalyzerRule -Severity Error | Where SourceName -eq PSDSC
$Path = "$home\Documents\WindowsPowerShell\Modules\MyDSCModule"
Invoke-ScriptAnalyzerRule -Path $Path -IncludeRule $DSCError -Recurse

BEISPIEL 7: Unterdrücken von Regelverstößen

In diesem Beispiel wird gezeigt, wie die Meldung von Regelverstößen in einer Funktion unterdrückt wird und wie Regelverstöße ermittelt werden, die unterdrückt werden.

Im Beispiel wird das SuppressMessageAttribute -Attribut verwendet, um die Regeln PSUseSingularNouns und PSAvoidUsingCmdletAliases für die Get-Widgets Funktion im Get-Widgets.ps1 Skript zu unterdrücken. Sie können dieses Attribut verwenden, um eine Regel für ein Modul, ein Skript, eine Klasse, eine Funktion, einen Parameter oder eine Zeile zu unterdrücken.

Mit dem ersten Befehl wird Script Analyzer für die Skriptdatei ausgeführt, die die Funktion enthält. Die Ausgabe meldet einen Regelverstoß. Obwohl mehr Regeln verletzt werden, wird keine unterdrückte Regel gemeldet.

function Get-Widgets
{
    [CmdletBinding()]
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseSingularNouns", "")]
    [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingCmdletAliases", "", Justification="Resolution in progress.")]
    Param()

    dir $pshome
    ...
}

Invoke-ScriptAnalyzer -Path .\Get-Widgets.ps1

RuleName                            Severity     FileName   Line  Message
--------                            --------     --------   ----  -------
PSProvideCommentHelp                Information  ManageProf 14    The cmdlet 'Get-Widget' does not have a help comment.
                                                 iles.psm1

Invoke-ScriptAnalyzer -Path .\Get-Widgets.ps1 -SuppressedOnly

Rule Name                           Severity     File Name  Line  Justification
---------                           --------     ---------  ----  -------------
PSAvoidUsingCmdletAliases           Warning      ManageProf 21    Resolution in progress.
                                                 iles.psm1
PSUseSingularNouns                  Warning      ManageProf 14
                                                 iles.psm1

Der zweite Befehl verwendet den SuppressedOnly-Parameter , um Verstöße gegen die Regeln zu melden, die unterdrückte Skriptdatei sind.

BEISPIEL 8: Analysieren von Skriptdateien mithilfe einer Profildefinition

In diesem Beispiel erstellen wir ein Script Analyzer-Profil und speichern es in der ScriptAnalyzerProfile.txt Datei im aktuellen Verzeichnis. Wir werden für die BitLocker-Moduldateien ausgeführtInvoke-ScriptAnalyzer. Der Wert des Profilparameters ist der Pfad zum Script Analyzer-Profil.

# In .\ScriptAnalyzerProfile.txt
@{
    Severity = @('Error', 'Warning')
    IncludeRules = 'PSAvoid*'
    ExcludeRules = '*WriteHost'
}

Invoke-ScriptAnalyzer -Path $pshome\Modules\BitLocker -Profile .\ScriptAnalyzerProfile.txt

Wenn Sie einen in Konflikt stehenden Parameter in den Invoke-ScriptAnalyzer Befehl einschließen, z. B -Severity Error. , verwendet das Cmdlet den Profilwert und ignoriert den Parameter.

BEISPIEL 9: Analysieren eines als Zeichenfolge gespeicherten Skripts

In diesem Beispiel wird der ScriptDefinition-Parameter verwendet, um eine Funktion an der Befehlszeile zu analysieren. Die Funktionszeichenfolge ist in Anführungszeichen eingeschlossen.

Invoke-ScriptAnalyzer -ScriptDefinition "function Get-Widgets {Write-Host 'Hello'}"

RuleName                            Severity     FileName   Line  Message
--------                            --------     --------   ----  -------
PSAvoidUsingWriteHost               Warning                 1     Script
                                                                  because
                                                                  there i
                                                                  suppres
                                                                  Write-O
PSUseSingularNouns                  Warning                 1     The cmd
                                                                  noun sh

Wenn Sie den Parameter ScriptDefinition verwenden, ist $nulldie FileName-Eigenschaft des DiagnosticRecord-Objekts .

Parameter

-Confirm

-CustomRulePath

-EnableExit

-ExcludeRule

-Fix

-IncludeDefaultRules

-IncludeRule

-IncludeSuppressed

-Path

-Recurse

-RecurseCustomRulePath

-ReportSummary

-SaveDscDependency

-ScriptDefinition

-Settings

-Severity

-SuppressedOnly

-WhatIf

Eingaben

None

Eingaben können nicht an dieses Cmdlet weitergereicht werden.

Ausgaben

Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord

Gibt standardmäßig Invoke-ScriptAnalyzer ein DiagnosticRecord-Objekt für jede Regelverletzung zurück.

Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.SuppressedRecord

Wenn Sie den Parameter SuppressedOnly verwenden, Invoke-ScriptAnalyzer gibt stattdessen ein SuppressedRecord-Objekt zurück.

Ähnliche Themen

• Get-ScriptAnalyzerRule
• PSScriptAnalyzer auf GitHub