Invoke-Formatter

Moduł:

PSScriptAnalyzer

Formatuje tekst skryptu na podstawie ustawień wejściowych lub ustawień domyślnych.

Składnia

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

Opis

Polecenie Invoke-Formatter cmdlet pobiera dane wejściowe ciągu i formatuje je zgodnie ze zdefiniowanymi ustawieniami. Jeśli nie podano parametru Ustawienia , polecenie cmdlet przyjmuje domyślne ustawienia formatowania kodu zgodnie z definicją w pliku Settings/CodeFormatting.psd1.

Przykłady

PRZYKŁAD 1 — formatowanie tekstu skryptu wejściowego przy użyciu ustawień domyślnych

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

PRZYKŁAD 2 — Formatowanie skryptu wejściowego przy użyciu ustawień zdefiniowanych w tabeli skrótów

$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"
}

PRZYKŁAD 3 — Formatowanie tekstu skryptu wejściowego przy użyciu ustawień zdefiniowanych w pliku ".psd1"

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

Parametry

-Range

Zakres, w którym powinno nastąpić formatowanie. Wartość tego parametru musi być tablicą czterech liczb całkowitych. Te liczby muszą być większe niż 0. Cztery liczby całkowite reprezentują następujące cztery wartości w tej kolejności:

• numer wiersza początkowego
• początkowy numer kolumny
• końcowy numer wiersza
• końcowy numer kolumny

Typ:	Int32[]
Position:	3
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ScriptDefinition

Tekst skryptu, który ma być sformatowany jako ciąg. Nie jest to obiekt ScriptBlock .

Typ:	String
Position:	1
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Settings

Tabela skrótów ustawień lub ścieżka do pliku danych programu PowerShell (.psd1), który zawiera ustawienia.

Typ:	Object
Position:	2
Domyślna wartość:	CodeFormatting
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

Dane wyjściowe

String

Sformatowany wynik ciągu.