Initial attempt to fix #122 analyzer settings path

This adds a scriptAnalysis.settingsPath setting but uncovers some issues about how to be an absolute path back to the language host from the client.  Depending on where the user "set" this setting a relative path has a different meaning.  If set in .vscode\settings.json then relative probably should be relative to the workspaceRoot.  In the global settings file, it should probably be the extensionInstallDir.  If in the user's settings file, then what ... their home dir?

If we treated this like the other HostPaths then relative would *always* be relative to the extensionInstallDir.  If we could get VSCode to expand ${workspaceRoot} that would allow the user to specify a path in the current workspace folder.

Author: rkeithhill

PSScriptAnalyzerSettings.psd1

@@ -0,0 +1,26 @@
+# The PowerShell Script Analyzer will generate a warning
+# diagnostic record for this file due to a bug -
+# https://github.com/PowerShell/PSScriptAnalyzer/issues/472
+@{
+    # Only diagnostic records of the specified severity will be generated.
+    # Uncomment the following line if you only want Errors and Warnings but
+    # not Information diagnostic records.
+    #Severity = @('Error','Warning')
+
+    # Analyze **only** the following rules. Use IncludeRules when you want
+    # to invoke only a small subset of the defualt rules.
+    IncludeRules = @('PSAvoidDefaultValueSwitchParameter',
+                     'PSMissingModuleManifestField',
+                     'PSReservedCmdletChar',
+                     'PSReservedParams',
+                     'PSShouldProcess',
+                     'PSUseApprovedVerbs',
+                     'PSUseDeclaredVarsMoreThanAssigments')
+
+    # Do not analyze the following rules. Use ExcludeRules when you have
+    # commented out the IncludeRules settings above and want to include all
+    # the default rules except for those you exclude below.
+    # Note: if a rule is in both IncludeRules and ExcludeRules, the rule
+    # will be excluded.
+    #ExcludeRules = @('PSAvoidUsingWriteHost')
+}

package.json

@@ -233,6 +233,11 @@
                     "default": true,
                     "description": "Enables real-time script analysis using PowerShell Script Analyzer."
                 },
+                "powershell.scriptAnalysis.settingsPath": {
+                    "type": "string",
+                    "default": "./PSScriptAnalyzerSettings.psd1",
+                    "description": "Specifies the path to the PowerShell Script Analyzer settings file. The settings file can be used to customize which rules to include or exclude as well as what severity levels to report."
+                },
                 "powershell.developer.editorServicesHostPath": {
                     "type": "string",
                     "default": "../bin/",

src/main.ts

@@ -73,6 +73,8 @@ export function activate(context: vscode.ExtensionContext): void {
 
         try
         {
+            settings.scriptAnalysis.settingsPath = resolveScriptAnalysisSettingsPath(settings);
+
             let serverPath = resolveLanguageServerPath(settings);
             let serverOptions = {
                 run: {
@@ -151,7 +153,7 @@ function resolveLanguageServerPath(settings: settingsManager.ISettings): string
         console.log("    Resolved path to: " + editorServicesHostPath);
     }
     else {
-        // Use the default path in the plugin's 'bin' folder
+        // Use the default path in the extension's 'bin' folder
         editorServicesHostPath =
             path.join(
                 __dirname,
@@ -165,6 +167,35 @@ function resolveLanguageServerPath(settings: settingsManager.ISettings): string
     return editorServicesHostPath;
 }
 
+function resolveScriptAnalysisSettingsPath(settings: settingsManager.ISettings): string {
+    var scriptAnalysisSettingsPath = settings.scriptAnalysis.settingsPath;
+
+    if (scriptAnalysisSettingsPath) {
+        console.log("Found scriptAnalysis.settingsPath from config: " + scriptAnalysisSettingsPath);
+
+        // Make the path absolute if it's not
+        scriptAnalysisSettingsPath =
+            path.resolve(
+                __dirname,
+                '..',
+                scriptAnalysisSettingsPath);
+
+        console.log("    Resolved path to: " + scriptAnalysisSettingsPath);
+    }
+    else {
+        // Use the default path in the extension's 'root' folder
+        scriptAnalysisSettingsPath =
+            path.join(
+                __dirname,
+                '..',
+                'PSScriptAnalyzerSettings.psd1');
+
+        console.log("Using default scriptAnalysis.settingsPath: " + scriptAnalysisSettingsPath);
+    }
+
+    return scriptAnalysisSettingsPath;
+}
+
 function getHostExeName(useX86Host: boolean): string {
     // The useX86Host setting is only relevant on 64-bit OS
     var is64BitOS = process.env.hasOwnProperty('PROCESSOR_ARCHITEW6432');

src/settings.ts

@@ -8,6 +8,7 @@ import vscode = require('vscode');
 
 export interface IScriptAnalysisSettings {
     enable?: boolean
+    settingsPath: string
 }
 
 export interface IDeveloperSettings {
@@ -26,7 +27,8 @@ export function load(myPluginId: string): ISettings {
     let configuration = vscode.workspace.getConfiguration(myPluginId);
 
     let defaultScriptAnalysisSettings = {
-        enable: true
+        enable: true,
+        settingsPath: "./PSScriptAnalyzerSettings.psd1"
     };
 
     let defaultDeveloperSettings = {