Invoke-Formatter

Module:

PSScriptAnalyzer

Hiermee wordt een scripttekst opgemaakt op basis van de invoerinstellingen of standaardinstellingen.

Syntax

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

Description

De Invoke-Formatter cmdlet gebruikt een tekenreeksinvoer en maakt deze op basis van de gedefinieerde instellingen. Als er geen parameter Instellingen is opgegeven, gaat de cmdlet uit van de standaardinstellingen voor codeopmaak zoals gedefinieerd in Settings/CodeFormatting.psd1.

Voorbeelden

VOORBEELD 1: de tekst van het invoerscript opmaken met behulp van de standaardinstellingen

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

VOORBEELD 2: het invoerscript opmaken met behulp van de instellingen die zijn gedefinieerd in een hashtabel

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

VOORBEELD 3- De tekst van het invoerscript opmaken met behulp van de instellingen die zijn gedefinieerd als een .psd1-bestand

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

Parameters

-Range

Het bereik waarin de opmaak moet plaatsvinden. De waarde van deze parameter moet een matrix van vier gehele getallen zijn. Deze getallen moeten groter zijn dan 0. De vier gehele getallen vertegenwoordigen de volgende vier waarden in deze volgorde:

• beginregelnummer
• beginkolomnummer
• eindregelnummer
• eindkolomnummer

Type:	Int32[]
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ScriptDefinition

De tekst van het script dat moet worden opgemaakt, weergegeven als een tekenreeks. Dit is geen ScriptBlock-object .

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Settings

Een instellingenhashtabel of een pad naar een PowerShell-gegevensbestand (.psd1) dat de instellingen bevat.

Type:	Object
Position:	2
Default value:	CodeFormatting
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

Uitvoerwaarden

String

Het opgemaakte tekenreeksresultaat.