Move rule settings related code to AnalysisService

Author: Kapil Borle

src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs

@@ -1089,20 +1089,15 @@ protected async Task HandleCommentHelpRequest(
 
             if (functionDefinitionAst != null)
             {
-                var settings = new Dictionary<string, Hashtable>();
-                var ruleSettings = new Hashtable();
-                ruleSettings.Add("ExportedOnly", false);
-                ruleSettings.Add("Enable", true);
-                ruleSettings.Add("BlockComment", requestParams.BlockComment);
-                ruleSettings.Add("VSCodeSnippetCorrection", true);
-                ruleSettings.Add("Placement", "before");
-                settings.Add("PSProvideCommentHelp", ruleSettings);
-                var pssaSettings = AnalysisService.GetPSSASettingsHashtable(settings);
-
-                // 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,
-                    pssaSettings);
+                    AnalysisService.GetCommentHelpRuleSettings(
+                        true,
+                        false,
+                        requestParams.BlockComment,
+                        true,
+                        "before"));
 
                 var analysisResult = analysisResults?.FirstOrDefault(x =>
                 {

src/PowerShellEditorServices/Analysis/AnalysisService.cs

@@ -141,6 +141,54 @@ public AnalysisService(IConsoleHost consoleHost, string settingsPath = null)
 
         #region Public Methods
 
+        /// <summary>
+        /// Get PSScriptAnalyzer settings hashtable for PSProvideCommentHelp rule.
+        /// </summary>
+        /// <param name="enable">Enable the rule.</param>
+        /// <param name="exportedOnly">Analyze only exported functions/cmdlets.</param>
+        /// <param name="blockComment">Use block comment or line comment.</param>
+        /// <param name="vscodeSnippetCorrection">Return a vscode snipped correction should be returned.</param>
+        /// <param name="placement">Place comment help at the given location relative to the function definition.</param>
+        /// <returns>A PSScriptAnalyzer settings hashtable.</returns>
+        public static Hashtable GetCommentHelpRuleSettings(
+            bool enable,
+            bool exportedOnly,
+            bool blockComment,
+            bool vscodeSnippetCorrection,
+            string placement)
+        {
+            var settings = new Dictionary<string, Hashtable>();
+            var ruleSettings = new Hashtable();
+            ruleSettings.Add("Enable", enable);
+            ruleSettings.Add("ExportedOnly", exportedOnly);
+            ruleSettings.Add("BlockComment", blockComment);
+            ruleSettings.Add("VSCodeSnippetCorrection", vscodeSnippetCorrection);
+            ruleSettings.Add("Placement", placement);
+            settings.Add("PSProvideCommentHelp", ruleSettings);
+            return GetPSSASettingsHashtable(settings);
+        }
+
+        /// <summary>
+        /// Construct a PSScriptAnalyzer settings hashtable
+        /// </summary>
+        /// <param name="ruleSettingsMap">A settings hashtable</param>
+        /// <returns></returns>
+        public static Hashtable GetPSSASettingsHashtable(IDictionary<string, Hashtable> ruleSettingsMap)
+        {
+            var hashtable = new Hashtable();
+            var ruleSettingsHashtable = new Hashtable();
+
+            hashtable["IncludeRules"] = ruleSettingsMap.Keys.ToArray<object>();
+            hashtable["Rules"] = ruleSettingsHashtable;
+
+            foreach (var kvp in ruleSettingsMap)
+            {
+                ruleSettingsHashtable.Add(kvp.Key, kvp.Value);
+            }
+
+            return hashtable;
+        }
+
         /// <summary>
         /// Perform semantic analysis on the given ScriptFile and returns
         /// an array of ScriptFileMarkers.
@@ -181,27 +229,6 @@ public IEnumerable<string> GetPSScriptAnalyzerRules()
             return ruleNames;
         }
 
-        /// <summary>
-        /// Construct a PSScriptAnalyzer settings hashtable
-        /// </summary>
-        /// <param name="ruleSettingsMap">A settings hashtable</param>
-        /// <returns></returns>
-        public static Hashtable GetPSSASettingsHashtable(IDictionary<string, Hashtable> ruleSettingsMap)
-        {
-            var hashtable = new Hashtable();
-            var ruleSettingsHashtable = new Hashtable();
-
-            hashtable["IncludeRules"] = ruleSettingsMap.Keys.ToArray<object>();
-            hashtable["Rules"] = ruleSettingsHashtable;
-
-            foreach (var kvp in ruleSettingsMap)
-            {
-                ruleSettingsHashtable.Add(kvp.Key, kvp.Value);
-            }
-
-            return hashtable;
-        }
-
         /// <summary>
         /// Disposes the runspace being used by the analysis service.
         /// </summary>

src/PowerShellEditorServices/Language/LanguageService.cs

@@ -522,6 +522,12 @@ public ScriptRegion FindSmallestStatementAstRegion(
             return ScriptRegion.Create(ast.Extent);
         }
 
+        /// <summary>
+        /// Gets the function defined on a given line.
+        /// </summary>
+        /// <param name="scriptFile">Open script file.</param>
+        /// <param name="lineNumber">The 1 based line on which to look for function definition.</param>
+        /// <returns>If found, returns the function definition on the given line. Otherwise, returns null.</returns>
         public FunctionDefinitionAst GetFunctionDefinitionAtLine(
             ScriptFile scriptFile,
             int lineNumber)