From 6f2826ac8949f5ca42b68cdf414175c192381a46 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 22 Oct 2026 22:00:16 +0000 Subject: [PATCH 1/6] Initial plan From 7092b4ce30d1e713675b2788d4e7c357e5bf6ab7 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 22 Oct 2026 22:04:29 +0000 Subject: [PATCH 2/6] Preserve comment-run indentation Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> --- Rules/UseConsistentIndentation.cs | 41 ++++++++++-- .../Rules/UseConsistentIndentation.tests.ps1 | 66 +++++++++++++++++++ 2 files changed, 101 insertions(+), 6 deletions(-) diff --git a/Rules/UseConsistentIndentation.cs b/Rules/UseConsistentIndentation.cs index 2c77787c6..a5020a04d 100644 --- a/Rules/UseConsistentIndentation.cs +++ b/Rules/UseConsistentIndentation.cs @@ -298,7 +298,10 @@ public override IEnumerable AnalyzeScript(Ast ast, string file } bool lineHasPipelineBeforeToken = LineHasPipelineBeforeToken(tokens, tokenIndex, token); - AddViolation(token, tempIndentationLevel, diagnosticRecords, ref onNewLine, lineHasPipelineBeforeToken); + int commentIndentationOffset = token.Kind == TokenKind.Comment + ? GetCommentRunIndentationOffset(tokens, tokenIndex) + : 0; + AddViolation(token, tempIndentationLevel, diagnosticRecords, ref onNewLine, lineHasPipelineBeforeToken, commentIndentationOffset); } break; } @@ -336,6 +339,30 @@ public override IEnumerable AnalyzeScript(Ast ast, string file return diagnosticRecords; } + private static int GetCommentRunIndentationOffset(Token[] tokens, int tokenIndex) + { + int firstCommentIndex = tokenIndex; + int currentLine = tokens[tokenIndex].Extent.StartLineNumber; + int precedingIndex = tokenIndex - 1; + while (precedingIndex >= 0 && tokens[precedingIndex].Kind == TokenKind.NewLine) + { + precedingIndex--; + if (precedingIndex < 0 || + tokens[precedingIndex].Kind != TokenKind.Comment || + tokens[precedingIndex].Extent.EndLineNumber != currentLine - 1) + { + break; + } + + firstCommentIndex = precedingIndex; + currentLine = tokens[precedingIndex].Extent.StartLineNumber; + precedingIndex--; + } + + return tokens[tokenIndex].Extent.StartColumnNumber - + tokens[firstCommentIndex].Extent.StartColumnNumber; + } + /// /// Scans forward from the current opener to the end of the line. /// Returns true if there is at least one unclosed opener when @@ -612,12 +639,14 @@ private void AddViolation( int expectedIndentationLevel, List diagnosticRecords, ref bool onNewLine, - bool lineHasPipelineBeforeToken = false) + bool lineHasPipelineBeforeToken = false, + int indentationOffset = 0) { if (onNewLine) { onNewLine = false; - if (token.Extent.StartColumnNumber - 1 != GetIndentation(expectedIndentationLevel)) + int expectedIndentation = Math.Max(0, GetIndentation(expectedIndentationLevel) + indentationOffset); + if (token.Extent.StartColumnNumber - 1 != expectedIndentation) { var fileName = token.Extent.File; var extent = token.Extent; @@ -640,14 +669,14 @@ private void AddViolation( GetDiagnosticSeverity(), fileName, null, - GetSuggestedCorrections(token, expectedIndentationLevel, lineHasPipelineBeforeToken))); + GetSuggestedCorrections(token, expectedIndentation, lineHasPipelineBeforeToken))); } } } private List GetSuggestedCorrections( Token token, - int indentationLevel, + int indentation, bool lineHasPipelineBeforeToken = false) { // TODO Add another constructor for correction extent that takes extent @@ -661,7 +690,7 @@ private List GetSuggestedCorrections( token.Extent.EndLineNumber, 1, token.Extent.EndColumnNumber, - GetIndentationString(indentationLevel) + optionalPipeline + token.Extent.Text, + new string(indentationChar, indentation) + optionalPipeline + token.Extent.Text, token.Extent.File)); return corrections; } diff --git a/Tests/Rules/UseConsistentIndentation.tests.ps1 b/Tests/Rules/UseConsistentIndentation.tests.ps1 index 6bf241116..ff40d3f79 100644 --- a/Tests/Rules/UseConsistentIndentation.tests.ps1 +++ b/Tests/Rules/UseConsistentIndentation.tests.ps1 @@ -206,6 +206,72 @@ function foo { Context "When a multi-line command is given" { + It 'Should preserve relative indentation in commented-out code with indentation' -TestCases @( + @{ Kind = 'space'; Indentation = ' ' } + @{ Kind = 'tab'; Indentation = "`t" } + ) { + param([string] $Kind, [string] $Indentation) + $scriptDefinition = @( + 'if ($a) {' + "$Indentation# if (`$b) {" + "$Indentation$Indentation# doThing" + "$Indentation# }" + "$($Indentation)Write-Output 'after'" + '}' + ) -join "`n" + $settings = @{ + IncludeRules = @('PSUseConsistentIndentation') + Rules = @{ + PSUseConsistentIndentation = @{ + Enable = $true + IndentationSize = 4 + PipelineIndentation = 'NoIndentation' + Kind = $Kind + } + } + } + + Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings | + Should -Be $scriptDefinition + } + + It 'Should shift a commented-out code block without flattening it with indentation' -TestCases @( + @{ Kind = 'space'; Indentation = ' ' } + @{ Kind = 'tab'; Indentation = "`t" } + ) { + param([string] $Kind, [string] $Indentation) + $scriptDefinition = @( + 'if ($a) {' + '# if ($b) {' + "$Indentation# doThing" + '# }' + "$($Indentation)Write-Output 'after'" + '}' + ) -join "`n" + $expectedScriptDefinition = @( + 'if ($a) {' + "$Indentation# if (`$b) {" + "$Indentation$Indentation# doThing" + "$Indentation# }" + "$($Indentation)Write-Output 'after'" + '}' + ) -join "`n" + $settings = @{ + IncludeRules = @('PSUseConsistentIndentation') + Rules = @{ + PSUseConsistentIndentation = @{ + Enable = $true + IndentationSize = 4 + PipelineIndentation = 'NoIndentation' + Kind = $Kind + } + } + } + + Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings | + Should -Be $expectedScriptDefinition + } + It "When a comment is in the middle of a multi-line statement with preceding and succeeding line continuations" { $scriptDefinition = @' foo ` From 9941989b0d6ef4b6dc304ee4dfb8fc8be908035a Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 22 Oct 2026 22:06:12 +0000 Subject: [PATCH 3/6] Refine comment-run handling Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> --- Rules/UseConsistentIndentation.cs | 7 ++--- .../Rules/UseConsistentIndentation.tests.ps1 | 30 +++++-------------- 2 files changed, 9 insertions(+), 28 deletions(-) diff --git a/Rules/UseConsistentIndentation.cs b/Rules/UseConsistentIndentation.cs index a5020a04d..97c913db5 100644 --- a/Rules/UseConsistentIndentation.cs +++ b/Rules/UseConsistentIndentation.cs @@ -349,7 +349,8 @@ private static int GetCommentRunIndentationOffset(Token[] tokens, int tokenIndex precedingIndex--; if (precedingIndex < 0 || tokens[precedingIndex].Kind != TokenKind.Comment || - tokens[precedingIndex].Extent.EndLineNumber != currentLine - 1) + tokens[precedingIndex].Extent.EndLineNumber != currentLine - 1 || + (precedingIndex > 0 && tokens[precedingIndex - 1].Kind != TokenKind.NewLine)) { break; } @@ -706,9 +707,5 @@ private int GetIndentation(int indentationLevel) return indentationLevel * indentationLevelMultiplier; } - private string GetIndentationString(int indentationLevel) - { - return new string(indentationChar, GetIndentation(indentationLevel)); - } } } diff --git a/Tests/Rules/UseConsistentIndentation.tests.ps1 b/Tests/Rules/UseConsistentIndentation.tests.ps1 index ff40d3f79..3a0f325e2 100644 --- a/Tests/Rules/UseConsistentIndentation.tests.ps1 +++ b/Tests/Rules/UseConsistentIndentation.tests.ps1 @@ -204,7 +204,7 @@ function foo { } } - Context "When a multi-line command is given" { + Context "When a commented-out code block is provided" { It 'Should preserve relative indentation in commented-out code with indentation' -TestCases @( @{ Kind = 'space'; Indentation = ' ' } @@ -219,17 +219,8 @@ function foo { "$($Indentation)Write-Output 'after'" '}' ) -join "`n" - $settings = @{ - IncludeRules = @('PSUseConsistentIndentation') - Rules = @{ - PSUseConsistentIndentation = @{ - Enable = $true - IndentationSize = 4 - PipelineIndentation = 'NoIndentation' - Kind = $Kind - } - } - } + $settings.Rules.PSUseConsistentIndentation.Kind = $Kind + $settings.Rules.PSUseConsistentIndentation.PipelineIndentation = 'NoIndentation' Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings | Should -Be $scriptDefinition @@ -256,22 +247,15 @@ function foo { "$($Indentation)Write-Output 'after'" '}' ) -join "`n" - $settings = @{ - IncludeRules = @('PSUseConsistentIndentation') - Rules = @{ - PSUseConsistentIndentation = @{ - Enable = $true - IndentationSize = 4 - PipelineIndentation = 'NoIndentation' - Kind = $Kind - } - } - } + $settings.Rules.PSUseConsistentIndentation.Kind = $Kind + $settings.Rules.PSUseConsistentIndentation.PipelineIndentation = 'NoIndentation' Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings | Should -Be $expectedScriptDefinition } + } + Context "When a multi-line command is given" { It "When a comment is in the middle of a multi-line statement with preceding and succeeding line continuations" { $scriptDefinition = @' foo ` From 0c2d63043a33b6ce3457a7da7eb0ddd5de60e761 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 26 Oct 2026 11:18:39 +0000 Subject: [PATCH 4/6] Preserve relative indentation in comment runs (#2236) * Initial plan * Preserve indentation across comment runs Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> --- Rules/UseConsistentIndentation.cs | 15 ++++++++++++++- Tests/Rules/UseConsistentIndentation.tests.ps1 | 16 ++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/Rules/UseConsistentIndentation.cs b/Rules/UseConsistentIndentation.cs index 97c913db5..7c51b98f6 100644 --- a/Rules/UseConsistentIndentation.cs +++ b/Rules/UseConsistentIndentation.cs @@ -360,8 +360,21 @@ private static int GetCommentRunIndentationOffset(Token[] tokens, int tokenIndex precedingIndex--; } + int leastIndentedColumn = tokens[firstCommentIndex].Extent.StartColumnNumber; + for (int nextCommentIndex = firstCommentIndex + 2; + nextCommentIndex < tokens.Length && + tokens[nextCommentIndex - 1].Kind == TokenKind.NewLine && + tokens[nextCommentIndex].Kind == TokenKind.Comment && + tokens[nextCommentIndex].Extent.StartLineNumber == tokens[nextCommentIndex - 2].Extent.EndLineNumber + 1; + nextCommentIndex += 2) + { + leastIndentedColumn = Math.Min( + leastIndentedColumn, + tokens[nextCommentIndex].Extent.StartColumnNumber); + } + return tokens[tokenIndex].Extent.StartColumnNumber - - tokens[firstCommentIndex].Extent.StartColumnNumber; + leastIndentedColumn; } /// diff --git a/Tests/Rules/UseConsistentIndentation.tests.ps1 b/Tests/Rules/UseConsistentIndentation.tests.ps1 index 3a0f325e2..c6418ed49 100644 --- a/Tests/Rules/UseConsistentIndentation.tests.ps1 +++ b/Tests/Rules/UseConsistentIndentation.tests.ps1 @@ -253,6 +253,22 @@ function foo { Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings | Should -Be $expectedScriptDefinition } + + It 'Should preserve indentation when the first comment is not the least-indented with indentation' -TestCases @( + @{ Kind = 'space'; Indentation = ' ' } + @{ Kind = 'tab'; Indentation = "`t" } + ) { + param([string] $Kind, [string] $Indentation) + $scriptDefinition = @( + "$Indentation# inner" + '# outer' + ) -join "`n" + $settings.Rules.PSUseConsistentIndentation.Kind = $Kind + $settings.Rules.PSUseConsistentIndentation.PipelineIndentation = 'NoIndentation' + + Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings | + Should -Be $scriptDefinition + } } Context "When a multi-line command is given" { From 227ab25f2362412404feb49f1261086eca539893 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 26 Oct 2026 20:44:17 +0000 Subject: [PATCH 5/6] Preserve relative indentation in commented-out code (#2238) * Initial plan * Fix comment runs after line continuations Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> * Fix continuation indent after comment runs Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> * Include line continuations in comment scan Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> * Apply last suggestion 'Prevent double-counting indentation in comment runs' https://github.com/PowerShell/PSScriptAnalyzer/pull/2238#discussion_r4381470637 * Fix Pester discovery by removing extra BOM Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> Co-authored-by: Christoph Bergmeister --- Rules/UseConsistentIndentation.cs | 47 +++++++++----- .../Rules/UseConsistentIndentation.tests.ps1 | 65 +++++++++++++++++++ docs/Rules/UseConsistentIndentation.md | 3 + 3 files changed, 100 insertions(+), 15 deletions(-) diff --git a/Rules/UseConsistentIndentation.cs b/Rules/UseConsistentIndentation.cs index 7c51b98f6..5fd573cc5 100644 --- a/Rules/UseConsistentIndentation.cs +++ b/Rules/UseConsistentIndentation.cs @@ -275,17 +275,15 @@ public override IEnumerable AnalyzeScript(Ast ast, string file ++tempIndentationLevel; } - // check for comments in between multi-line commands with line continuation + // Check for comments in between multi-line commands with line continuation. if (tokenIndex > 2 && tokens[tokenIndex - 1].Kind == TokenKind.NewLine && tokens[tokenIndex - 2].Kind == TokenKind.Comment) { - int searchForPrecedingLineContinuationIndex = tokenIndex - 2; - while (searchForPrecedingLineContinuationIndex > 0 && tokens[searchForPrecedingLineContinuationIndex].Kind == TokenKind.Comment) - { - searchForPrecedingLineContinuationIndex--; - } - - if (searchForPrecedingLineContinuationIndex >= 0 && tokens[searchForPrecedingLineContinuationIndex].Kind == TokenKind.LineContinuation) + GetCommentRunIndentationOffset( + tokens, + tokenIndex - 2, + out bool commentRunStartsAfterLineContinuation); + if (commentRunStartsAfterLineContinuation) { tempIndentationLevel++; } @@ -298,9 +296,17 @@ public override IEnumerable AnalyzeScript(Ast ast, string file } bool lineHasPipelineBeforeToken = LineHasPipelineBeforeToken(tokens, tokenIndex, token); - int commentIndentationOffset = token.Kind == TokenKind.Comment - ? GetCommentRunIndentationOffset(tokens, tokenIndex) - : 0; + int commentIndentationOffset = 0; + if (token.Kind == TokenKind.Comment) + { + commentIndentationOffset = GetCommentRunIndentationOffset( + tokens, + tokenIndex, + out bool commentRunStartsAfterLineContinuation); + tempIndentationLevel = indentationLevel + + (commentRunStartsAfterLineContinuation ? 1 : 0); + } + AddViolation(token, tempIndentationLevel, diagnosticRecords, ref onNewLine, lineHasPipelineBeforeToken, commentIndentationOffset); } break; @@ -339,18 +345,25 @@ public override IEnumerable AnalyzeScript(Ast ast, string file return diagnosticRecords; } - private static int GetCommentRunIndentationOffset(Token[] tokens, int tokenIndex) + private static int GetCommentRunIndentationOffset( + Token[] tokens, + int tokenIndex, + out bool commentRunStartsAfterLineContinuation) { int firstCommentIndex = tokenIndex; int currentLine = tokens[tokenIndex].Extent.StartLineNumber; int precedingIndex = tokenIndex - 1; - while (precedingIndex >= 0 && tokens[precedingIndex].Kind == TokenKind.NewLine) + while (precedingIndex >= 0 && + (tokens[precedingIndex].Kind == TokenKind.NewLine || + tokens[precedingIndex].Kind == TokenKind.LineContinuation)) { precedingIndex--; if (precedingIndex < 0 || tokens[precedingIndex].Kind != TokenKind.Comment || tokens[precedingIndex].Extent.EndLineNumber != currentLine - 1 || - (precedingIndex > 0 && tokens[precedingIndex - 1].Kind != TokenKind.NewLine)) + (precedingIndex > 0 && + tokens[precedingIndex - 1].Kind != TokenKind.NewLine && + tokens[precedingIndex - 1].Kind != TokenKind.LineContinuation)) { break; } @@ -360,10 +373,14 @@ private static int GetCommentRunIndentationOffset(Token[] tokens, int tokenIndex precedingIndex--; } + commentRunStartsAfterLineContinuation = + firstCommentIndex > 0 && + tokens[firstCommentIndex - 1].Kind == TokenKind.LineContinuation; int leastIndentedColumn = tokens[firstCommentIndex].Extent.StartColumnNumber; for (int nextCommentIndex = firstCommentIndex + 2; nextCommentIndex < tokens.Length && - tokens[nextCommentIndex - 1].Kind == TokenKind.NewLine && + (tokens[nextCommentIndex - 1].Kind == TokenKind.NewLine || + tokens[nextCommentIndex - 1].Kind == TokenKind.LineContinuation) && tokens[nextCommentIndex].Kind == TokenKind.Comment && tokens[nextCommentIndex].Extent.StartLineNumber == tokens[nextCommentIndex - 2].Extent.EndLineNumber + 1; nextCommentIndex += 2) diff --git a/Tests/Rules/UseConsistentIndentation.tests.ps1 b/Tests/Rules/UseConsistentIndentation.tests.ps1 index c6418ed49..6febc02c7 100644 --- a/Tests/Rules/UseConsistentIndentation.tests.ps1 +++ b/Tests/Rules/UseConsistentIndentation.tests.ps1 @@ -254,6 +254,20 @@ function foo { Should -Be $expectedScriptDefinition } + It 'Should preserve relative indentation in comments after a line continuation' { + $scriptDefinition = @' +Write-Output ` + # first + # nested + # last + -InputObject 'value' +'@ + $settings.Rules.PSUseConsistentIndentation.PipelineIndentation = 'NoIndentation' + + Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings | + Should -Be $scriptDefinition + } + It 'Should preserve indentation when the first comment is not the least-indented with indentation' -TestCases @( @{ Kind = 'space'; Indentation = ' ' } @{ Kind = 'tab'; Indentation = "`t" } @@ -269,6 +283,57 @@ function foo { Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings | Should -Be $scriptDefinition } + + It 'Should preserve a comment run containing an internal line continuation with indentation' -TestCases @( + @{ Kind = 'space'; Indentation = ' ' } + @{ Kind = 'tab'; Indentation = "`t" } + ) { + param([string] $Kind, [string] $Indentation) + $scriptDefinition = @( + '<# first #> `' + "$Indentation<# second #>" + "Write-Output 'after'" + ) -join "`n" + $settings.Rules.PSUseConsistentIndentation.Kind = $Kind + + $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -Settings $settings + $violations.Count | Should -Be 0 + $formatted = Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings + $formatted | Should -Be $scriptDefinition + Invoke-Formatter -ScriptDefinition $formatted -Settings $settings | + Should -Be $formatted + } + + It 'Should shift a comment run containing an internal line continuation uniformly with indentation' -TestCases @( + @{ Kind = 'space'; Indentation = ' ' } + @{ Kind = 'tab'; Indentation = "`t" } + ) { + param([string] $Kind, [string] $Indentation) + $scriptDefinition = @( + 'if ($a) {' + '<# first #> `' + "$Indentation<# second #>" + "$($Indentation)Write-Output 'after'" + '}' + ) -join "`n" + $expectedScriptDefinition = @( + 'if ($a) {' + "$Indentation<# first #> ``" + "$Indentation$Indentation<# second #>" + "$($Indentation)Write-Output 'after'" + '}' + ) -join "`n" + $settings.Rules.PSUseConsistentIndentation.Kind = $Kind + + $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -Settings $settings + $violations.Count | Should -Be 2 + $formatted = Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings $settings + $formatted | Should -Be $expectedScriptDefinition + Invoke-Formatter -ScriptDefinition $formatted -Settings $settings | + Should -Be $formatted + $violations = Invoke-ScriptAnalyzer -ScriptDefinition $formatted -Settings $settings + $violations.Count | Should -Be 0 + } } Context "When a multi-line command is given" { diff --git a/docs/Rules/UseConsistentIndentation.md b/docs/Rules/UseConsistentIndentation.md index 5e6392772..4d020bbd4 100644 --- a/docs/Rules/UseConsistentIndentation.md +++ b/docs/Rules/UseConsistentIndentation.md @@ -15,6 +15,9 @@ title: UseConsistentIndentation This rule detects inconsistent indentation patterns within a source file. Indentation should be consistent throughout your script. +Consecutive comment lines are shifted together to preserve their relative indentation, including +when a line continuation occurs within the comment run. + ## Example ### Noncompliant From b028aaf2a5b6f5d51835393bf93bb6365c40bc37 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Mon, 26 Oct 2026 21:44:42 +0000 Subject: [PATCH 6/6] Preserve comment indentation after pipelines with PipelineIndentation=None (#2241) * Initial plan * Fix comment indentation after skipped pipelines Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> * Fix inconsistent indentation in UseConsistentIndentation tests Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> Co-authored-by: Christoph Bergmeister Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- Rules/UseConsistentIndentation.cs | 17 ++++++++++++++--- Tests/Rules/UseConsistentIndentation.tests.ps1 | 13 +++++++++++++ 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/Rules/UseConsistentIndentation.cs b/Rules/UseConsistentIndentation.cs index 5fd573cc5..0e6680e63 100644 --- a/Rules/UseConsistentIndentation.cs +++ b/Rules/UseConsistentIndentation.cs @@ -282,7 +282,8 @@ public override IEnumerable AnalyzeScript(Ast ast, string file GetCommentRunIndentationOffset( tokens, tokenIndex - 2, - out bool commentRunStartsAfterLineContinuation); + out bool commentRunStartsAfterLineContinuation, + out _); if (commentRunStartsAfterLineContinuation) { tempIndentationLevel++; @@ -302,7 +303,14 @@ public override IEnumerable AnalyzeScript(Ast ast, string file commentIndentationOffset = GetCommentRunIndentationOffset( tokens, tokenIndex, - out bool commentRunStartsAfterLineContinuation); + out bool commentRunStartsAfterLineContinuation, + out bool commentRunStartsAfterPipeline); + if (pipelineIndentationStyle == PipelineIndentationStyle.None && + commentRunStartsAfterPipeline) + { + onNewLine = false; + continue; + } tempIndentationLevel = indentationLevel + (commentRunStartsAfterLineContinuation ? 1 : 0); } @@ -348,7 +356,8 @@ public override IEnumerable AnalyzeScript(Ast ast, string file private static int GetCommentRunIndentationOffset( Token[] tokens, int tokenIndex, - out bool commentRunStartsAfterLineContinuation) + out bool commentRunStartsAfterLineContinuation, + out bool commentRunStartsAfterPipeline) { int firstCommentIndex = tokenIndex; int currentLine = tokens[tokenIndex].Extent.StartLineNumber; @@ -376,6 +385,8 @@ private static int GetCommentRunIndentationOffset( commentRunStartsAfterLineContinuation = firstCommentIndex > 0 && tokens[firstCommentIndex - 1].Kind == TokenKind.LineContinuation; + commentRunStartsAfterPipeline = + PreviousLineEndedWithPipe(tokens, firstCommentIndex, tokens[firstCommentIndex]); int leastIndentedColumn = tokens[firstCommentIndex].Extent.StartColumnNumber; for (int nextCommentIndex = firstCommentIndex + 2; nextCommentIndex < tokens.Length && diff --git a/Tests/Rules/UseConsistentIndentation.tests.ps1 b/Tests/Rules/UseConsistentIndentation.tests.ps1 index 6febc02c7..d07a7b0a5 100644 --- a/Tests/Rules/UseConsistentIndentation.tests.ps1 +++ b/Tests/Rules/UseConsistentIndentation.tests.ps1 @@ -661,6 +661,19 @@ foo | Test-CorrectionExtentFromContent @params } + It "Should preserve indentation in a comment run after a pipeline with PipelineIndentation None" { + $def = @' +foo | + # first comment + # second comment +bar +'@ + $settings.Rules.PSUseConsistentIndentation.PipelineIndentation = 'None' + $violations = Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings + $violations | Should -BeNullOrEmpty + Invoke-Formatter -ScriptDefinition $def -Settings $settings | Should -Be $def + } + It "Should indent properly after line continuation (backtick) character with pipeline" { $def = @' foo |