Invoke-Formatter

Référence

Module:: PSScriptAnalyzer

Met en forme un texte de script en fonction des paramètres d’entrée ou des paramètres par défaut.

Syntaxe

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

Description

L’applet Invoke-Formatter de commande prend une entrée de chaîne et la met en forme en fonction des paramètres définis. Si aucun paramètre Settings n’est fourni, l’applet de commande suppose les paramètres de mise en forme du code par défaut tels que définis dans Settings/CodeFormatting.psd1.

Exemples

EXEMPLE 1 - Mettre en forme le texte du script d’entrée à l’aide des paramètres par défaut

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

EXEMPLE 2 - Mettre en forme le script d’entrée à l’aide des paramètres définis dans une table de hachage

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

EXEMPLE 3 - Mettre en forme le texte du script d’entrée à l’aide des paramètres définis dans un fichier « .psd1 »

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

Paramètres

-Range

Plage dans laquelle la mise en forme doit avoir lieu. La valeur de ce paramètre doit être un tableau de quatre entiers. Ces nombres doivent être supérieurs à 0. Les quatre entiers représentent les quatre valeurs suivantes dans cet ordre :

numéro de ligne de départ
numéro de colonne de démarrage
numéro de ligne de fin
numéro de colonne de fin

Type:	Int32[]
Position:	3
Valeur par défaut:	None
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-ScriptDefinition

Texte du script à mettre en forme représenté sous forme de chaîne. Il ne s’agit pas d’un objet ScriptBlock .

Type:	String
Position:	1
Valeur par défaut:	None
Obligatoire:	True
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

-Settings

Table de hachage des paramètres ou chemin d’accès à un fichier de données PowerShell (.psd1) qui contient les paramètres.

Type:	Object
Position:	2
Valeur par défaut:	CodeFormatting
Obligatoire:	False
Accepter l'entrée de pipeline:	True
Accepter les caractères génériques:	False

Sorties

String

Résultat de la chaîne mise en forme.

Partager via