Skip to content

style: enable CheckOperator/CheckPipe/CheckParameter whitespace #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NWarila merged 1 commit into from
Jun 14, 2026
Merged

style: enable CheckOperator/CheckPipe/CheckParameter whitespace #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions PSScriptAnalyzerSettings.psd1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,20 @@
}

PSUseConsistentWhitespace = @{
Enable = $true
CheckInnerBrace = $true
CheckOpenBrace = $true
CheckOpenParen = $true
CheckOperator = $false
CheckSeparator = $true
Enable = $true
CheckInnerBrace = $true
CheckOpenBrace = $true
CheckOpenParen = $true
CheckOperator = $true
CheckParameter = $true
CheckPipe = $true
CheckSeparator = $true
IgnoreAssignmentOperatorInsideHashTable = $true
}

PSAlignAssignmentStatement = @{
Enable = $true
CheckEnums = $false
CheckHashtable = $true
}

Expand Down
17 changes: 16 additions & 1 deletion docs/STYLE-GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,12 +250,27 @@ $false` is the lever (its `GetViolationsForUncuddledBranches` path flags uncuddl
PSPlaceOpenBrace = @{ Enable = $true; OnSameLine = $true; NewLineAfter = $true; IgnoreOneLineBlock = $true }
PSPlaceCloseBrace = @{ Enable = $true; NewLineAfter = $false; IgnoreOneLineBlock = $true; NoEmptyLineBefore = $false }
PSUseConsistentIndentation = @{ Enable = $true; Kind = 'space'; IndentationSize = 2 }
PSUseConsistentWhitespace = @{
Enable = $true
CheckInnerBrace = $true
CheckOpenBrace = $true
CheckOpenParen = $true
CheckOperator = $true
CheckParameter = $true
CheckPipe = $true
CheckSeparator = $true
IgnoreAssignmentOperatorInsideHashTable = $true
}
PSAlignAssignmentStatement = @{ Enable = $true; CheckEnums = $false; CheckHashtable = $true }
```

`Invoke-Formatter` can drive a bulk reformat from the same settings, but it has known
edge bugs around branch placement (half-cuddled `else`, no inter-statement newline
insertion — issues #508, #794), so any auto-reformat must be re-linted and the
`else`/`catch`/`finally` sites eyeballed.
`else`/`catch`/`finally` sites eyeballed. Operator, pipe, and parameter spacing are
also formatter-enforced; the hashtable assignment carve-out is deliberate so aligned
hashtables continue to satisfy `PSAlignAssignmentStatement`. Enum member alignment is
disabled because `CheckOperator` owns assignment-operator spacing outside hashtables.

---

Expand Down