Invoke-Formatter

Moduł:
PSScriptAnalyzer Module

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

Składnia

__AllParameterSets 

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

Opis

Cmdlet przyjmuje Invoke-Formatter wpis ciągu i formatuje go zgodnie z określonymi ustawieniami. Jeśli nie podano parametru Ustawienia, cmdlet przyjmuje domyślne ustawienia formatowania kodu zdefiniowane w .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 - Formatuj tekst skryptu wejściowego z ustawieniami zdefiniowanymi 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
  • numer kolumny początkowej
  • numer wiersza końcowego
  • numer kolumny końcowej

Właściwości parametru

Typ:

Int32[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:3
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-ScriptDefinition

Tekst skryptu do sformatowania jest reprezentowany jako ciąg. To nie jest obiekt ScriptBlock .

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:1
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-Settings

Tablica hashująca ustawienia lub ścieżka do pliku danych PowerShell (.psd1), który zawiera te ustawienia.

Właściwości parametru

Typ:Object
Domyślna wartość:CodeFormatting
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:2
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

String

Parametr ScriptDefinition akceptuje ciąg znaków z potoku.

Object

Parametr Settings akceptuje wartości z potoku.

Int32

Parametr Range przyjmuje dane wejściowe z pipeline.

Dane wyjściowe

String

Sformatowany wynik ciągu.