Invoke-Formatter

Referens

Modul:: PSScriptAnalyzer

Formaterar en skripttext baserat på indatainställningarna eller standardinställningarna.

Syntax

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

Description

Cmdleten Invoke-Formatter tar en stränginmatning och formaterar den enligt definierade inställningar. Om ingen inställningsparameter anges förutsätter cmdleten standardinställningarna för kodformatering enligt definitionen i Settings/CodeFormatting.psd1.

Exempel

EXEMPEL 1 – Formatera indataskriptets text med standardinställningarna

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

EXEMPEL 2 – Formatera indataskriptet med hjälp av inställningarna som definierats i en hash-tabell

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

EXEMPEL 3 – Formatera indataskriptets text med hjälp av inställningarna som definierats som en .psd1-fil

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

Parametrar

-Range

Det intervall inom vilket formatering ska ske. Värdet för den här parametern måste vara en matris med fyra heltal. Dessa tal måste vara större än 0. De fyra heltalen representerar följande fyra värden i den här ordningen:

startradsnummer
startkolumnnummer
slutlinjenummer
slutkolumnnummer

Typ:	Int32[]
Position:	3
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-ScriptDefinition

Texten i skriptet som ska formateras representeras som en sträng. Det här är inte ett ScriptBlock-objekt .

Typ:	String
Position:	1
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-Settings

En hashtabell för inställningar eller en sökväg till en PowerShell-datafil (.psd1) som innehåller inställningarna.

Typ:	Object
Position:	2
Standardvärde:	CodeFormatting
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

Utdata

String

Det formaterade strängresultatet.

Dela via