Clean up settings.ts and its use

andyleejordan · andyleejordan · commit 99dee7266899 · 2022-11-02T14:58:32.000-07:00
diff --git a/src/features/Console.ts b/src/features/Console.ts
@@ -6,7 +6,7 @@ import { NotificationType, RequestType } from "vscode-languageclient";
 import { LanguageClient } from "vscode-languageclient/node";
 import { ICheckboxQuickPickItem, showCheckboxQuickPick } from "../controls/checkboxQuickPick";
 import { Logger } from "../logging";
-import Settings = require("../settings");
+import { getSettings } from "../settings";
 import { LanguageClientConsumer } from "../languageClientConsumer";
 
 export const EvaluateRequestType = new RequestType<IEvaluateRequestArguments, void, void>("evaluate");
@@ -182,7 +182,7 @@ export class ConsoleFeature extends LanguageClientConsumer {
                     // We need to honor the focusConsoleOnExecute setting here too. However, the boolean that `show`
                     // takes is called `preserveFocus` which when `true` the terminal will not take focus.
                     // This is the inverse of focusConsoleOnExecute so we have to inverse the boolean.
-                    vscode.window.activeTerminal.show(!Settings.load().integratedConsole.focusConsoleOnExecute);
+                    vscode.window.activeTerminal.show(!getSettings().integratedConsole.focusConsoleOnExecute);
                     await vscode.commands.executeCommand("workbench.action.terminal.scrollToBottom");
 
                     return;
diff --git a/src/features/DebugSession.ts b/src/features/DebugSession.ts
@@ -11,7 +11,7 @@ import { LanguageClient } from "vscode-languageclient/node";
 import { getPlatformDetails, OperatingSystem } from "../platform";
 import { PowerShellProcess } from "../process";
 import { IEditorServicesSessionDetails, SessionManager, SessionStatus } from "../session";
-import Settings = require("../settings");
+import { getSettings } from "../settings";
 import { Logger } from "../logging";
 import { LanguageClientConsumer } from "../languageClientConsumer";
 import path = require("path");
@@ -169,7 +169,7 @@ export class DebugSessionFeature extends LanguageClientConsumer
         // setting. Otherwise, the launch config value overrides the setting.
         //
         // Also start the temporary process and console for this configuration.
-        const settings = Settings.load();
+        const settings = getSettings();
         config.createTemporaryIntegratedConsole =
             config.createTemporaryIntegratedConsole ??
             settings.debugging.createTemporaryIntegratedConsole;
diff --git a/src/features/ExtensionCommands.ts b/src/features/ExtensionCommands.ts
@@ -10,7 +10,7 @@ import {
 } from "vscode-languageclient";
 import { LanguageClient } from "vscode-languageclient/node";
 import { Logger } from "../logging";
-import Settings = require("../settings");
+import { getSettings } from "../settings";
 import { LanguageClientConsumer } from "../languageClientConsumer";
 
 export interface IExtensionCommand {
@@ -260,7 +260,7 @@ export class ExtensionCommandsFeature extends LanguageClientConsumer {
                 () => {
                     // We check to see if they have TrueClear on. If not, no-op because the
                     // overriden Clear-Host already calls [System.Console]::Clear()
-                    if (Settings.load().integratedConsole.forceClearScrollbackBuffer) {
+                    if (getSettings().integratedConsole.forceClearScrollbackBuffer) {
                         void vscode.commands.executeCommand("workbench.action.terminal.clear");
                     }
                 })
diff --git a/src/features/GenerateBugReport.ts b/src/features/GenerateBugReport.ts
@@ -5,12 +5,11 @@ import os = require("os");
 import vscode = require("vscode");
 import child_process = require("child_process");
 import { SessionManager } from "../session";
-import Settings = require("../settings");
+import { getSettings } from "../settings";
 
 const queryStringPrefix = "?";
 
-const settings = Settings.load();
-const project = settings.bugReporting.project;
+const project = getSettings().bugReporting.project;
 const issuesUrl = `${project}/issues/new`;
 
 const extensions =
diff --git a/src/features/HelpCompletion.ts b/src/features/HelpCompletion.ts
@@ -7,7 +7,7 @@ import {
 } from "vscode";
 import { RequestType } from "vscode-languageclient";
 import { LanguageClient } from "vscode-languageclient/node";
-import Settings = require("../settings");
+import { ISettings, CommentType, getSettings } from "../settings";
 import { LanguageClientConsumer } from "../languageClientConsumer";
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -27,13 +27,13 @@ enum SearchState { Searching, Locked, Found }
 export class HelpCompletionFeature extends LanguageClientConsumer {
     private helpCompletionProvider: HelpCompletionProvider | undefined;
     private disposable: Disposable | undefined;
-    private settings: Settings.ISettings;
+    private settings: ISettings;
 
     constructor() {
         super();
-        this.settings = Settings.load();
+        this.settings = getSettings();
 
-        if (this.settings.helpCompletion !== Settings.CommentType.Disabled) {
+        if (this.settings.helpCompletion !== CommentType.Disabled) {
             this.helpCompletionProvider = new HelpCompletionProvider();
             this.disposable = workspace.onDidChangeTextDocument(async (e) => { await this.onEvent(e); });
         }
@@ -125,11 +125,11 @@ class HelpCompletionProvider {
     private lastChangeRange: Range | undefined;
     private lastDocument: TextDocument | undefined;
     private langClient: LanguageClient | undefined;
-    private settings: Settings.ISettings;
+    private settings: ISettings;
 
     constructor() {
         this.triggerFinderHelpComment = new TriggerFinder("##");
-        this.settings = Settings.load();
+        this.settings = getSettings();
     }
 
     public get triggerFound(): boolean {
@@ -161,7 +161,7 @@ class HelpCompletionProvider {
         const result = await this.langClient.sendRequest(CommentHelpRequestType, {
             documentUri: doc.uri.toString(),
             triggerPosition: triggerStartPos,
-            blockComment: this.settings.helpCompletion === Settings.CommentType.BlockComment,
+            blockComment: this.settings.helpCompletion === CommentType.BlockComment,
         });
 
         if (result.content.length === 0) {
diff --git a/src/features/ISECompatibility.ts b/src/features/ISECompatibility.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import * as vscode from "vscode";
-import * as Settings from "../settings";
+import { getSettings } from "../settings";
 
 interface ISetting {
     path: string;
@@ -63,7 +63,7 @@ export class ISECompatibilityFeature implements vscode.Disposable {
         // Show the PowerShell view container which has the Command Explorer view
         await vscode.commands.executeCommand("workbench.view.extension.PowerShell");
 
-        if (!Settings.load().sideBar.CommandExplorerVisibility) {
+        if (!getSettings().sideBar.CommandExplorerVisibility) {
             // Hide the explorer if the setting says so.
             await vscode.commands.executeCommand("workbench.action.toggleSidebarVisibility");
         }
diff --git a/src/features/PesterTests.ts b/src/features/PesterTests.ts
@@ -4,7 +4,7 @@
 import * as path from "path";
 import vscode = require("vscode");
 import { SessionManager } from "../session";
-import Settings = require("../settings");
+import { getSettings } from "../settings";
 import utils = require("../utils");
 
 enum LaunchType {
@@ -83,7 +83,7 @@ export class PesterTestsFeature implements vscode.Disposable {
         lineNum?: number,
         outputPath?: string): vscode.DebugConfiguration {
 
-        const settings = Settings.load();
+        const settings = getSettings();
 
         // Since we pass the script path to PSES in single quotes to avoid issues with PowerShell
         // special chars like & $ @ () [], we do have to double up the interior single quotes.
diff --git a/src/features/RunCode.ts b/src/features/RunCode.ts
@@ -3,7 +3,7 @@
 
 import vscode = require("vscode");
 import { SessionManager } from "../session";
-import Settings = require("../settings");
+import { getSettings } from "../settings";
 
 enum LaunchType {
     Debug,
@@ -46,7 +46,7 @@ export class RunCodeFeature implements vscode.Disposable {
 }
 
 function createLaunchConfig(launchType: LaunchType, commandToRun: string, args: string[]) {
-    const settings = Settings.load();
+    const settings = getSettings();
 
     const launchConfig = {
         request: "launch",
diff --git a/src/features/UpdatePowerShell.ts b/src/features/UpdatePowerShell.ts
@@ -14,7 +14,7 @@ import { MessageItem, ProgressLocation, window } from "vscode";
 import { LanguageClient } from "vscode-languageclient/node";
 import { Logger } from "../logging";
 import { SessionManager } from "../session";
-import * as Settings from "../settings";
+import { changeSetting } from "../settings";
 import { isMacOS, isWindows } from "../utils";
 import { EvaluateRequestType } from "./Console";
 
@@ -195,7 +195,7 @@ export async function InvokePowerShellUpdateCheck(
 
         // Never choice.
     case 2:
-        await Settings.change("promptToUpdatePowerShell", false, true, logger);
+        await changeSetting("promptToUpdatePowerShell", false, true, logger);
         break;
     default:
         break;
diff --git a/src/main.ts b/src/main.ts
@@ -26,7 +26,7 @@ import { ShowHelpFeature } from "./features/ShowHelp";
 import { SpecifyScriptArgsFeature } from "./features/DebugSession";
 import { Logger } from "./logging";
 import { SessionManager } from "./session";
-import Settings = require("./settings");
+import { LogLevel, getSettings, validateCwdSetting } from "./settings";
 import { PowerShellLanguageId } from "./utils";
 import { LanguageClientConsumer } from "./languageClientConsumer";
 
@@ -51,7 +51,7 @@ const documentSelector: DocumentSelector = [
 
 export async function activate(context: vscode.ExtensionContext): Promise<IPowerShellExtensionClient> {
     const logLevel = vscode.workspace.getConfiguration(`${PowerShellLanguageId}.developer`)
-        .get<string>("editorServicesLogLevel", "Normal");
+        .get<string>("editorServicesLogLevel", LogLevel.Normal);
     logger = new Logger(logLevel, context.globalStorageUri);
 
     telemetryReporter = new TelemetryReporter(PackageJSON.name, PackageJSON.version, AI_KEY);
@@ -65,8 +65,8 @@ export async function activate(context: vscode.ExtensionContext): Promise<IPower
     }
 
     // Load and validate settings (will prompt for 'cwd' if necessary).
-    await Settings.validateCwdSetting(logger);
-    const settings = Settings.load();
+    await validateCwdSetting(logger);
+    const settings = getSettings();
     logger.writeDiagnostic(`Loaded settings:\n${JSON.stringify(settings, undefined, 2)}`);
 
     languageConfigurationDisposable = vscode.languages.setLanguageConfiguration(
diff --git a/src/session.ts b/src/session.ts
@@ -9,7 +9,7 @@ import TelemetryReporter, { TelemetryEventProperties, TelemetryEventMeasurements
 import { Message } from "vscode-jsonrpc";
 import { Logger } from "./logging";
 import { PowerShellProcess } from "./process";
-import Settings = require("./settings");
+import { ISettings, changeSetting, getSettings, getEffectiveConfigurationTarget, validateCwdSetting } from "./settings";
 import utils = require("./utils");
 
 import {
@@ -102,7 +102,7 @@ export class SessionManager implements Middleware {
 
     constructor(
         private extensionContext: vscode.ExtensionContext,
-        private sessionSettings: Settings.ISettings,
+        private sessionSettings: ISettings,
         private logger: Logger,
         private documentSelector: DocumentSelector,
         hostName: string,
@@ -211,8 +211,8 @@ export class SessionManager implements Middleware {
         await this.stop();
 
         // Re-load and validate the settings.
-        await Settings.validateCwdSetting(this.logger);
-        this.sessionSettings = Settings.load();
+        await validateCwdSetting(this.logger);
+        this.sessionSettings = getSettings();
 
         await this.start(exeNameOverride);
     }
@@ -234,7 +234,7 @@ export class SessionManager implements Middleware {
         return vscode.Uri.joinPath(this.sessionsFolder, `PSES-VSCode-${process.env.VSCODE_PID}-${uniqueId}.json`);
     }
 
-    public async createDebugSessionProcess(settings: Settings.ISettings): Promise<PowerShellProcess> {
+    public async createDebugSessionProcess(settings: ISettings): Promise<PowerShellProcess> {
         // NOTE: We only support one temporary Extension Terminal at a time. To
         // support more, we need to track each separately, and tie the session
         // for the event handler to the right process (and dispose of the event
@@ -343,12 +343,12 @@ export class SessionManager implements Middleware {
         const configuration = vscode.workspace.getConfiguration(utils.PowerShellLanguageId);
         const deprecatedSetting = "codeFormatting.whitespaceAroundPipe";
         const newSetting = "codeFormatting.addWhitespaceAroundPipe";
-        const configurationTargetOfNewSetting = Settings.getEffectiveConfigurationTarget(newSetting);
-        const configurationTargetOfOldSetting = Settings.getEffectiveConfigurationTarget(deprecatedSetting);
+        const configurationTargetOfNewSetting = getEffectiveConfigurationTarget(newSetting);
+        const configurationTargetOfOldSetting = getEffectiveConfigurationTarget(deprecatedSetting);
         if (configurationTargetOfOldSetting !== undefined && configurationTargetOfNewSetting === undefined) {
             const value = configuration.get(deprecatedSetting, configurationTargetOfOldSetting);
-            await Settings.change(newSetting, value, configurationTargetOfOldSetting, this.logger);
-            await Settings.change(deprecatedSetting, undefined, configurationTargetOfOldSetting, this.logger);
+            await changeSetting(newSetting, value, configurationTargetOfOldSetting, this.logger);
+            await changeSetting(deprecatedSetting, undefined, configurationTargetOfOldSetting, this.logger);
         }
     }
 
@@ -372,7 +372,7 @@ export class SessionManager implements Middleware {
 
         this.suppressRestartPrompt = true;
         try {
-            await Settings.change("powerShellExePath", undefined, true, this.logger);
+            await changeSetting("powerShellExePath", undefined, true, this.logger);
         } finally {
             this.suppressRestartPrompt = false;
         }
@@ -384,7 +384,7 @@ export class SessionManager implements Middleware {
     }
 
     private async onConfigurationUpdated() {
-        const settings = Settings.load();
+        const settings = getSettings();
         this.logger.updateLogLevel(settings.developer.editorServicesLogLevel);
 
         // Detect any setting changes that would affect the session
@@ -578,9 +578,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;
     }
@@ -808,7 +806,7 @@ Type 'help' to get help.
     private async changePowerShellDefaultVersion(exePath: IPowerShellExeDetails) {
         this.suppressRestartPrompt = true;
         try {
-            await Settings.change("powerShellDefaultVersion", exePath.displayName, true, this.logger);
+            await changeSetting("powerShellDefaultVersion", exePath.displayName, true, this.logger);
         } finally {
             this.suppressRestartPrompt = false;
         }
diff --git a/src/settings.ts b/src/settings.ts
diff --git a/test/core/settings.test.ts b/test/core/settings.test.ts
