Auto-complete help in function body

Author: Kapil Borle

src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs

@@ -1082,31 +1082,33 @@ protected async Task HandleCommentHelpRequest(
         {
             var scriptFile = EditorSession.Workspace.GetFile(requestParams.DocumentUri);
             var expectedFunctionLine = requestParams.TriggerPosition.Line + 2;
-            var functionDefinitionAst = EditorSession.LanguageService.GetFunctionDefinitionAtLine(
+            string helpLocation;
+            var functionDefinitionAst = EditorSession.LanguageService.GetFunctionDefinitionForHelpComment(
                 scriptFile,
-                expectedFunctionLine);
-            var result = new CommentHelpRequestResult();
+                requestParams.TriggerPosition.Line + 1,
+                out helpLocation);
 
+            var result = new CommentHelpRequestResult();
             if (functionDefinitionAst != null)
             {
-               // todo create a semantic marker api that take only string
+                // todo create a semantic marker api that take only string
                 var analysisResults = await EditorSession.AnalysisService.GetSemanticMarkersAsync(
                     scriptFile,
                     AnalysisService.GetCommentHelpRuleSettings(
                         true,
                         false,
                         requestParams.BlockComment,
                         true,
-                        "before"));
-
-                var analysisResult = analysisResults?.FirstOrDefault(x =>
-                {
-                    return x.Correction != null
-                        && x.Correction.Edits[0].StartLineNumber == expectedFunctionLine;
-                });
-
-                // find the analysis result whose correction starts on
-                result.Content = analysisResult?.Correction.Edits[0].Text.Split('\n').Select(x => x.Trim('\r')).ToArray();
+                        helpLocation));
+
+                result.Content = analysisResults?
+                                     .FirstOrDefault()?
+                                     .Correction?
+                                     .Edits[0]
+                                     .Text
+                                     .Split('\n')
+                                     .Select(x => x.Trim('\r'))
+                                     .ToArray();
             }
 
             await requestContext.SendResult(result);

src/PowerShellEditorServices/Language/LanguageService.cs

@@ -545,7 +545,7 @@ public FunctionDefinitionAst GetFunctionDefinitionForHelpComment(
             int lineNumber,
             out string helpLocation)
         {
-            var foundAst = scriptFile.ScriptAst.FindAll(
+            var foundAsts = scriptFile.ScriptAst.FindAll(
                 ast =>
                 {
                     // find all the script definitions that contain the line `lineNumber`
@@ -558,7 +558,16 @@ public FunctionDefinitionAst GetFunctionDefinitionForHelpComment(
                     return fdAst.Body.Extent.StartLineNumber < lineNumber &&
                         fdAst.Body.Extent.EndLineNumber > lineNumber;
                 },
-                true).Aggregate((x, y) =>
+                true);
+
+            // check if the next line contains a function definition
+            if (foundAsts == null || !foundAsts.Any())
+            {
+                helpLocation = "before";
+                return GetFunctionDefinitionAtLine(scriptFile, lineNumber + 1);
+            }
+
+            var funcDefnAst = foundAsts.Cast<FunctionDefinitionAst>().Aggregate((x, y) =>
                 {
                     // of all the function definitions found, return the innermost function definition that contains
                     // `lineNumber`
@@ -570,24 +579,24 @@ public FunctionDefinitionAst GetFunctionDefinitionForHelpComment(
                     return y;
                 });
 
+            // TODO fix help completion in nested functions
             // TODO use tokens to check for non empty character instead of just checking for line offset
             // check if the line number is the first line in the function body
             // check if the line number is the last line in the function body
-            if (foundAst == null)
+            if (funcDefnAst.Body.Extent.StartLineNumber == lineNumber - 1)
             {
-                helpLocation = "before";
-                return GetFunctionDefinitionAtLine(scriptFile, lineNumber + 1);
+                helpLocation = "begin";
+                return funcDefnAst;
             }
 
-            // check if the next line contains a function definition
-            var funcDefnAst = foundAst as FunctionDefinitionAst;
-            if (funcDefnAst.Body.Extent.StartLineNumber == lineNumber - 1)
+            if (funcDefnAst.Body.Extent.EndLineNumber == lineNumber + 1)
             {
-                helpLocation = "begin";
+                helpLocation = "end";
+                return funcDefnAst;
             }
 
-            helpLocation = "end";
-            return funcDefnAst;
+            helpLocation = null;
+            return null;
         }
 
         #endregion