PipelineIndentationStyle: Fix edge case where pipeline was incorrectl…

…y detected to span mutliple lines due to backticks in the command leading up to the pipeline (#1312) * Fix logic to detect single-line pipeline * combine statements to not break other cases * Add test * Apply suggestions from code review Co-Authored-By: Robert Holt <[email protected]>
PowerShell · Aug 19, 2019 · 171c81d · 171c81d
1 parent c5b0382
commit 171c81d
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/Rules/UseConsistentIndentation.cs b/Rules/UseConsistentIndentation.cs
@@ -224,8 +224,10 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
                 {
                     continue;
                 }
-                bool pipelinesSpanOnlyOneLine = matchingPipeLineAstEnd.PipelineElements[0].Extent.StartLineNumber ==
-                    matchingPipeLineAstEnd.PipelineElements[matchingPipeLineAstEnd.PipelineElements.Count-1].Extent.StartLineNumber;
+                IScriptExtent firstPipelineElementExtent = matchingPipeLineAstEnd.PipelineElements[0].Extent;
+                IScriptExtent lastPipelineElementExtent = matchingPipeLineAstEnd.PipelineElements[matchingPipeLineAstEnd.PipelineElements.Count - 1].Extent;
+                bool pipelinesSpanOnlyOneLine = firstPipelineElementExtent.EndLineNumber == lastPipelineElementExtent.EndLineNumber
+                                             || firstPipelineElementExtent.StartLineNumber == lastPipelineElementExtent.StartLineNumber;
                 if (pipelinesSpanOnlyOneLine)
                 {
                     continue;

diff --git a/Tests/Rules/UseConsistentIndentation.tests.ps1 b/Tests/Rules/UseConsistentIndentation.tests.ps1
@@ -209,6 +209,24 @@ function foo {
         Invoke-Formatter -ScriptDefinition $idempotentScriptDefinition -Settings $settings | Should -Be $idempotentScriptDefinition
     }
 
+    It "Should preserve script when using PipelineIndentation <PipelineIndentation> for multi-line pipeline due to backtick" -TestCases @(
+        @{ PipelineIndentation = 'IncreaseIndentationForFirstPipeline' }
+        @{ PipelineIndentation = 'IncreaseIndentationAfterEveryPipeline' }
+        @{ PipelineIndentation = 'NoIndentation' }
+        ) {
+    param ($PipelineIndentation)
+    $idempotentScriptDefinition = @'
+Describe 'describe' {
+    It 'it' {
+        { 'To be,' -or `
+                -not 'to be' } | Should -Be 'the question'
+    }
+}
+'@
+    $settings.Rules.PSUseConsistentIndentation.PipelineIndentation = $PipelineIndentation
+    Invoke-Formatter -ScriptDefinition $idempotentScriptDefinition -Settings $settings | Should -Be $idempotentScriptDefinition
+}
+
         It "Should indent pipelines correctly using NoIndentation option" {
             $def = @'
 foo |