Skip to content

Preserve relative indentation in commented-out code #2257

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
Christoph Bergmeister (bergmeister) merged 2 commits into from
Oct 27, 2026
Merged

Preserve relative indentation in commented-out code #2257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d7ae16
Initial plan
Copilot Oct 27, 2026
80e81ec
Exclude trailing pipe comments from comment runs
Copilot Oct 27, 2026
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
5 changes: 5 additions & 0 deletions Rules/UseConsistentIndentation.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,11 @@ private static int GetCommentRunIndentationOffset(
return 0;
}

if (HasCodeBeforeCommentOnSameLine(tokens, tokenIndex))
{
return 0;
}

int firstCommentIndex = tokenIndex;
int currentLine = tokens[tokenIndex].Extent.StartLineNumber;
int precedingIndex = tokenIndex - 1;
Expand Down
25 changes: 25 additions & 0 deletions Tests/Rules/UseConsistentIndentation.tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -932,6 +932,31 @@ function test {
Invoke-Formatter -ScriptDefinition $expected -Settings $settings | Should -Be $expected
}

It "Should exclude a trailing comment after a line-leading pipe from comment runs" {
$def = @'
function test {
foo `
| # trailing
# standalone
bar
}
'@
$expected = @'
function test {
foo `
| # trailing
# standalone
bar
}
'@
$settings.Rules.PSUseConsistentIndentation.PipelineIndentation = 'NoIndentation'
$formatted = Invoke-Formatter -ScriptDefinition $def -Settings $settings

$formatted | Should -Be $expected
Invoke-Formatter -ScriptDefinition $formatted -Settings $settings |
Should -Be $expected
}

It "Should indent properly after line continuation (backtick) character with pipeline" {
$def = @'
foo |
Expand Down
Loading