Partager via

Invoke-Formatter

Module:
PSScriptAnalyzer Module

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

Syntaxe

Default (Par défaut) 

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

Description

L’applet de commande Invoke-Formatter prend une entrée de chaîne et la met en forme en fonction des paramètres définis. Si aucun paramètre Paramètres n’est fourni, l’applet de commande suppose que les paramètres de mise en forme du code par défaut sont 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épart
  • numéro de ligne de fin
  • numéro de colonne de fin

Propriétés du paramètre

Type:

Int32[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:3
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-ScriptDefinition

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

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:1
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants: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.

Propriétés du paramètre

Type:Object
Valeur par défaut:CodeFormatting
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:2
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Sorties

String

Résultat de chaîne mis en forme.