Show a dialog that opens the UI to change the bad setting

Author: plemarquand

src/configuration.ts

@@ -19,6 +19,19 @@ import { WorkspaceContext } from "./WorkspaceContext";
 import { SwiftToolchain } from "./toolchain/toolchain";
 import { showReloadExtensionNotification } from "./ui/ReloadExtension";
 
+/**
+ * Custom error type for configuration validation errors that includes the setting name
+ */
+export class ConfigurationValidationError extends Error {
+    constructor(
+        public readonly settingName: string,
+        message: string
+    ) {
+        super(message);
+        this.name = "ConfigurationValidationError";
+    }
+}
+
 export type DebugAdapters = "auto" | "lldb-dap" | "CodeLLDB";
 export type SetupCodeLLDBOptions =
     | "prompt"
@@ -675,22 +688,31 @@ export function substituteVariablesInString(val: string): string {
 
 function validateBooleanSetting(val: boolean, settingName: string): boolean {
     if (typeof val !== "boolean") {
-        throw new Error(`The setting ${settingName} must be a boolean`);
+        throw new ConfigurationValidationError(
+            settingName,
+            `The setting \`${settingName}\` must be a boolean`
+        );
     }
     return val;
 }
 
 function validateStringSetting<T extends string = string>(val: string, settingName: string): T {
     if (typeof val !== "string") {
-        throw new Error(`The setting ${settingName} must be a string`);
+        throw new ConfigurationValidationError(
+            settingName,
+            `The setting \`${settingName}\` must be a string`
+        );
     }
     return val as T;
 }
 
 function validateStringArraySettings(arr: string[], settingName: string): string[] {
     for (const v of arr) {
         if (typeof v !== "string") {
-            throw new Error(`The setting ${settingName} must be an array of strings`);
+            throw new ConfigurationValidationError(
+                settingName,
+                `The setting \`${settingName}\` must be an array of strings`
+            );
         }
     }
     return arr;

src/extension.ts

@@ -22,7 +22,10 @@ import { FolderEvent, FolderOperation, WorkspaceContext } from "./WorkspaceConte
 import * as commands from "./commands";
 import { resolveFolderDependencies } from "./commands/dependencies/resolve";
 import { registerSourceKitSchemaWatcher } from "./commands/generateSourcekitConfiguration";
-import configuration, { handleConfigurationChangeEvent } from "./configuration";
+import configuration, {
+    ConfigurationValidationError,
+    handleConfigurationChangeEvent,
+} from "./configuration";
 import { ContextKeys, createContextKeys } from "./contextKeys";
 import { registerDebugger } from "./debugger/debugAdapterFactory";
 import * as debug from "./debugger/launch";
@@ -190,10 +193,24 @@ export async function activate(context: vscode.ExtensionContext): Promise<Api> {
             },
         };
     } catch (error) {
-        const errorMessage = getErrorDescription(error);
-        // show this error message as the VS Code error message only shows when running
-        // the extension through the debugger
-        void vscode.window.showErrorMessage(`Activating Swift extension failed: ${errorMessage}`);
+        // Handle configuration validation errors with UI that points the user to the poorly configured setting
+        if (error instanceof ConfigurationValidationError) {
+            void vscode.window.showErrorMessage(error.message, "Open Settings").then(selection => {
+                if (selection === "Open Settings") {
+                    void vscode.commands.executeCommand(
+                        "workbench.action.openSettings",
+                        error.settingName
+                    );
+                }
+            });
+        } else {
+            const errorMessage = getErrorDescription(error);
+            // show this error message as the VS Code error message only shows when running
+            // the extension through the debugger
+            void vscode.window.showErrorMessage(
+                `Activating Swift extension failed: ${errorMessage}`
+            );
+        }
         throw error;
     }
 }