Add methods to help with code formatting

Author: Kapil Borle

src/PowerShellEditorServices.Protocol/LanguageServer/ScriptFileMarkersRequest.cs

@@ -0,0 +1,27 @@
+//
+// 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 ScriptFileMarkersRequest
+    {
+        public static readonly
+            RequestType<ScriptFileMarkerRequestParams, ScriptFileMarkerRequestResultParams> Type =
+                RequestType<ScriptFileMarkerRequestParams, ScriptFileMarkerRequestResultParams>.Create("powerShell/getScriptFileMarkers");
+    }
+
+    class ScriptFileMarkerRequestParams
+    {
+        public string filePath;
+        public string[] rules;
+    }
+
+    class ScriptFileMarkerRequestResultParams
+    {
+        public ScriptFileMarker[] markers;
+    }
+}

src/PowerShellEditorServices.Protocol/PowerShellEditorServices.Protocol.csproj

@@ -63,6 +63,7 @@
     <Compile Include="LanguageServer\InstallModuleRequest.cs" />
     <Compile Include="LanguageServer\PowerShellVersionRequest.cs" />
     <Compile Include="LanguageServer\RunspaceChanged.cs" />
+    <Compile Include="LanguageServer\ScriptFileMarkersRequest.cs" />
     <Compile Include="LanguageServer\SetPSSARulesRequest.cs" />
     <Compile Include="LanguageServer\ProjectTemplate.cs" />
     <Compile Include="MessageProtocol\Channel\NamedPipeClientChannel.cs" />

src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs

@@ -123,6 +123,8 @@ protected override void Initialize()
             this.SetRequestHandler(GetPSSARulesRequest.Type, this.HandleGetPSSARulesRequest);
             this.SetRequestHandler(SetPSSARulesRequest.Type, this.HandleSetPSSARulesRequest);
 
+            this.SetRequestHandler(ScriptFileMarkersRequest.Type, this.HandleScriptFileMarkersRequest);
+
             // Initialize the extension service
             // TODO: This should be made awaited once Initialize is async!
             this.editorSession.ExtensionService.Initialize(
@@ -230,6 +232,21 @@ await RunScriptDiagnostics(
             await sendresult;
         }
 
+        private async Task HandleScriptFileMarkersRequest(
+            ScriptFileMarkerRequestParams requestParams,
+            RequestContext<ScriptFileMarkerRequestResultParams> requestContext)
+        {
+            var markers = editorSession.AnalysisService.GetSemanticMarkers(
+                editorSession.Workspace.GetFile(requestParams.filePath),
+                requestParams.rules,
+                null);
+            markers = markers.Reverse().ToArray();
+            //markers.OrderByDescending(x => x.Correction.Edits[0].StartLineNumber).ToArray()
+            await requestContext.SendResult(new ScriptFileMarkerRequestResultParams {
+                markers = markers
+            });
+        }
+
         private async Task HandleGetPSSARulesRequest(
             object param,
             RequestContext<object> requestContext)

src/PowerShellEditorServices/Analysis/AnalysisService.cs

@@ -127,13 +127,7 @@ public AnalysisService(IConsoleHost consoleHost, string settingsPath = null)
 
         #region Public Methods
 
-        /// <summary>
-        /// Performs semantic analysis on the given ScriptFile and returns
-        /// an array of ScriptFileMarkers.
-        /// </summary>
-        /// <param name="file">The ScriptFile which will be analyzed for semantic markers.</param>
-        /// <returns>An array of ScriptFileMarkers containing semantic analysis results.</returns>
-        public ScriptFileMarker[] GetSemanticMarkers(ScriptFile file)
+        public ScriptFileMarker[] GetSemanticMarkers(ScriptFile file, string[] rules, string settingsPath)
         {
             if (this.scriptAnalyzerModuleInfo != null && file.IsAnalysisEnabled)
             {
@@ -145,7 +139,7 @@ public ScriptFileMarker[] GetSemanticMarkers(ScriptFile file)
                         () =>
                         {
                             return
-                                 GetDiagnosticRecords(file)
+                                 GetDiagnosticRecords(file, rules, settingsPath)
                                 .Select(ScriptFileMarker.FromDiagnosticRecord)
                                 .ToArray();
                         },
@@ -162,6 +156,17 @@ public ScriptFileMarker[] GetSemanticMarkers(ScriptFile file)
             }
         }
 
+        /// <summary>
+        /// Performs semantic analysis on the given ScriptFile and returns
+        /// an array of ScriptFileMarkers.
+        /// </summary>
+        /// <param name="file">The ScriptFile which will be analyzed for semantic markers.</param>
+        /// <returns>An array of ScriptFileMarkers containing semantic analysis results.</returns>
+        public ScriptFileMarker[] GetSemanticMarkers(ScriptFile file)
+        {
+            return GetSemanticMarkers(file, activeRules, settingsPath);
+        }
+
         /// <summary>
         /// Returns a list of builtin-in PSScriptAnalyzer rules
         /// </summary>
@@ -291,6 +296,11 @@ private void InitializePSScriptAnalyzer()
         }
 
         private IEnumerable<PSObject> GetDiagnosticRecords(ScriptFile file)
+        {
+            return GetDiagnosticRecords(file, this.activeRules, this.settingsPath);
+        }
+
+        private IEnumerable<PSObject> GetDiagnosticRecords(ScriptFile file, string[] rules, string settingsPath)
         {
             IEnumerable<PSObject> diagnosticRecords = Enumerable.Empty<PSObject>();
 
@@ -310,13 +320,13 @@ private IEnumerable<PSObject> GetDiagnosticRecords(ScriptFile file)
                             .AddParameter("ScriptDefinition", file.Contents);
 
                         // Use a settings file if one is provided, otherwise use the default rule list.
-                        if (!string.IsNullOrWhiteSpace(this.SettingsPath))
+                        if (!string.IsNullOrWhiteSpace(settingsPath))
                         {
-                            powerShell.AddParameter("Settings", this.SettingsPath);
+                            powerShell.AddParameter("Settings", settingsPath);
                         }
                         else
                         {
-                            powerShell.AddParameter("IncludeRule", activeRules);
+                            powerShell.AddParameter("IncludeRule", rules);
                         }
 
                         diagnosticRecords = powerShell.Invoke();

src/PowerShellEditorServices/Nano.PowerShellEditorServices.csproj

@@ -39,6 +39,9 @@
     <Compile Include="..\PowerShellEditorServices.Protocol\LanguageServer\GetPSSARulesRequest.cs">
       <Link>GetPSSARulesRequest.cs</Link>
     </Compile>
+    <Compile Include="..\PowerShellEditorServices.Protocol\LanguageServer\ScriptFileMarkersRequest.cs">
+      <Link>ScriptFileMarkersRequest.cs</Link>
+    </Compile>
     <Compile Include="..\PowerShellEditorServices.Protocol\LanguageServer\SetPSSARulesRequest.cs">
       <Link>SetPSSARulesRequest.cs</Link>
     </Compile>