Add quick pick to set Xcode DEVELOPER_DIR (#384)

* Add quick pick to select Xcode toolchain to use

* Fix deleting DEVELOPER_DIR key

* Resolved tasks should use same environment

* Remove DarwinQuickPickTarget. We don't need it

Author: adam-fowler

package.json

@@ -44,11 +44,6 @@
         "title": "Clean Build",
         "category": "Swift"
       },
-      {
-        "command": "swift.switchPlatform",
-        "title": "Switch Target",
-        "category": "Swift"
-      },
       {
         "command": "swift.resetPackage",
         "title": "Reset Package Dependencies",
@@ -89,6 +84,16 @@
         "command": "swift.openPackage",
         "title": "Open Package.swift",
         "category": "Swift"
+      },
+      {
+        "command": "swift.switchPlatform",
+        "title": "Select Target Platform",
+        "category": "Swift"
+      },
+      {
+        "command": "swift.selectXcodeDeveloperDir",
+        "title": "Select Xcode Developer Dir",
+        "category": "Swift"
       }
     ],
     "configuration": [
@@ -276,6 +281,10 @@
         {
           "command": "swift.openExternal",
           "when": "false"
+        },
+        {
+          "command": "swift.selectXcodeDeveloperDir",
+          "when": "isMac"
         }
       ],
       "view/title": [

src/SwiftTaskProvider.ts

@@ -294,6 +294,7 @@ export class SwiftTaskProvider implements vscode.TaskProvider {
             "swift",
             new vscode.ShellExecution(swift, task.definition.args, {
                 cwd: fullCwd,
+                env: { ...configuration.swiftEnvironmentVariables, ...swiftRuntimeEnv() },
             }),
             task.problemMatchers
         );

src/commands.ts

@@ -15,6 +15,7 @@
 import * as vscode from "vscode";
 import * as fs from "fs/promises";
 import * as path from "path";
+import configuration from "./configuration";
 import { FolderEvent, WorkspaceContext } from "./WorkspaceContext";
 import { createSwiftTask, SwiftTaskProvider } from "./SwiftTaskProvider";
 import { FolderContext } from "./FolderContext";
@@ -23,7 +24,6 @@ import { withQuickPick } from "./ui/QuickPick";
 import { execSwift } from "./utilities/utilities";
 import { Version } from "./utilities/version";
 import { DarwinCompatibleTarget, SwiftToolchain } from "./toolchain/toolchain";
-import configuration from "./configuration";
 
 /**
  * References:
@@ -431,31 +431,68 @@ function openInExternalEditor(packageNode: PackageNode) {
     }
 }
 
-interface DarwinQuickPickTarget extends vscode.QuickPickItem {
-    value: DarwinCompatibleTarget;
-    label: string;
-}
-
 /**
  * Switches the target SDK to the platform selected in a QuickPick UI.
  */
 async function switchPlatform() {
-    const onSelect = async (picked: DarwinQuickPickTarget) => {
-        const sdkForTarget = await SwiftToolchain.getSdkForTarget(picked.value);
-        if (sdkForTarget) {
-            configuration.sdk = sdkForTarget;
-        } else {
-            vscode.window.showErrorMessage("Unable to obtain requested SDK path");
-        }
-    };
-
-    await withQuickPick<DarwinQuickPickTarget>(
+    await withQuickPick(
         "Select a new target",
         [
             { value: DarwinCompatibleTarget.macOS, label: "macOS" },
             { value: DarwinCompatibleTarget.iOS, label: "iOS" },
         ],
-        onSelect
+        async picked => {
+            const sdkForTarget = await SwiftToolchain.getSdkForTarget(picked.value);
+            if (sdkForTarget) {
+                configuration.sdk = sdkForTarget;
+            } else {
+                vscode.window.showErrorMessage("Unable to obtain requested SDK path");
+            }
+        }
+    );
+}
+
+/**
+ * Choose DEVELOPER_DIR
+ * @param workspaceContext
+ */
+async function selectXcodeDeveloperDir() {
+    const defaultXcode = await SwiftToolchain.getXcodeDeveloperDir();
+    const selectedXcode = configuration.swiftEnvironmentVariables.DEVELOPER_DIR;
+    const xcodes = await SwiftToolchain.getXcodeInstalls();
+    await withQuickPick(
+        selectedXcode ?? defaultXcode,
+        xcodes.map(xcode => {
+            const developerDir = `${xcode}/Contents/Developer`;
+            return {
+                label: developerDir === defaultXcode ? `${xcode} (default)` : xcode,
+                folder: developerDir === defaultXcode ? undefined : developerDir,
+            };
+        }),
+        async selected => {
+            let swiftEnv = configuration.swiftEnvironmentVariables;
+            const previousDeveloperDir = swiftEnv.DEVELOPER_DIR ?? defaultXcode;
+            if (selected.folder) {
+                swiftEnv.DEVELOPER_DIR = selected.folder;
+            } else if (swiftEnv.DEVELOPER_DIR) {
+                // if DEVELOPER_DIR was set and the new folder is the default then
+                // delete variable
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                const { DEVELOPER_DIR, ...rest } = swiftEnv;
+                swiftEnv = rest;
+            }
+            configuration.swiftEnvironmentVariables = swiftEnv;
+            // if SDK is inside previous DEVELOPER_DIR then move to new DEVELOPER_DIR
+            if (
+                configuration.sdk.length > 0 &&
+                configuration.sdk.startsWith(previousDeveloperDir)
+            ) {
+                configuration.sdk = configuration.sdk.replace(
+                    previousDeveloperDir,
+                    selected.folder ?? defaultXcode
+                );
+            }
+        }
     );
 }
 
@@ -510,6 +547,9 @@ export function register(ctx: WorkspaceContext) {
             if (item instanceof PackageNode) {
                 openInExternalEditor(item);
             }
-        })
+        }),
+        vscode.commands.registerCommand("swift.selectXcodeDeveloperDir", () =>
+            selectXcodeDeveloperDir()
+        )
     );
 }

