Invoke-Formatter

Referência

Módulo:: PSScriptAnalyzer

Formata um texto de script com base nas definições de entrada ou predefinições.

Sintaxe

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

Description

O Invoke-Formatter cmdlet utiliza uma entrada de cadeia e formata-a de acordo com as definições definidas. Se não for fornecido nenhum parâmetro definições , o cmdlet assume as predefinições de formatação de código, conforme definido em Settings/CodeFormatting.psd1.

Exemplos

EXEMPLO 1 - Formatar o texto do script de entrada com as predefinições

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

EXEMPLO 2 - Formatar o script de entrada com as definições definidas numa tabela 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"
}

EXEMPLO 3 - Formatar o texto do script de entrada com as definições definidas como um ficheiro ".psd1"

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

Parâmetros

-Range

O intervalo dentro do qual deve ocorrer a formatação. O valor deste parâmetro tem de ser uma matriz de quatro números inteiros. Estes números têm de ser superiores a 0. Os quatro números inteiros representam os quatro valores seguintes nesta ordem:

número de linha inicial
número da coluna inicial
número de linha final
número da coluna final

Tipo:	Int32[]
Position:	3
Default value:	None
Necessário:	False
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-ScriptDefinition

O texto do script a ser formatado representado como uma cadeia. Este não é um objeto ScriptBlock .

Tipo:	String
Position:	1
Default value:	None
Necessário:	True
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

-Settings

Uma tabela hash de definições ou um caminho para um ficheiro de dados do PowerShell (.psd1) que contém as definições.

Tipo:	Object
Position:	2
Default value:	CodeFormatting
Necessário:	False
Aceitar entrada de pipeline:	True
Aceitar carateres universais:	False

Saídas

String

O resultado da cadeia formatada.

Partilhar via