Fix up ISettings

* Stop exporting things unused elsewhere
* Remove unnecessary getWorkspaceSettingsWithDefaults
* Make `settings.ts` and `package.json` defaults consistent

Author: andyleejordan

package.json

@@ -573,18 +573,20 @@
         },
         "powershell.powerShellAdditionalExePaths": {
           "type": "object",
+          "default": null,
           "description": "Specifies a list of versionName / exePath pairs where exePath points to a non-standard install location for PowerShell and versionName can be used to reference this path with the powershell.powerShellDefaultVersion setting.",
           "additionalProperties": {
             "type": "string"
           }
         },
         "powershell.powerShellDefaultVersion": {
           "type": "string",
+          "default": null,
           "description": "Specifies the PowerShell version name, as displayed by the 'PowerShell: Show Session Menu' command, used when the extension loads e.g \"Windows PowerShell (x86)\" or \"PowerShell Core 7 (x64)\". You can specify additional PowerShell executables by using the \"powershell.powerShellAdditionalExePaths\" setting."
         },
         "powershell.powerShellExePath": {
           "type": "string",
-          "default": "",
+          "default": null,
           "scope": "machine",
           "description": "REMOVED: Please use the \"powershell.powerShellAdditionalExePaths\" setting instead.",
           "deprecationMessage": "Please use the \"powershell.powerShellAdditionalExePaths\" setting instead."
@@ -811,6 +813,7 @@
         },
         "powershell.integratedConsole.forceClearScrollbackBuffer": {
           "type": "boolean",
+          "default": false,
           "description": "Use the vscode API to clear the terminal since that's the only reliable way to clear the scrollback buffer. Turn this on if you're used to 'Clear-Host' clearing scroll history as well as clear-terminal-via-lsp."
         },
         "powershell.integratedConsole.suppressStartupBanner": {
@@ -825,6 +828,7 @@
         },
         "powershell.developer.bundledModulesPath": {
           "type": "string",
+          "default": "../../PowerShellEditorServices/module",
           "description": "Specifies an alternate path to the folder containing modules that are bundled with the PowerShell extension (i.e. PowerShell Editor Services, PSScriptAnalyzer, Plaster)"
         },
         "powershell.developer.editorServicesLogLevel": {

src/logging.ts

@@ -5,6 +5,7 @@ import utils = require("./utils");
 import os = require("os");
 import vscode = require("vscode");
 
+// NOTE: This is not a string enum because the order is used for comparison.
 export enum LogLevel {
     Diagnostic,
     Verbose,

src/session.ts

@@ -575,9 +575,7 @@ Type 'help' to get help.
             editorServicesArgs += "-WaitForDebugger ";
         }
 
-        if (this.sessionSettings.developer.editorServicesLogLevel) {
-            editorServicesArgs += `-LogLevel '${this.sessionSettings.developer.editorServicesLogLevel}' `;
-        }
+        editorServicesArgs += `-LogLevel '${this.sessionSettings.developer.editorServicesLogLevel}' `;
 
         return editorServicesArgs;
     }

src/settings.ts

@@ -6,18 +6,53 @@ import utils = require("./utils");
 import os = require("os");
 import { Logger } from "./logging";
 
