Skip to content

PSAvoidTrailingWhitespace: Rule not applied when using formatter + single character lines with trailing whitespace are truncated #1993

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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 Engine/Formatter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ public static string Format<TCmdlet>(
"PSAvoidUsingDoubleQuotesForConstantString",
"PSAvoidSemicolonsAsLineTerminators",
"PSAvoidExclaimOperator",
"PSAvoidTrailingWhitespace",
};

var text = new EditableText(scriptDefinition);
Expand Down
2 changes: 1 addition & 1 deletion Rules/AvoidTrailingWhitespace.cs
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
}

int startColumnOfTrailingWhitespace = 1;
for (int i = line.Length - 2; i > 0; i--)
for (int i = line.Length - 2; i >= 0; i--)
{
if (line[i] != ' ' && line[i] != '\t')
{
Expand Down
25 changes: 25 additions & 0 deletions Tests/Rules/AvoidTrailingWhitespace.tests.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ BeforeAll {

$settings = @{
IncludeRules = @($ruleName)
Rules = @{
$ruleName = @{}
}
}
}

Expand All @@ -34,4 +37,26 @@ Describe "AvoidTrailingWhitespace" {
$violations = Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings
Test-CorrectionExtentFromContent $def $violations 1 $Whitespace ''
}

It 'Should be used by Invoke-Formatter, when in settings, replacing trailing <Type>' -TestCases $testCases {
param (
[string] $Whitespace
)
# Test also guards against regression where single-character lines, with trailing whitespace
# would be removed entirely. See issues #1757, #1992
$def = @"
Function Get-Example {
'Example'$Whitespace
}$Whitespace
"@

$expected = @"
Function Get-Example {
'Example'
}
"@
$formatted = Invoke-Formatter -ScriptDefinition $def -Settings $settings
$formatted | Should -Be $expected
}

}