Add xml comment in AnalysisService class

Author: Kapil Borle

src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs

@@ -199,18 +199,12 @@ private async Task HandleSetPSSARulesRequest(
             }
 
             var sendresult = requestContext.SendResult(null);
-            // send the file uri from the client
-            // retrieve the file
-            // requestcontext is the eventcontext
             var scripFile = editorSession.Workspace.GetFile((string)dynParams.filepath);
             await RunScriptDiagnostics(
                     new ScriptFile[] { scripFile },
                         editorSession,
                         requestContext.SendEvent);
-
             await sendresult;
-
-            //await requestContext.SendResult(null);
         }
 
         private async Task HandleGetPSSARulesRequest(

src/PowerShellEditorServices/Analysis/AnalysisService.cs

@@ -42,24 +42,15 @@ public class AnalysisService : IDisposable
             "PSMisleadingBacktick",
         };
 
-        private List<string> activeRules;
-
         #endregion // Private Fields
 
 
         #region Properties
 
-        public string[] ActiveRules
-        {
-            get
-            {
-                return activeRules != null ? activeRules.ToArray() : null;
-            }
-            set
-            {
-                activeRules = new List<string>(value); // TODO check the argument
-            }
-        }
+        /// <summary>
+        /// Set of PSScriptAnalyzer rules used for analysis
+        /// </summary>
+        public string[] ActiveRules { get; set; }
 
         /// <summary>
         /// Gets or sets the path to a settings file (.psd1)
@@ -89,7 +80,7 @@ public AnalysisService(IConsoleHost consoleHost, string settingsPath = null)
                 this.analysisRunspace = RunspaceFactory.CreateRunspace(InitialSessionState.CreateDefault2());
                 this.analysisRunspace.ThreadOptions = PSThreadOptions.ReuseThread;
                 this.analysisRunspace.Open();
-                activeRules = new List<string>(IncludedRules);
+                ActiveRules = IncludedRules.ToArray();
                 InitializePSScriptAnalyzer();
             }
             catch (Exception e)
@@ -141,18 +132,8 @@ public ScriptFileMarker[] GetSemanticMarkers(ScriptFile file)
         }
 
         /// <summary>
-        /// Disposes the runspace being used by the analysis service.
+        /// Returns a list of builtin-in PSScriptAnalyzer rules
         /// </summary>
-        public void Dispose()
-        {
-            if (this.analysisRunspace != null)
-            {
-                this.analysisRunspace.Close();
-                this.analysisRunspace.Dispose();
-                this.analysisRunspace = null;
-            }
-        }
-
         public IEnumerable<string> GetPSScriptAnalyzerRules()
         {
             List<string> ruleNames = new List<string>();
@@ -162,7 +143,7 @@ public IEnumerable<string> GetPSScriptAnalyzerRules()
                 {
                     ps.Runspace = this.analysisRunspace;
                     var ruleObjects = ps.AddCommand("Get-ScriptAnalyzerRule").Invoke();
-                    foreach(var rule in ruleObjects)
+                    foreach (var rule in ruleObjects)
                     {
                         ruleNames.Add((string)rule.Members["RuleName"].Value);
                     }
@@ -172,6 +153,19 @@ public IEnumerable<string> GetPSScriptAnalyzerRules()
             return ruleNames;
         }
 
+        /// <summary>
+        /// Disposes the runspace being used by the analysis service.
+        /// </summary>
+        public void Dispose()
+        {
+            if (this.analysisRunspace != null)
+            {
+                this.analysisRunspace.Close();
+                this.analysisRunspace.Dispose();
+                this.analysisRunspace = null;
+            }
+        }
+
         #endregion // public methods
 
         #region Private Methods
@@ -280,7 +274,7 @@ private IEnumerable<PSObject> GetDiagnosticRecords(ScriptFile file)
                     }
                     else
                     {
-                        powerShell.AddParameter("IncludeRule", activeRules.ToArray());
+                        powerShell.AddParameter("IncludeRule", ActiveRules);
                     }
 
                     diagnosticRecords = powerShell.Invoke();