+export interface ISettings {
+    powerShellAdditionalExePaths: IPowerShellAdditionalExePathSettings | undefined;
+    powerShellDefaultVersion: string | undefined;
+    // This setting is no longer used but is here to assist in cleaning up the users settings.
+    powerShellExePath: string | undefined;
+    promptToUpdatePowerShell: boolean;
+    bundledModulesPath: string;
+    startAsLoginShell: IStartAsLoginShellSettings;
+    startAutomatically: boolean;
+    enableProfileLoading: boolean;
+    helpCompletion: string;
+    scriptAnalysis: IScriptAnalysisSettings;
+    debugging: IDebuggingSettings;
+    developer: IDeveloperSettings;
+    codeFolding: ICodeFoldingSettings;
+    codeFormatting: ICodeFormattingSettings;
+    integratedConsole: IIntegratedConsoleSettings;
+    bugReporting: IBugReportingSettings;
+    sideBar: ISideBarSettings;
+    pester: IPesterSettings;
+    buttons: IButtonSettings;
+    cwd: string | undefined;
+    enableReferencesCodeLens: boolean;
+    analyzeOpenDocumentsOnly: boolean;
+}
+
 enum CodeFormattingPreset {
-    Custom,
-    Allman,
-    OTBS,
-    Stroustrup,
+    Custom = "Custom",
+    Allman = "Allman",
+    OTBS = "OTBS",
+    Stroustrup = "Stroustrup",
 }
 
 enum PipelineIndentationStyle {
-    IncreaseIndentationForFirstPipeline,
-    IncreaseIndentationAfterEveryPipeline,
-    NoIndentation,
-    None,
+    IncreaseIndentationForFirstPipeline = "IncreaseIndentationForFirstPipeline",
+    IncreaseIndentationAfterEveryPipeline = "IncreaseIndentationAfterEveryPipeline",
+    NoIndentation = "NoIndentation",
+    None = "None",
+}
+
+enum LogLevel {
+    Diagnostic = "Diagnostic",
+    Verbose = "Verbose",
+    Normal = "Normal",
+    Warning = "Warning",
+    Error = "Error",
+    None = "None",
 }
 
 export enum CommentType {
@@ -28,16 +63,16 @@ export enum CommentType {
 
 export type IPowerShellAdditionalExePathSettings = Record<string, string>;
 
-export interface IBugReportingSettings {
+interface IBugReportingSettings {
     project: string;
 }
 
-export interface ICodeFoldingSettings {
+interface ICodeFoldingSettings {
     enable: boolean;
     showLastLine: boolean;
 }
 
-export interface ICodeFormattingSettings {
+interface ICodeFormattingSettings {
     autoCorrectAliases: boolean;
     avoidSemicolonsAsLineTerminators: boolean;
     preset: CodeFormattingPreset;
@@ -59,55 +94,29 @@ export interface ICodeFormattingSettings {
     useCorrectCasing: boolean;
 }
 
-export interface IScriptAnalysisSettings {
+interface IScriptAnalysisSettings {
     enable: boolean;
     settingsPath: string;
 }
 
-export interface IDebuggingSettings {
+interface IDebuggingSettings {
     createTemporaryIntegratedConsole: boolean;
 }
 
-export interface IDeveloperSettings {
+interface IDeveloperSettings {
     featureFlags: string[];
     bundledModulesPath: string;
-    editorServicesLogLevel: string;
+    editorServicesLogLevel: LogLevel;
     editorServicesWaitForDebugger: boolean;
     waitForSessionFileTimeoutSeconds: number;
 }
 
-export interface ISettings {
-    powerShellAdditionalExePaths: IPowerShellAdditionalExePathSettings | undefined;
-    powerShellDefaultVersion: string | undefined;
-    // This setting is no longer used but is here to assist in cleaning up the users settings.
-    powerShellExePath: string | undefined;
-    promptToUpdatePowerShell: boolean;
-    bundledModulesPath: string;
-    startAsLoginShell: IStartAsLoginShellSettings;
-    startAutomatically: boolean;
-    enableProfileLoading: boolean;
-    helpCompletion: string;
-    scriptAnalysis: IScriptAnalysisSettings;
-    debugging: IDebuggingSettings;
-    developer: IDeveloperSettings;
-    codeFolding: ICodeFoldingSettings;
-    codeFormatting: ICodeFormattingSettings;
-    integratedConsole: IIntegratedConsoleSettings;
-    bugReporting: IBugReportingSettings;
-    sideBar: ISideBarSettings;
-    pester: IPesterSettings;
-    buttons: IButtonSettings;
-    cwd: string | undefined;
-    enableReferencesCodeLens: boolean;
-    analyzeOpenDocumentsOnly: boolean;
-}
-
-export interface IStartAsLoginShellSettings {
+interface IStartAsLoginShellSettings {
     osx: boolean;
     linux: boolean;
 }
 
-export interface IIntegratedConsoleSettings {
+interface IIntegratedConsoleSettings {
     showOnStartup: boolean;
     startInBackground: boolean;
     focusConsoleOnExecute: boolean;
@@ -116,17 +125,17 @@ export interface IIntegratedConsoleSettings {
     suppressStartupBanner: boolean;
 }
 
-export interface ISideBarSettings {
+interface ISideBarSettings {
     CommandExplorerVisibility: boolean;
 }
 
-export interface IPesterSettings {
+interface IPesterSettings {
     useLegacyCodeLens: boolean;
     outputVerbosity: string;
     debugOutputVerbosity: string;
 }
 
-export interface IButtonSettings {
+interface IButtonSettings {
     showRunButtons: boolean;
     showPanelMovementButtons: boolean;
 }
@@ -154,14 +163,14 @@ export function load(): ISettings {
         // From `<root>/out/main.js` we go to the directory before <root> and
         // then into the other repo.
         bundledModulesPath: "../../PowerShellEditorServices/module",
-        editorServicesLogLevel: "Normal",
+        editorServicesLogLevel: LogLevel.Normal,
         editorServicesWaitForDebugger: false,
         waitForSessionFileTimeoutSeconds: 240,
     };
 
     const defaultCodeFoldingSettings: ICodeFoldingSettings = {
         enable: true,
-        showLastLine: false,
+        showLastLine: true,
     };
 
     const defaultCodeFormattingSettings: ICodeFormattingSettings = {
@@ -215,7 +224,10 @@ export function load(): ISettings {
         debugOutputVerbosity: "Diagnostic",
     };
 
-    // TODO: I believe all the defaults can be removed, as the `package.json` should supply them (and be the source of truth).
+    // TODO: I believe all the defaults can be removed, as the `package.json`
+    // should supply them (and be the source of truth). However, this proves
+    // fairly messy to do as it requires casting the configuration to unknown
+    // and then to `ISettings`. It could work but will take more testing.
     return {
         startAutomatically:
             configuration.get<boolean>("startAutomatically", true),
@@ -230,15 +242,15 @@ export function load(): ISettings {
         bundledModulesPath:
             "../modules", // Because the extension is always at `<root>/out/main.js`
         enableProfileLoading:
-            configuration.get<boolean>("enableProfileLoading", false),
+            configuration.get<boolean>("enableProfileLoading", true),
         helpCompletion:
             configuration.get<string>("helpCompletion", CommentType.BlockComment),
         scriptAnalysis:
             configuration.get<IScriptAnalysisSettings>("scriptAnalysis", defaultScriptAnalysisSettings),
         debugging:
             configuration.get<IDebuggingSettings>("debugging", defaultDebuggingSettings),
         developer:
-            getWorkspaceSettingsWithDefaults<IDeveloperSettings>(configuration, "developer", defaultDeveloperSettings),
+            configuration.get<IDeveloperSettings>("developer", defaultDeveloperSettings),
         codeFolding:
             configuration.get<ICodeFoldingSettings>("codeFolding", defaultCodeFoldingSettings),
         codeFormatting:
@@ -264,7 +276,7 @@ export function load(): ISettings {
         enableReferencesCodeLens:
             configuration.get<boolean>("enableReferencesCodeLens", true),
         analyzeOpenDocumentsOnly:
-            configuration.get<boolean>("analyzeOpenDocumentsOnly", true),
+            configuration.get<boolean>("analyzeOpenDocumentsOnly", false),
     };
 }
 
@@ -303,19 +315,6 @@ export async function change(
     }
 }
 
-function getWorkspaceSettingsWithDefaults<TSettings>(
-    workspaceConfiguration: vscode.WorkspaceConfiguration,
-    settingName: string,
-    defaultSettings: TSettings): TSettings {
-
-    const importedSettings: TSettings = workspaceConfiguration.get<TSettings>(settingName, defaultSettings);
-
-    for (const setting in importedSettings) {
-        defaultSettings[setting] = importedSettings[setting];
-    }
-    return defaultSettings;
-}
-
 // We don't want to query the user more than once, so this is idempotent.
 let hasPrompted = false;