Invoke-Formatter

Modul:
PSScriptAnalyzer Module

Szkriptszöveg formázása a bemeneti beállítások vagy az alapértelmezett beállítások alapján.

Szintaxis

Default (Alapértelmezett) 

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

Leírás

A parancsmag sztringbemenetet használ, és a megadott beállításoknak megfelelően formázza. Ha nincs megadva Beállítások paraméter, a parancsmag a definiált alapértelmezett kódformázási beállításokat feltételezi.

Példák

1. PÉLDA – A bemeneti szkript szövegének formázása az alapértelmezett beállításokkal

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

2. PÉLDA – A bemeneti szkript formázása a kivonatolóban meghatározott beállításokkal

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

3. PÉLDA - Formázza a bemeneti szkript szövegét a '.psd1' fájlban meghatározott beállítások segítségével

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

Paraméterek

-Range

Az a tartomány, amelyen belül a formázást el kell helyezni. A paraméter értékének négy egész számból álló tömbnek kell lennie. Ezeknek a számoknak 0-nál nagyobbnak kell lenniük. A négy egész szám a következő négy értéket jelöli ebben a sorrendben:

  • kezdősor száma
  • kezdő oszlop száma
  • zárósor száma
  • záró oszlop száma

Paramétertulajdonságok

Típus:

Int32[]

Alapértelmezett érték:None
Támogató vadkártyák:False
Don't Show:False

Paraméterhalmazok

(All)
Pozíció:3
Kötelező:False
Érték a csővezetékből:True
Érték a csővezetékből az ingatlan név szerint:True
Érték a maradék argumentumokból:False

-ScriptDefinition

A formázandó szkript szövege sztringként jelenik meg. Ez nem ScriptBlock objektum.

Paramétertulajdonságok

Típus:String
Alapértelmezett érték:None
Támogató vadkártyák:False
Don't Show:False

Paraméterhalmazok

(All)
Pozíció:1
Kötelező:True
Érték a csővezetékből:True
Érték a csővezetékből az ingatlan név szerint:True
Érték a maradék argumentumokból:False

-Settings

A beállításokat tartalmazó PowerShell-adatfájl () elérési útja.

Paramétertulajdonságok

Típus:Object
Alapértelmezett érték:CodeFormatting
Támogató vadkártyák:False
Don't Show:False

Paraméterhalmazok

(All)
Pozíció:2
Kötelező:False
Érték a csővezetékből:True
Érték a csővezetékből az ingatlan név szerint:True
Érték a maradék argumentumokból:False

CommonParameters

Ez a parancsmag a következő gyakori paramétereket támogatja: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction és -WarningVariable. További információért lásd about_CommonParameters.

Kimenetek

String

A formázott sztring eredménye.