다음을 통해 공유

Invoke-Formatter

모듈:
PSScriptAnalyzer Module

Formats a script text based on the input settings or default settings.

구문

Default (기본값) 

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

Description

The Invoke-Formatter cmdlet takes a string input and formats it according to defined settings. If no Settings parameter is provided, the cmdlet assumes the default code formatting settings as defined in Settings/CodeFormatting.psd1.

예제

EXAMPLE 1 - Format the input script text using the default settings

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

Invoke-Formatter -ScriptDefinition $scriptDefinition

function foo {
    "hello"
}

EXAMPLE 2 - Format the input script using the settings defined in a hashtable

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

EXAMPLE 3 - Format the input script text using the settings defined a `.psd1` file

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

매개 변수

-Range

The range within which formatting should take place. The value of this parameter must be an array of four integers. These numbers must be greater than 0. The four integers represent the following four values in this order:

  • starting line number
  • starting column number
  • ending line number
  • ending column number

매개 변수 속성

형식:

Int32[]

Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:3
필수:False
파이프라인의 값:True
속성 이름별 파이프라인의 값:True
나머지 인수의 값:False

-ScriptDefinition

The text of the script to be formatted represented as a string. This is not a ScriptBlock object.

매개 변수 속성

형식:String
Default value:None
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:1
필수:True
파이프라인의 값:True
속성 이름별 파이프라인의 값:True
나머지 인수의 값:False

-Settings

A settings hashtable or a path to a PowerShell data file (.psd1) that contains the settings.

매개 변수 속성

형식:Object
Default value:CodeFormatting
와일드카드 지원:False
DontShow:False

매개 변수 집합

(All)
Position:2
필수:False
파이프라인의 값:True
속성 이름별 파이프라인의 값:True
나머지 인수의 값:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

출력

String

The formatted string result.