Skip to content

PSUseConsistentWhitespace: Ignore whitespace between separator and comment #2065

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
merged 1 commit into from
Feb 25, 2025
Merged

PSUseConsistentWhitespace: Ignore whitespace between separator and comment #2065

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
1 change: 1 addition & 0 deletions Rules/UseConsistentWhitespace.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -451,6 +451,7 @@ private IEnumerable<DiagnosticRecord> FindSeparatorViolations(TokenOperations to
{
return node.Next != null
&& node.Next.Value.Kind != TokenKind.NewLine
&& node.Next.Value.Kind != TokenKind.Comment
&& node.Next.Value.Kind != TokenKind.EndOfInput // semicolon can be followed by end of input
&& !IsPreviousTokenApartByWhitespace(node.Next);
};
Expand Down
42 changes: 42 additions & 0 deletions Tests/Rules/UseConsistentWhitespace.tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,6 +514,48 @@ if ($true) { Get-Item `
}
}

Context "CheckSeparator" {
BeforeAll {
$ruleConfiguration.CheckInnerBrace = $false
$ruleConfiguration.CheckOpenBrace = $false
$ruleConfiguration.CheckOpenParen = $false
$ruleConfiguration.CheckOperator = $false
$ruleConfiguration.CheckPipe = $false
$ruleConfiguration.CheckSeparator = $true
}

It "Should find a violation if there is no space after a comma" {
$def = '$Array = @(1,2)'
Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings | Should -HaveCount 1
}

It "Should not find a violation if there is a space after a comma" {
$def = '$Array = @(1, 2)'
Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings | Should -Be $null
}

It "Should not find a violation if there is a new-line after a comma" {
$def = @'
$Array = @(
1,
2
)
'@
Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings | Should -Be $null
}

It "Should not find a violation if there is a comment after the separator" {
$def = @'
$Array = @(
'foo', # Comment Line 1
'FizzBuzz' # Comment Line 2
)
'@
Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings | Should -BeNullOrEmpty
}

}


Context "CheckParameter" {
BeforeAll {
Expand Down