Supports specifying a settings path to use with script analyzer.

rkeithhill · rkeithhill · commit 36993109cae4 · 2016-03-27T15:03:39.000-06:00
Work in progress.  The setting only works once when the extension is first loaded and then only for the global location.  More work to do here  to figure out how get workspace relative paths work.
diff --git a/src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs b/src/PowerShellEditorServices.Protocol/Server/LanguageServer.cs
@@ -6,7 +6,6 @@
 using Microsoft.PowerShell.EditorServices.Protocol.LanguageServer;
 using Microsoft.PowerShell.EditorServices.Protocol.MessageProtocol;
 using Microsoft.PowerShell.EditorServices.Protocol.MessageProtocol.Channel;
-using Microsoft.PowerShell.EditorServices.Protocol.Messages;
 using Microsoft.PowerShell.EditorServices.Utility;
 using System;
 using System.Collections.Generic;
@@ -292,10 +291,20 @@ protected async Task HandleDidChangeConfigurationNotification(
         {
             bool oldScriptAnalysisEnabled =
                 this.currentSettings.ScriptAnalysis.Enable.HasValue;
+            string oldScriptAnalysisSettingsPath =
+                this.currentSettings.ScriptAnalysis.SettingsPath;
 
             this.currentSettings.Update(
                 configChangeParams.Settings.Powershell);
 
+            string newSettingsPath = this.currentSettings.ScriptAnalysis.SettingsPath;
+            
+            // If there is a new settings file path, restart the analyzer with the new settigs.
+            if (!(oldScriptAnalysisSettingsPath?.Equals(newSettingsPath, StringComparison.OrdinalIgnoreCase) ?? false))
+            {
+                this.editorSession.RestartAnalysisService(newSettingsPath);
+            }
+
             if (oldScriptAnalysisEnabled != this.currentSettings.ScriptAnalysis.Enable)
             {
                 // If the user just turned off script analysis, send a diagnostics
diff --git a/src/PowerShellEditorServices.Protocol/Server/LanguageServerSettings.cs b/src/PowerShellEditorServices.Protocol/Server/LanguageServerSettings.cs
@@ -27,6 +27,8 @@ public class ScriptAnalysisSettings
     {
         public bool? Enable { get; set; }
 
+        public string SettingsPath { get; set; }
+
         public ScriptAnalysisSettings()
         {
             this.Enable = true;
@@ -37,6 +39,7 @@ public void Update(ScriptAnalysisSettings settings)
             if (settings != null)
             {
                 this.Enable = settings.Enable;
+                this.SettingsPath = settings.SettingsPath;
             }
         }
     }
diff --git a/src/PowerShellEditorServices/Analysis/AnalysisOutputWriter.cs b/src/PowerShellEditorServices/Analysis/AnalysisOutputWriter.cs
@@ -3,8 +3,10 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 //
 
-using Microsoft.Windows.PowerShell.ScriptAnalyzer;
+using System;
 using System.Management.Automation;
+using Microsoft.PowerShell.EditorServices.Console;
+using Microsoft.Windows.PowerShell.ScriptAnalyzer;
 
 namespace Microsoft.PowerShell.EditorServices
 {
@@ -14,31 +16,36 @@ namespace Microsoft.PowerShell.EditorServices
     /// </summary>
     internal class AnalysisOutputWriter : IOutputWriter
     {
+        private IConsoleHost consoleHost;
+
+        public AnalysisOutputWriter(IConsoleHost consoleHost)
+        {
+            this.consoleHost = consoleHost;
+        }
+
         #region IOutputWriter Implementation
 
         void IOutputWriter.WriteError(ErrorRecord error)
         {
-            // TODO: Find a way to trace out this output!
+            this.consoleHost?.WriteOutput(error.ToString(), true, OutputType.Error, ConsoleColor.Red, ConsoleColor.Black);
         }
 
         void IOutputWriter.WriteWarning(string message)
         {
-            // TODO: Find a way to trace out this output!
+            this.consoleHost?.WriteOutput(message, true, OutputType.Warning, ConsoleColor.Yellow, ConsoleColor.Black);
         }
 
         void IOutputWriter.WriteVerbose(string message)
         {
-            // TODO: Find a way to trace out this output!
         }
 
         void IOutputWriter.WriteDebug(string message)
         {
-            // TODO: Find a way to trace out this output!
         }
 
         void IOutputWriter.ThrowTerminatingError(ErrorRecord record)
         {
-            // TODO: Find a way to trace out this output!
+            this.consoleHost?.WriteOutput(record.ToString(), true, OutputType.Error, ConsoleColor.Red, ConsoleColor.Black);
         }
 
         #endregion
diff --git a/src/PowerShellEditorServices/Analysis/AnalysisService.cs b/src/PowerShellEditorServices/Analysis/AnalysisService.cs
@@ -11,6 +11,7 @@
 using System.Management.Automation.Runspaces;
 using System.Threading;
 using System.Threading.Tasks;
+using Microsoft.PowerShell.EditorServices.Console;
 
 namespace Microsoft.PowerShell.EditorServices
 {
@@ -26,11 +27,10 @@ public class AnalysisService : IDisposable
         private ScriptAnalyzer scriptAnalyzer;
 
         /// <summary>
-        /// Defines the list of Script Analyzer rules to include by default.
-        /// In the future, a default rule set from Script Analyzer may be used.
+        /// Defines the list of Script Analyzer rules to include by default if
+        /// no settings file can be found.
         /// </summary>
-        private static readonly string[] IncludedRules = new string[]
-        {
+        private static readonly string[] IncludedRules = {
             "PSUseApprovedVerbs",
             "PSReservedCmdletChar",
             "PSReservedParams",
@@ -47,7 +47,10 @@ public class AnalysisService : IDisposable
         /// <summary>
         /// Creates an instance of the AnalysisService class.
         /// </summary>
-        public AnalysisService()
+        /// <param name="consoleHost">An object that implements IConsoleHost in which to write errors/warnings 
+        /// from analyzer.</param>
+        /// <param name="settingsPath">Path to a PSScriptAnalyzer settings file.</param>
+        public AnalysisService(IConsoleHost consoleHost, string settingsPath = null)
         {
             try
             {
@@ -63,9 +66,10 @@ public AnalysisService()
 
                 this.scriptAnalyzer.Initialize(
                     this.analysisRunspace,
-                    new AnalysisOutputWriter(),
-                    includeRuleNames: IncludedRules,
-                    includeDefaultRules: true);
+                    new AnalysisOutputWriter(consoleHost),
+                    includeRuleNames: settingsPath == null ? IncludedRules : null,
+                    includeDefaultRules: true,
+                    profile: settingsPath);
             }
             catch (FileNotFoundException)
             {
diff --git a/src/PowerShellEditorServices/Session/EditorSession.cs b/src/PowerShellEditorServices/Session/EditorSession.cs
@@ -5,12 +5,7 @@
 
 using Microsoft.PowerShell.EditorServices.Console;
 using Microsoft.PowerShell.EditorServices.Utility;
-using System;
 using System.IO;
-using System.Management.Automation;
-using System.Management.Automation.Runspaces;
-using System.Reflection;
-using System.Threading;
 
 namespace Microsoft.PowerShell.EditorServices
 {
@@ -68,6 +63,24 @@ public void StartSession()
             this.DebugService = new DebugService(this.PowerShellContext);
             this.ConsoleService = new ConsoleService(this.PowerShellContext);
 
+            this.InstantiateAnalysisService();
+
+            // Create a workspace to contain open files
+            this.Workspace = new Workspace(this.PowerShellContext.PowerShellVersion);
+        }
+
+        /// <summary>
+        /// Restarts the AnalysisService so it can be configured with a new settings file.
+        /// </summary>
+        /// <param name="settingsPath">Path to the settings file.</param>
+        public void RestartAnalysisService(string settingsPath)
+        {
+            this.AnalysisService?.Dispose();
+            InstantiateAnalysisService(settingsPath);
+        }
+
+        internal void InstantiateAnalysisService(string settingsPath = null)
+        {
             // Only enable the AnalysisService if the machine has PowerShell
             // v5 installed.  Script Analyzer works on earlier PowerShell
             // versions but our hard dependency on their binaries complicates
@@ -81,7 +94,7 @@ public void StartSession()
                 // Script Analyzer binaries are not included.
                 try
                 {
-                    this.AnalysisService = new AnalysisService();
+                    this.AnalysisService = new AnalysisService(this.PowerShellContext.ConsoleHost, settingsPath);
                 }
                 catch (FileNotFoundException)
                 {
@@ -97,9 +110,6 @@ public void StartSession()
                     "Script Analyzer cannot be loaded due to unsupported PowerShell version " +
                     this.PowerShellContext.PowerShellVersion.ToString());
             }
-
-            // Create a workspace to contain open files
-            this.Workspace = new Workspace(this.PowerShellContext.PowerShellVersion);
         }
 
         #endregion

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,8 @@ public class ScriptAnalysisSettings`
`27`	`27`	`{`
`28`	`28`	`public bool? Enable { get; set; }`
`29`	`29`
	`30`	`+ public string SettingsPath { get; set; }`
	`31`	`+`
`30`	`32`	`public ScriptAnalysisSettings()`
`31`	`33`	`{`
`32`	`34`	`this.Enable = true;`
`@@ -37,6 +39,7 @@ public void Update(ScriptAnalysisSettings settings)`
`37`	`39`	`if (settings != null)`
`38`	`40`	`{`
`39`	`41`	`this.Enable = settings.Enable;`
	`42`	`+ this.SettingsPath = settings.SettingsPath;`
`40`	`43`	`}`
`41`	`44`	`}`
`42`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,10 @@`
`3`	`3`	`// Licensed under the MIT license. See LICENSE file in the project root for full license information.`
`4`	`4`	`//`
`5`	`5`
`6`		`-using Microsoft.Windows.PowerShell.ScriptAnalyzer;`
	`6`	`+using System;`
`7`	`7`	`using System.Management.Automation;`
	`8`	`+using Microsoft.PowerShell.EditorServices.Console;`
	`9`	`+using Microsoft.Windows.PowerShell.ScriptAnalyzer;`
`8`	`10`
`9`	`11`	`namespace Microsoft.PowerShell.EditorServices`
`10`	`12`	`{`
`@@ -14,31 +16,36 @@ namespace Microsoft.PowerShell.EditorServices`
`14`	`16`	`/// </summary>`
`15`	`17`	`internal class AnalysisOutputWriter : IOutputWriter`
`16`	`18`	`{`
	`19`	`+ private IConsoleHost consoleHost;`
	`20`	`+`
	`21`	`+ public AnalysisOutputWriter(IConsoleHost consoleHost)`
	`22`	`+ {`
	`23`	`+ this.consoleHost = consoleHost;`
	`24`	`+ }`
	`25`	`+`
`17`	`26`	`#region IOutputWriter Implementation`
`18`	`27`
`19`	`28`	`void IOutputWriter.WriteError(ErrorRecord error)`
`20`	`29`	`{`
`21`		`- // TODO: Find a way to trace out this output!`
	`30`	`+ this.consoleHost?.WriteOutput(error.ToString(), true, OutputType.Error, ConsoleColor.Red, ConsoleColor.Black);`
`22`	`31`	`}`
`23`	`32`
`24`	`33`	`void IOutputWriter.WriteWarning(string message)`
`25`	`34`	`{`
`26`		`- // TODO: Find a way to trace out this output!`
	`35`	`+ this.consoleHost?.WriteOutput(message, true, OutputType.Warning, ConsoleColor.Yellow, ConsoleColor.Black);`
`27`	`36`	`}`
`28`	`37`
`29`	`38`	`void IOutputWriter.WriteVerbose(string message)`
`30`	`39`	`{`
`31`		`- // TODO: Find a way to trace out this output!`
`32`	`40`	`}`
`33`	`41`
`34`	`42`	`void IOutputWriter.WriteDebug(string message)`
`35`	`43`	`{`
`36`		`- // TODO: Find a way to trace out this output!`
`37`	`44`	`}`
`38`	`45`
`39`	`46`	`void IOutputWriter.ThrowTerminatingError(ErrorRecord record)`
`40`	`47`	`{`
`41`		`- // TODO: Find a way to trace out this output!`
	`48`	`+ this.consoleHost?.WriteOutput(record.ToString(), true, OutputType.Error, ConsoleColor.Red, ConsoleColor.Black);`
`42`	`49`	`}`
`43`	`50`
`44`	`51`	`#endregion`