Skip to main content

Documentation Index

Fetch the complete documentation index at: https://tally.wharflab.com/llms.txt

Use this file to discover all available pages before exploring further.

powershell/PSPlaceOpenBrace is a PSScriptAnalyzer diagnostic emitted by tally for PowerShell snippets embedded in Dockerfiles.
PropertyValue
SeverityWarning
CategoryPSScriptAnalyzer
Auto-fixNo

​
Description

Open brace placement should follow a consistent style. It can either follow K&R style (on same line) or the Allman style (not on same line). Note: This rule is not enabled by default. The user needs to enable it through settings.

​
Configuration

Rules = @{
    PSPlaceOpenBrace = @{
        Enable = $true
        OnSameLine = $true
        NewLineAfter = $true
        IgnoreOneLineBlock = $true
    }
}

​
Parameters

​
Enable: bool (Default value is $false)

Enable or disable the rule during ScriptAnalyzer invocation.

​
OnSameLine: bool (Default value is $true)

Enforce open brace to be on the same line as that of its preceding keyword.

​
NewLineAfter: bool (Default value is $true)

Enforce a new line character after an open brace. The default value is true.

​
IgnoreOneLineBlock: bool (Default value is $true)

Indicates if open braces in a one line block should be ignored or not. For example, $x = if ($true) { 'blah' } else { 'blah blah' }, if the property is set to true then the rule doesn’t fire a violation.

​
Source

This rule documentation is adapted from Microsoft’s PSScriptAnalyzer documentation for PlaceOpenBrace, licensed under CC BY 4.0.