Compartir a través de

Invoke-Formatter

Módulo:
PSScriptAnalyzer Module

Da formato a un texto de script basado en la configuración de entrada o la configuración predeterminada.

Sintaxis

Default (valor predeterminado) 

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

Description

El cmdlet toma una entrada de cadena y la formatea según configuraciones definidas. Si no se proporciona ningún parámetro Settings , el cmdlet asume los ajustes de formato de código por defecto definidos en .

Ejemplos

EJEMPLO 1 - Formatear el texto del script de entrada usando los ajustes por defecto

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

EJEMPLO 2 - Formatear el script de entrada usando los ajustes definidos en una tabla 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"
}

EJEMPLO 3 - Formatear el texto del script de entrada usando los ajustes definidos en un archivo '.psd1'

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

Parámetros

-Range

El rango dentro del cual debe aplicarse el formato. El valor de este parámetro debe ser un array de cuatro enteros. Estos números deben ser mayores que 0. Los cuatro enteros representan los siguientes cuatro valores en este orden:

  • Número de línea de salida
  • Número de columna inicial
  • Número de línea final
  • Número de columna final

Propiedades de parámetro

Tipo:

Int32[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:3
Obligatorio:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-ScriptDefinition

El texto del guion a formatearse representado como una cadena. Esto no es un objeto ScriptBlock .

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:1
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Settings

Una tabla hash de configuración o una ruta hacia un archivo de datos PowerShell () que contiene los ajustes.

Propiedades de parámetro

Tipo:Object
Valor predeterminado:CodeFormatting
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:2
Obligatorio:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Salidas

String

El resultado de la cadena formateada.