Skip to content

PlaceCloseBrace.md

Latest commit

 

History

History
51 lines (36 loc) · 1.29 KB

PlaceCloseBrace.md

File metadata and controls

51 lines (36 loc) · 1.29 KB
description Place close braces
ms.custom PSSA v1.21.0
ms.date 10/18/2021
ms.topic reference
title PlaceCloseBrace

PlaceCloseBrace

Severity Level: Warning

Description

Close brace placement should follow a consistent style. It should be on a new line by itself and should not be followed by an empty line.

Note: This rule is not enabled by default. The user needs to enable it through settings.

Configuration

Rules = @{
    PSPlaceCloseBrace = @{
        Enable = $true
        NoEmptyLineBefore = $false
        IgnoreOneLineBlock = $true
        NewLineAfter = $true
    }
}

Parameters

Enable: bool (Default value is $false)

Enable or disable the rule during ScriptAnalyzer invocation.

NoEmptyLineBefore: bool (Default value is $false)

Create violation if there is an empty line before a close brace.

IgnoreOneLineBlock: bool (Default value is $true)

Indicates if closed brace pairs 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.

NewLineAfter: bool (Default value is $true)

Indicates if a new line should follow a close brace. If set to true a close brace should be followed by a new line.