Add indentation to correction

Author: Kapil Borle

Rules/ProvideCommentHelp.cs

@@ -93,7 +93,7 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
                         GetDiagnosticSeverity(),
                         fileName,
                         null,
-                        GetCorrection(functionDefinitionAst).ToList());
+                        GetCorrection(ast, functionDefinitionAst).ToList());
             }
         }
 
@@ -154,7 +154,7 @@ private DiagnosticSeverity GetDiagnosticSeverity()
             return DiagnosticSeverity.Information;
         }
 
-        private IEnumerable<CorrectionExtent> GetCorrection(FunctionDefinitionAst funcDefnAst)
+        private IEnumerable<CorrectionExtent> GetCorrection(Ast ast, FunctionDefinitionAst funcDefnAst)
         {
             var helpBuilder = new CommentHelpBuilder();
 
@@ -173,26 +173,45 @@ private IEnumerable<CorrectionExtent> GetCorrection(FunctionDefinitionAst funcDe
                 endLine,
                 startColumn,
                 endColumn,
-                ProcessCorrectionForPlacement(
-                    helpBuilder.GetCommentHelp(
-                        BlockComment,
-                        VSCodeSnippetCorrection)),
+                GetCorrectionText(
+                    helpBuilder.GetCommentHelp(BlockComment, VSCodeSnippetCorrection),
+                    ast,
+                    funcDefnAst),
                 funcDefnAst.Extent.File);
         }
 
-        private string ProcessCorrectionForPlacement(string correction)
+        private string GetCorrectionText(string correction, Ast ast, FunctionDefinitionAst funcDefnAst)
         {
+            var indentationString = String.Empty;
+            if (funcDefnAst.Extent.StartColumnNumber > 1)
+            {
+                indentationString = GetLines(ast.Extent.Text)
+                    .ElementAt(funcDefnAst.Extent.StartLineNumber - 1)
+                    .Substring(0, funcDefnAst.Extent.StartColumnNumber - 1);
+                correction = String.Join(
+                        Environment.NewLine,
+                        GetLines(correction).Select(l => indentationString + l));
+            }
+
             switch (placement)
             {
                 case CommentHelpPlacement.Begin:
-                    return "{" + Environment.NewLine + correction + Environment.NewLine;
+                    return $"{{{Environment.NewLine}{correction}{Environment.NewLine}";
+
                 case CommentHelpPlacement.End:
-                    return Environment.NewLine + correction + Environment.NewLine;
+                    return $"{Environment.NewLine}{correction}{Environment.NewLine}{indentationString}";
+
                 default: // CommentHelpPlacement.Before
-                    return correction + Environment.NewLine;
+                    return $"{correction}{Environment.NewLine}";
             }
         }
 
+        // TODO replace with extension version
+        private static IEnumerable<string> GetLines(string text)
+        {
+            return text.Split('\n').Select(l => l.Trim('\r'));
+        }
+
         private void GetCorrectionPosition(
             FunctionDefinitionAst funcDefnAst,
             out int startLine,
@@ -220,7 +239,7 @@ private void GetCorrectionPosition(
                 default: // CommentHelpPlacement.Before
                     startLine = funcDefnAst.Extent.StartLineNumber;
                     endLine = startLine;
-                    startColumn = funcDefnAst.Extent.StartColumnNumber;
+                    startColumn = 1;
                     endColumn = startColumn;
                     break;
             }
@@ -314,7 +333,7 @@ public string GetCommentHelp(bool blockComment, bool snippet)
                 {
                     var boundaryString = new String('#', 30);
                     sb.AppendLine(boundaryString);
-                    var lines = helpContent.Split('\n').Select(l => l.Trim('\r'));
+                    var lines = GetLines(helpContent);
                     foreach (var line in lines)
                     {
                         sb.Append("#");

Tests/Rules/ProvideCommentHelp.tests.ps1

@@ -287,6 +287,40 @@ General notes
             Test-Correction $def $expectedCorrection $settings
         }
 
+        It "should return a help snippet correction with correct indentation" {
+            $def = @'
+    function foo {
+        param($param1)
+    }
+'@
+            $s = ' '
+            $expectedCorrection = @"
+    <#
+    .SYNOPSIS
+    Short description
+$s$s$s$s
+    .DESCRIPTION
+    Long description
+$s$s$s$s
+    .PARAMETER param1
+    Parameter description
+$s$s$s$s
+    .EXAMPLE
+    An example
+$s$s$s$s
+    .NOTES
+    General notes
+    #>
+
+"@
+            $ruleSettings.'ExportedOnly' = $false
+            $ruleSettings.'BlockComment' = $true
+            $ruleSettings.'VSCodeSnippetCorrection' = $false
+            $ruleSettings.'Placement' = 'before'
+            Test-Correction $def $expectedCorrection $settings
+        }
+
+
         if ($PSVersionTable.PSVersion -ge [Version]'5.0.0') {
             It "Does not count violation in DSC class" {
                 $dscViolations.Count | Should Be 0