Invoke-Formatter

Reference

Modul:: PSScriptAnalyzer

Formátuje text skriptu na základě nastavení vstupu nebo výchozího nastavení.

Syntaxe

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

Description

Rutina Invoke-Formatter přebírá řetězcový vstup a formátuje ho podle definovaného nastavení. Pokud není zadaný žádný parametr Nastavení , rutina předpokládá výchozí nastavení formátování kódu definované v Settings/CodeFormatting.psd1.

Příklady

PŘÍKLAD 1 – Formátování textu vstupního skriptu pomocí výchozího nastavení

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

PŘÍKLAD 2 – Formátování vstupního skriptu pomocí nastavení definovaného v zatřiďovací tabulce

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

PŘÍKLAD 3 – Formátování textu vstupního skriptu pomocí nastavení definovaného v souboru .psd1

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

Parametry

-Range

Rozsah, ve kterém se má formátování provádět. Hodnota tohoto parametru musí být pole čtyř celých čísel. Tato čísla musí být větší než 0. Čtyři celá čísla představují následující čtyři hodnoty v tomto pořadí:

číslo počátečního řádku
počáteční číslo sloupce
číslo koncového řádku
číslo koncového sloupce

Typ:	Int32[]
Position:	3
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-ScriptDefinition

Text skriptu, který se má formátovat, je reprezentovaný jako řetězec. Toto není objekt ScriptBlock .

Typ:	String
Position:	1
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-Settings

Zatřiďovací tabulka nastavení nebo cesta k datovému souboru PowerShellu (.psd1), který obsahuje nastavení.

Typ:	Object
Position:	2
Default value:	CodeFormatting
Vyžadováno:	False
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

Výstupy

String

Výsledek formátovaného řetězce

Sdílet prostřednictvím