GeezerVison is showing github.com — PSUseConsistentWhitespace: Ignore whitespace between separator and comment by liamjpeters · Pull Request #2065 · PowerShell/PSScriptAnalyzer
Conversation
PR Summary
When checking for consistent whitespace between separators, using:
$Settings = @{
IncludeRules = @('PSUseConsistentWhitespace')
Rules = @{
PSUseConsistentWhitespace = @{
Enable = $true
CheckInnerBrace = $false
CheckOpenBrace = $false
CheckOpenParen = $false
CheckOperator = $false
CheckPipe = $false
CheckPipeForRedundantWhitespace = $false
CheckSeparator = $true
CheckParameter = $false
IgnoreAssignmentOperatorInsideHashTable = $false
}
}
}
Whitespace between a separator and subsequent start of a comment is flagged as a violation. When formatting, it is removed.
So something such as:
$Array = @(
'Foo', # Comment Line 1
'FizzBuzz' # Comment Line 2
)
Is fixed to:
$Array = @(
'Foo', # Comment Line 1
'FizzBuzz' # Comment Line 2
)
This doesn't seem like desirable behaviour.
This PR ignores whitespace between separators and the start of a comment.
There were no tests around the CheckSeparator parameter, so I've added some.
Fixes #1842
PR Checklist
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
…e violations between a separator and a comment
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Reviewers
1 more reviewer
Reviewers whose approvals may not affect merge requirements
Uh oh!
There was an error while loading. Please reload this page.
Assignees
No one assigned
Milestone
No milestone
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.