Set Swift environment variables in the integrated terminal (#944)

Author: matthewbastien

assets/icon-font.woff

@@ -30,6 +30,23 @@
   ],
   "main": "./dist/extension.js",
   "contributes": {
+    "icons": {
+      "swift-icon": {
+        "description": "The official icon for the Swift programming language",
+        "default": {
+          "fontPath": "assets/icon-font.woff",
+          "fontCharacter": "\\E001"
+        }
+      }
+    },
+    "terminal": {
+      "profiles": [
+        {
+          "title": "Swift",
+          "id": "swift.terminalProfile"
+        }
+      ]
+    },
     "languages": [
       {
         "id": "swift",
@@ -320,6 +337,12 @@
             "description": "Controls whether or not the extension will warn about being unable to create symlinks. (Windows only)",
             "scope": "application",
             "order": 14
+          },
+          "swift.enableTerminalEnvironment": {
+            "type": "boolean",
+            "default": true,
+            "description": "Controls whether or not the extension will contribute Swift environment variables to the integrated terminal.",
+            "order": 15
           }
         }
       },
@@ -1207,4 +1230,4 @@
     "vscode-languageclient": "^9.0.1",
     "xml2js": "^0.6.2"
   }
-}
+}

package.json

@@ -283,6 +283,12 @@ const configuration = {
             .getConfiguration("swift")
             .update("warnAboutSymlinkCreation", value, vscode.ConfigurationTarget.Global);
     },
+    /** Whether or not the extension will contribute Swift environment variables to the integrated terminal */
+    get enableTerminalEnvironment(): boolean {
+        return vscode.workspace
+            .getConfiguration("swift")
+            .get<boolean>("enableTerminalEnvironment", true);
+    },
 };
 
 export default configuration;

src/configuration.ts

@@ -35,6 +35,7 @@ import { SwiftToolchain } from "./toolchain/toolchain";
 import { SwiftOutputChannel } from "./ui/SwiftOutputChannel";
 import { showReloadExtensionNotification } from "./ui/ReloadExtension";
 import { checkAndWarnAboutWindowsSymlinks } from "./ui/win32";
+import { SwiftEnvironmentVariablesManager, SwiftTerminalProfileProvider } from "./terminal";
 
 /**
  * External API as exposed by the extension. Can be queried by other extensions
@@ -54,6 +55,14 @@ export async function activate(context: vscode.ExtensionContext): Promise<Api |
 
         checkAndWarnAboutWindowsSymlinks(outputChannel);
 
+        context.subscriptions.push(new SwiftEnvironmentVariablesManager(context));
+        context.subscriptions.push(
+            vscode.window.registerTerminalProfileProvider(
+                "swift.terminalProfile",
+                new SwiftTerminalProfileProvider()
+            )
+        );
+
         const toolchain: SwiftToolchain | undefined = await SwiftToolchain.create()
             .then(toolchain => {
                 toolchain.logDiagnostics(outputChannel);
@@ -96,6 +105,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<Api |
             showToolchainError();
             return;
         }
+
         const workspaceContext = await WorkspaceContext.create(outputChannel, toolchain);
         context.subscriptions.push(...commands.register(workspaceContext));
 

src/extension.ts

@@ -0,0 +1,87 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the VS Code Swift open source project
+//
+// Copyright (c) 2024 the VS Code Swift project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of VS Code Swift project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+import * as vscode from "vscode";
+import configuration from "./configuration";
+
+/** The separator to use between paths in the PATH environment variable */
+const pathSeparator: string = process.platform === "win32" ? ";" : ":";
+
+/**
+ * Configures Swift environment variables for VS Code. Will automatically update
+ * whenever the configuration changes.
+ */
+export class SwiftEnvironmentVariablesManager implements vscode.Disposable {
+    private subscriptions: vscode.Disposable[] = [];
+
+    constructor(private context: vscode.ExtensionContext) {
+        this.update();
+        this.subscriptions.push(
+            vscode.workspace.onDidChangeConfiguration(event => {
+                if (
+                    event.affectsConfiguration("swift.enableTerminalEnvironment") ||
+                    event.affectsConfiguration("swift.path") ||
+                    event.affectsConfiguration("swift.swiftEnvironmentVariables")
+                ) {
+                    this.update();
+                }
+            })
+        );
+    }
+
+    dispose() {
+        this.context.environmentVariableCollection.clear();
+        for (const disposable of this.subscriptions) {
+            disposable.dispose();
+        }
+    }
+
+    private update() {
+        const environment = this.context.environmentVariableCollection;
+        environment.clear();
+
+        if (!configuration.enableTerminalEnvironment) {
+            return;
+        }
+
+        const pathEnv = process.env["PATH"] ?? "";
+        if (!pathEnv.includes(configuration.path)) {
+            environment.prepend("PATH", configuration.path + pathSeparator);
+        }
+        for (const variable in configuration.swiftEnvironmentVariables) {
+            environment.replace(variable, configuration.swiftEnvironmentVariables[variable]);
+        }
+    }
+}
+
+/**
+ * A {@link vscode.TerminalProfileProvider} used to create a terminal with the appropriate Swift
+ * environment variables applied.
+ */
+export class SwiftTerminalProfileProvider implements vscode.TerminalProfileProvider {
+    provideTerminalProfile(): vscode.ProviderResult<vscode.TerminalProfile> {
+        const env: vscode.TerminalOptions["env"] = {
+            ...configuration.swiftEnvironmentVariables,
+        };
+        const pathEnv = process.env["PATH"] ?? "";
+        if (!pathEnv.includes(configuration.path)) {
+            env["PATH"] = configuration.path + pathSeparator + pathEnv;
+        }
+        return new vscode.TerminalProfile({
+            name: "Swift Terminal",
+            iconPath: new vscode.ThemeIcon("swift-icon"),
+            env,
+        });
+    }
+}

src/terminal.ts

@@ -197,7 +197,7 @@ async function getQuickPickItems(
     if (process.platform === "linux") {
         actionItems.push({
             type: "action",
-            label: "$(cloud-download) Install Swiftly for toolchain management...",
+            label: "$(swift-icon) Install Swiftly for toolchain management...",
             detail: "Install https://swiftlang.github.io/swiftly to manage your toolchains on Linux",
             run: installSwiftly,
         });