Invoke-Formatter

Modul:
PSScriptAnalyzer Module

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

Syntax

Default (Výchozí) 

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

Description

Rutina přebírá řetězcový vstup a formátuje ho podle definovaných nastavení. Pokud není zadaný žádný parametr Nastavení, rutina předpokládá výchozí nastavení formátování kódu, jak je definováno v .

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ých v hashovatelné 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átujte text vstupního skriptu pomocí nastavení definovaných v souboru '.psd1'

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

Parametry

-Range

Rozsah, ve kterém se má formátování provést. Hodnota tohoto parametru musí být matice č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í:

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

Vlastnosti parametru

Typ:

Int32[]

Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:3
Povinné:False
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-ScriptDefinition

Text skriptu, který má být formátován jako řetězec. Nejedná se o objekt ScriptBlock.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:1
Povinné:True
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Settings

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

Vlastnosti parametru

Typ:Object
Default value:CodeFormatting
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:2
Povinné:False
Hodnota z kanálu:True
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Výstupy

String

Formátovaný výsledek řetězce.