Invoke-Formatter

Riferimento

Modulo:: PSScriptAnalyzer

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

Sintassi

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

Descrizione

Il Invoke-Formatter cmdlet accetta un input stringa e lo formatta in base alle impostazioni definite. Se non viene specificato alcun parametro Settings , il cmdlet presuppone che le impostazioni di formattazione del codice predefinite siano 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 un file '.psd1'

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

Parametri

-Range

Intervallo all'interno del 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

Tipo:	Int32[]
Posizione:	3
Valore predefinito:	None
Necessario:	False
Accettare l'input della pipeline:	True
Accettare caratteri jolly:	False

-ScriptDefinition

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

Tipo:	String
Posizione:	1
Valore predefinito:	None
Necessario:	True
Accettare l'input della pipeline:	True
Accettare caratteri jolly:	False

-Settings

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

Tipo:	Object
Posizione:	2
Valore predefinito:	CodeFormatting
Necessario:	False
Accettare l'input della pipeline:	True
Accettare caratteri jolly:	False

Output

String

Risultato stringa formattata.

Condividi tramite