Invoke-Formatter

Modul:
PSScriptAnalyzer Module

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

Syntax

__AllParameterSets 

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 finns antar cmdleten standardkodformateringsinställningarna enligt definierade i Settings/CodeFormatting.psd1.

Exempel

EXEMPEL 1 – Formatera indataskripttexten med standardinställningarna

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

EXEMPEL 2 – Formatera indataskriptet med de inställningar som definierats i en hashtable

$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 inställningarna som definieras i en '.psd1'-fil

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

Parametrar

-Range

Det intervall inom vilket formateringen 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

Parameteregenskaper

Typ:

Int32[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:3
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-ScriptDefinition

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

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:1
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

-Settings

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

Parameteregenskaper

Typ:Object
Standardvärde:CodeFormatting
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:2
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

String

ScriptDefinition-parametern accepterar en sträng från pipelinen.

Object

Inställningsparametern accepterar värden från pipelinen.

Int32

Range-parametern tar emot indata från pipelinen.

Utdata

String

Det formaterade strängresultatet.