Add handler to return PSSA rules

Author: Kapil Borle

src/PowerShellEditorServices.Protocol/LanguageServer/GetPSSARulesRequest.cs

@@ -0,0 +1,16 @@
+//
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+//
+
+using Microsoft.PowerShell.EditorServices.Protocol.MessageProtocol;
+
+namespace Microsoft.PowerShell.EditorServices.Protocol.LanguageServer
+{
+    class GetPSSARulesRequest
+    {
+        public static readonly
+            RequestType<string, object> Type =
+            RequestType<string, object>.Create("powerShell/GetPSSARules");
+    }
+}

src/PowerShellEditorServices.Protocol/PowerShellEditorServices.Protocol.csproj

@@ -55,6 +55,7 @@
     <Compile Include="DebugAdapter\ContinueRequest.cs" />
     <Compile Include="DebugAdapter\SetFunctionBreakpointsRequest.cs" />
     <Compile Include="DebugAdapter\SetVariableRequest.cs" />
+    <Compile Include="LanguageServer\GetPSSARulesRequest.cs" />
     <Compile Include="LanguageServer\EditorCommands.cs" />
     <Compile Include="LanguageServer\CodeAction.cs" />
     <Compile Include="LanguageServer\FindModuleRequest.cs" />

src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs

@@ -109,6 +109,8 @@ protected override void Initialize()
 
             this.SetRequestHandler(DebugAdapterMessages.EvaluateRequest.Type, this.HandleEvaluateRequest);
 
+            this.SetRequestHandler(GetPSSARulesRequest.Type, this.HandleGetPSSARulesRequest);
+
             // Initialize the extension service
             // TODO: This should be made awaited once Initialize is async!
             this.editorSession.ExtensionService.Initialize(
@@ -180,6 +182,22 @@ protected async Task HandleShowOnlineHelpRequest(
             await requestContext.SendResult(null);
         }
 
+        private async Task HandleGetPSSARulesRequest(
+            object param,
+            RequestContext<object> requestContext)
+        {
+            List<string> ruleList = new List<string>();
+            if (editorSession.AnalysisService != null)
+            {
+                var ruleNames = editorSession.AnalysisService.GetPSScriptAnalyzerRules();
+                foreach (var ruleName in ruleNames)
+                {
+                    ruleList.Add(ruleName);
+                }
+            }
+            await requestContext.SendResult(ruleList);
+        }
+
         private async Task HandleInstallModuleRequest(
             string moduleName,
             RequestContext<object> requestContext

src/PowerShellEditorServices/Analysis/AnalysisService.cs

@@ -142,6 +142,25 @@ public void Dispose()
             }
         }
 
+        public IEnumerable<string> GetPSScriptAnalyzerRules()
+        {
+            List<string> ruleNames = new List<string>();
+            if (scriptAnalyzerModuleInfo != null)
+            {
+                using (var ps = System.Management.Automation.PowerShell.Create())
+                {
+                    ps.Runspace = this.analysisRunspace;
+                    var ruleObjects = ps.AddCommand("Get-ScriptAnalyzerRule").Invoke();
+                    foreach(var rule in ruleObjects)
+                    {
+                        ruleNames.Add((string)rule.Members["RuleName"].Value);
+                    }
+                }
+            }
+
+            return ruleNames;
+        }
+
         #endregion // public methods
 
         #region Private Methods
@@ -207,23 +226,16 @@ private void EnumeratePSScriptAnalyzerRules()
         {
             if (scriptAnalyzerModuleInfo != null)
             {
-                using (var ps = System.Management.Automation.PowerShell.Create())
+                var rules = GetPSScriptAnalyzerRules();
+                var sb = new StringBuilder();
+                sb.AppendLine("Available PSScriptAnalyzer Rules:");
+                foreach (var rule in rules)
                 {
-                    ps.Runspace = this.analysisRunspace;
-
-                    var rules = ps.AddCommand("Get-ScriptAnalyzerRule").Invoke();
-                    var sb = new StringBuilder();
-                    sb.AppendLine("Available PSScriptAnalyzer Rules:");
-
-                    foreach (var rule in rules)
-                    {
-                        sb.AppendLine((string)rule.Members["RuleName"].Value);
-                    }
-
-                    Logger.Write(LogLevel.Verbose, sb.ToString());
+                    sb.AppendLine(rule);
                 }
-            }
 
+                Logger.Write(LogLevel.Verbose, sb.ToString());
+            }
         }
 
         private void InitializePSScriptAnalyzer()

src/PowerShellEditorServices/Nano.PowerShellEditorServices.csproj

@@ -36,6 +36,9 @@
     <DocumentationFile>bin\Release\Microsoft.PowerShell.EditorServices.XML</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
+    <Compile Include="..\PowerShellEditorServices.Protocol\LanguageServer\GetPSSARulesRequest.cs">
+      <Link>GetPSSARulesRequest.cs</Link>
+    </Compile>
     <Compile Include="Analysis\AnalysisOutputWriter.cs" />
     <Compile Include="Analysis\AnalysisService.cs" />
     <Compile Include="Console\ChoicePromptHandler.cs" />