Merge pull request #749 from PowerShell/kapilmb/fix-indentation-backtick

Fix indentation on line after backtick (line continuation character)

Author: Kapil Borle

Rules/UseConsistentIndentation.cs

@@ -91,6 +91,7 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
                         break;
 
                     case TokenKind.NewLine:
+                    case TokenKind.LineContinuation:
                         onNewLine = true;
                         break;
 
@@ -101,18 +102,26 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
                         {
                             var tempIndentationLevel = indentationLevel;
 
-                            // Ignore comments
-                            // Since the previous token is a newline token we start
-                            // looking for comments at the token before the newline token.
-                            int j = k - 2;
-                            while (j > 0 && tokens[j].Kind == TokenKind.Comment)
+                            // Check if the preceding character is an escape character
+                            if (k > 0 && tokens[k - 1].Kind == TokenKind.LineContinuation)
                             {
-                                --j;
+                                ++tempIndentationLevel;
                             }
-
-                            if (j >= 0 && tokens[j].Kind == TokenKind.Pipe)
+                            else
                             {
-                                ++tempIndentationLevel;
+                                // Ignore comments
+                                // Since the previous token is a newline token we start
+                                // looking for comments at the token before the newline token.
+                                int j = k - 2;
+                                while (j > 0 && tokens[j].Kind == TokenKind.Comment)
+                                {
+                                    --j;
+                                }
+
+                                if (j >= 0 && tokens[j].Kind == TokenKind.Pipe)
+                                {
+                                    ++tempIndentationLevel;
+                                }
                             }
 
                             AddViolation(token, tempIndentationLevel, diagnosticRecords, ref onNewLine);

Tests/Rules/UseConsistentIndentation.tests.ps1

@@ -1,4 +1,11 @@
-Import-Module PSScriptAnalyzer
+$directory = Split-Path -Parent $MyInvocation.MyCommand.Path
+$testRootDirectory = Split-Path -Parent $directory
+
+Import-Module PSScriptAnalyzer
+Import-Module (Join-Path $testRootDirectory "PSScriptAnalyzerTestHelper.psm1")
+
+$indentationUnit = ' '
+$indentationSize = 4
 $settings = @{
     IncludeRules = @("PSUseConsistentIndentation")
     Rules = @{
@@ -143,5 +150,22 @@ select Name,Id |
           $violations = Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings
           $violations.Count | Should Be 3
         }
+
+        It "Should indent properly after line continuation (backtick) character" {
+            $def = @'
+$x = "this " + `
+"Should be indented properly"
+'@
+            $violations = Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings
+            $violations.Count | Should Be 1
+            $params = @{
+                RawContent = $def
+                DiagnosticRecord = $violations[0]
+                CorrectionsCount = 1
+                ViolationText = "`"Should be indented properly`""
+                CorrectionText = (New-Object -TypeName String -ArgumentList $indentationUnit,$indentationSize) + "`"Should be indented properly`""
+            }
+            Test-CorrectionExtentFromContent @params
+        }
     }
 }