src/configuration.ts

@@ -89,6 +89,9 @@ const configuration = {
             .getConfiguration("swift")
             .get<{ [key: string]: string }>("swiftEnvironmentVariables", {});
     },
+    set swiftEnvironmentVariables(vars: { [key: string]: string }) {
+        vscode.workspace.getConfiguration("swift").update("swiftEnvironmentVariables", vars);
+    },
     /** include build errors in problems view */
     get problemMatchCompileErrors(): boolean {
         return vscode.workspace

src/toolchain/toolchain.ts

@@ -14,6 +14,7 @@
 
 import * as fs from "fs/promises";
 import * as path from "path";
+import { normalize } from "path";
 import * as plist from "plist";
 import * as vscode from "vscode";
 import configuration from "../configuration";
@@ -95,6 +96,49 @@ export class SwiftToolchain {
         );
     }
 
+    /**
+     * Get active developer dir for Xcode
+     */
+    public static async getXcodeDeveloperDir(): Promise<string> {
+        const { stdout } = await execFile("xcode-select", ["-p"]);
+        return stdout.trimEnd();
+    }
+
+    /**
+     * @param target Target to obtain the SDK path for
+     * @returns path to the SDK for the target
+     */
+    public static async getSdkForTarget(
+        target: DarwinCompatibleTarget
+    ): Promise<string | undefined> {
+        let sdkType: string;
+        switch (target) {
+            case DarwinCompatibleTarget.macOS:
+                // macOS is the default target, so lets not update the SDK
+                return undefined;
+            case DarwinCompatibleTarget.iOS:
+                sdkType = "iphoneos";
+                break;
+        }
+
+        // Include custom variables so that non-standard XCode installs can be better supported.
+        const { stdout } = await execFile("xcrun", ["--sdk", sdkType, "--show-sdk-path"], {
+            env: { ...process.env, ...configuration.swiftEnvironmentVariables },
+        });
+        return path.join(stdout.trimEnd());
+    }
+
+    /**
+     * Get list of Xcode versions intalled on mac
+     * @returns Folders for each Xcode install
+     */
+    public static async getXcodeInstalls(): Promise<string[]> {
+        const { stdout: xcodes } = await execFile("mdfind", [
+            `kMDItemCFBundleIdentifier == 'com.apple.dt.Xcode'`,
+        ]);
+        return xcodes.trimEnd().split("\n");
+    }
+
     logDiagnostics(channel: SwiftOutputChannel) {
         channel.logDiagnostic(`Swift Path: ${this.swiftFolderPath}`);
         channel.logDiagnostic(`Toolchain Path: ${this.toolchainPath}`);
@@ -214,30 +258,6 @@ export class SwiftToolchain {
         return undefined;
     }
 
-    /**
-     * @param target Target to obtain the SDK path for
-     * @returns path to the SDK for the target
-     */
-    public static async getSdkForTarget(
-        target: DarwinCompatibleTarget
-    ): Promise<string | undefined> {
-        let sdkType: string;
-        switch (target) {
-            case DarwinCompatibleTarget.macOS:
-                sdkType = "macosx";
-                break;
-            case DarwinCompatibleTarget.iOS:
-                sdkType = "iphoneos";
-                break;
-        }
-
-        // Include custom variables so that non-standard XCode installs can be better supported.
-        const { stdout } = await execFile("xcrun", ["--sdk", sdkType, "--show-sdk-path"], {
-            env: { ...process.env, ...configuration.swiftEnvironmentVariables },
-        });
-        return path.join(stdout.trimEnd());
-    }
-
     /**
      * @returns path to custom SDK
      */
@@ -260,8 +280,8 @@ export class SwiftToolchain {
     ): Promise<string | undefined> {
         switch (process.platform) {
             case "darwin": {
-                const { stdout } = await execFile("xcode-select", ["-p"]);
-                return path.join(stdout.trimEnd(), "usr", "bin");
+                const developerDir = await this.getXcodeDeveloperDir();
+                return path.join(developerDir, "usr", "bin");
             }
             case "win32": {
                 // look up runtime library directory for XCTest alternatively