UseConsistentIndentation: When non-default options are used, cater for the case of a comment between pipe and newline (#1463)

* UseConsistentIndentation: When non-default options are used, cater for the case of a comment between pipe and newline

* Update Rules/UseConsistentIndentation.cs

Co-Authored-By: Robert Holt <rjmholt@gmail.com>

* re-trigger ci

* try split test template

* Revert "try split test template"

This reverts commit 226259d.

* fix syntax due to missing brace (also: GitHub suggestions did not correctly insert whitespaces in there)

Co-authored-by: Christoph Bergmeister <christoph.bergmeister@bjss.com>
Co-authored-by: Robert Holt <rjmholt@gmail.com>

Author: 3 people

Rules/UseConsistentIndentation.cs

@@ -155,8 +155,8 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
 
                     case TokenKind.Pipe:
                         if (pipelineIndentationStyle == PipelineIndentationStyle.None) { break; }
-                        bool pipelineIsFollowedByNewlineOrLineContinuation = tokenIndex < tokens.Length - 1 && tokenIndex > 0 &&
-                              (tokens[tokenIndex + 1].Kind == TokenKind.NewLine || tokens[tokenIndex + 1].Kind == TokenKind.LineContinuation);
+                        bool pipelineIsFollowedByNewlineOrLineContinuation =
+                            PipelineIsFollowedByNewlineOrLineContinuation(tokens, tokenIndex);
                         if (!pipelineIsFollowedByNewlineOrLineContinuation)
                         {
                             break;
@@ -254,6 +254,36 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
             return diagnosticRecords;
         }
 
+        private static bool PipelineIsFollowedByNewlineOrLineContinuation(Token[] tokens, int startIndex)
+        {
+            if (startIndex >= tokens.Length - 1)
+            {
+                return false;
+            }
+            
+            Token nextToken = null;
+            for (int i = startIndex + 1; i < tokens.Length; i++)
+            {
+                nextToken = tokens[i];
+
+                switch (nextToken.Kind)
+                {
+                    case TokenKind.Comment:
+                        continue;
+
+                    case TokenKind.NewLine:
+                    case TokenKind.LineContinuation:
+                        return true;
+
+                    default:
+                        return false;
+                }
+            }
+            
+            // We've run out of tokens but haven't seen a newline
+            return false;
+        }
+
         private static bool LineHasPipelineBeforeToken(Token[] tokens, int tokenIndex, Token token)
         {
             int searchIndex = tokenIndex;

Tests/Rules/UseConsistentIndentation.tests.ps1

@@ -156,6 +156,18 @@ foo |
             Invoke-FormatterAssertion $scriptDefinition $expected 3 $settings
         }
 
+        It "When a comment is after a pipeline and before the newline " {
+            $scriptDefinition = @'
+foo | # comment
+bar
+'@
+            $expected = @'
+foo | # comment
+    bar
+'@
+            Invoke-FormatterAssertion $scriptDefinition $expected 1 $settings
+        }
+
         It "Should find a violation if a pipleline element is not indented correctly" {
             $def = @'
 get-process |