Invoke-Formatter

Modul:
PSScriptAnalyzer Module

Formatiert einen Skripttext basierend auf den Eingabeeinstellungen oder Standardeinstellungen.

Syntax

__AllParameterSets 

Invoke-Formatter
    [-ScriptDefinition] <string>
    [[-Settings] <Object>]
    [[-Range] <int[]>]
    [<CommonParameters>]

Beschreibung

Das Invoke-Formatter Cmdlet nimmt eine Zeichenkette und formatiert sie entsprechend definierten Einstellungen. Wenn kein Einstellungsparameter angegeben ist, nimmt das Cmdlet die Standard-Code-Formatierungseinstellungen an, wie sie in definiert sind Settings/CodeFormatting.psd1.

Beispiele

BEISPIEL 1: Formatieren des Eingabeskripttexts mithilfe der Standardeinstellungen

$scriptDefinition = @'
function foo {
"hello"
  }
'@

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

BEISPIEL 2: Formatieren des Eingabeskripts mithilfe der in einer Hashtabelle definierten Einstellungen

$scriptDefinition = @'
function foo {
"hello"
}
'@

$settings = @{
    IncludeRules = @("PSPlaceOpenBrace", "PSUseConsistentIndentation")
    Rules = @{
        PSPlaceOpenBrace = @{
            Enable = $true
            OnSameLine = $false
        }
        PSUseConsistentIndentation = @{
            Enable = $true
        }
    }
}

Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings

function foo
{
    "hello"
}

BEISPIEL 3 – Formatiere den Eingabeskripttext mit den Einstellungen, die in einer '.psd1'-Datei definiert sind.

Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings /path/to/settings.psd1

Parameter

-Range

Der Bereich, in dem die Formatierung erfolgen soll. Der Wert dieses Parameters muss ein Array mit vier ganzen Zahlen sein. Diese Zahlen müssen größer als 0 sein. Die vier ganzzahligen Zahlen stellen die folgenden vier Werte in dieser Reihenfolge dar:

  • Anfangszeilennummer
  • Startspaltenummer
  • Endzeilennummer
  • Endspaltenummer

Parametereigenschaften

Typ:

Int32[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:3
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-ScriptDefinition

Der Text des Skripts, das als Zeichenfolge formatiert werden soll. Dies ist kein ScriptBlock-Objekt .

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:1
Obligatorisch.:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-Settings

Eine Einstellungs-Hashtabelle oder ein Pfad zu einer PowerShell-Datendatei (.psd1), der die Einstellungen enthält.

Parametereigenschaften

Typ:Object
Standardwert:CodeFormatting
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:2
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

String

Der ScriptDefinition-Parameter akzeptiert einen String aus der Pipeline.

Object

Der Einstellungsparameter akzeptiert Werte aus der Pipeline.

Int32

Der Range-Parameter akzeptiert Eingaben aus der Pipeline.

Ausgaben

String

Das formatierte Zeichenfolgenergebnis.