Invoke-Formatter

Referência

Módulo:: PSScriptAnalyzer

Formata um texto de script com base nas configurações de entrada ou nas configurações padrão.

Sintaxe

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

Description

O Invoke-Formatter cmdlet usa uma entrada de cadeia de caracteres e a formata de acordo com as configurações definidas. Se nenhum parâmetro Settings for fornecido, o cmdlet assumirá as configurações de formatação de código padrão, conforme definido em Settings/CodeFormatting.psd1.

Exemplos

EXEMPLO 1 – Formatar o texto do script de entrada usando as configurações padrão

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

EXEMPLO 2 – Formatar o script de entrada usando as configurações definidas em uma tabela de 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 usando as configurações definidas em um arquivo '.psd1'

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

Parâmetros

-Range

O intervalo no qual a formatação deve ocorrer. O valor desse parâmetro deve ser uma matriz de quatro inteiros. Esses números devem ser maiores que 0. Os quatro inteiros representam os quatro valores a seguir nesta ordem:

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

Tipo:	Int32[]
Cargo:	3
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-ScriptDefinition

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

Tipo:	String
Cargo:	1
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-Settings

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

Tipo:	Object
Cargo:	2
Valor padrão:	CodeFormatting
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

Saídas

String

O resultado da cadeia de caracteres formatada.

Compartilhar via