Invoke-Formatter

Modulo:

PSScriptAnalyzer Module

Formatta un testo script in base alle impostazioni di input o alle impostazioni predefinite.

Sintassi

Default (impostazione predefinita).

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

Descrizione

Il cmdlet Invoke-Formatter accetta un input stringa e lo formatta in base alle impostazioni definite. Se non viene specificato alcun parametro Settings, il cmdlet presuppone le impostazioni di formattazione del codice predefinite definite in Settings/CodeFormatting.psd1.

Esempio

ESEMPIO 1 - Formattare il testo dello script di input usando le impostazioni predefinite

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

ESEMPIO 2 - Formattare lo script di input usando le impostazioni definite in una tabella hash

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

ESEMPIO 3 - Formattare il testo dello script di input usando le impostazioni definite da un file '.psd1'

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

Parametri

-Range

Intervallo entro il quale deve essere eseguita la formattazione. Il valore di questo parametro deve essere una matrice di quattro interi. Questi numeri devono essere maggiori di 0. I quattro interi rappresentano i quattro valori seguenti in questo ordine:

• numero di riga iniziale
• numero di colonna iniziale
• numero di riga finale
• numero di colonna finale

Proprietà dei parametri

Tipo:	Int32[]
Valore predefinito:	None
Supporta i caratteri jolly:	False
DontShow:	False

Set di parametri

(All)

Posizione:	3
Obbligatorio:	False
Valore dalla pipeline:	True
Valore dalla pipeline in base al nome della proprietà:	True
Valore dagli argomenti rimanenti:	False

-ScriptDefinition

Testo dello script da formattare come stringa. Non si tratta di un oggetto scriptBlock .

Proprietà dei parametri

Tipo:	String
Valore predefinito:	None
Supporta i caratteri jolly:	False
DontShow:	False

Set di parametri

(All)

Posizione:	1
Obbligatorio:	True
Valore dalla pipeline:	True
Valore dalla pipeline in base al nome della proprietà:	True
Valore dagli argomenti rimanenti:	False

-Settings

Tabella hash delle impostazioni o percorso di un file di dati di PowerShell (.psd1) che contiene le impostazioni.

Proprietà dei parametri

Tipo:	Object
Valore predefinito:	CodeFormatting
Supporta i caratteri jolly:	False
DontShow:	False

Set di parametri

(All)

Posizione:	2
Obbligatorio:	False
Valore dalla pipeline:	True
Valore dalla pipeline in base al nome della proprietà:	True
Valore dagli argomenti rimanenti:	False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Output

String

Risultato della stringa formattata.