Support "swift.play" CodeLens

- Advertise to the LSP we support "swift.play"
- Add a "swift.play" command, hiding it from the command palette
- Fix order of env variables passed to task so variables like
  DYLD_LIBRARY_PATH are not overwritten accidentally

Issue: #1782

Author: award999

package.json

@@ -289,6 +289,12 @@
         "category": "Swift",
         "icon": "$(play)"
       },
+      {
+        "command": "swift.play",
+        "title": "Run Swift playground",
+        "category": "Swift",
+        "icon": "$(play)"
+      },
       {
         "command": "swift.debug",
         "title": "Debug Swift executable",
@@ -1372,6 +1378,10 @@
         {
           "command": "swift.openEducationalNote",
           "when": "false"
+        },
+        {
+          "command": "swift.play",
+          "when": "false"
         }
       ],
       "editor/context": [

src/commands.ts

@@ -42,6 +42,7 @@ import { reindexProject } from "./commands/reindexProject";
 import { resetPackage } from "./commands/resetPackage";
 import restartLSPServer from "./commands/restartLSPServer";
 import { runAllTests } from "./commands/runAllTests";
+import { runPlayground } from "./commands/runPlayground";
 import { runPluginTask } from "./commands/runPluginTask";
 import { runSwiftScript } from "./commands/runSwiftScript";
 import { runTask } from "./commands/runTask";
@@ -88,6 +89,7 @@ export function registerToolchainCommands(
 export enum Commands {
     RUN = "swift.run",
     DEBUG = "swift.debug",
+    PLAY = "swift.play",
     CLEAN_BUILD = "swift.cleanBuild",
     RESOLVE_DEPENDENCIES = "swift.resolveDependencies",
     SHOW_FLAT_DEPENDENCIES_LIST = "swift.flatDependenciesList",
@@ -146,6 +148,10 @@ export function register(ctx: WorkspaceContext): vscode.Disposable[] {
             Commands.DEBUG,
             async target => await debugBuild(ctx, ...unwrapTreeItem(target))
         ),
+        vscode.commands.registerCommand(
+            Commands.PLAY,
+            async target => await runPlayground(ctx, target)
+        ),
         vscode.commands.registerCommand(Commands.CLEAN_BUILD, async () => await cleanBuild(ctx)),
         vscode.commands.registerCommand(
             Commands.RUN_TESTS_MULTIPLE_TIMES,

src/commands/runPlayground.ts

@@ -0,0 +1,48 @@
+import * as vscode from "vscode";
+import { Location, Range } from "vscode-languageclient";
+
+import { WorkspaceContext } from "../WorkspaceContext";
+import { createSwiftTask } from "../tasks/SwiftTaskProvider";
+import { packageName } from "../utilities/tasks";
+
+export interface PlaygroundItem {
+    id: string;
+    label?: string;
+}
+
+export interface DocumentPlaygroundItem extends PlaygroundItem {
+    id: string;
+    label?: string;
+    range: Range;
+}
+
+export interface WorkspacePlaygroundItem extends PlaygroundItem {
+    id: string;
+    label?: string;
+    location: Location;
+}
+
+/**
+ * Executes a {@link vscode.Task task} to run swift playground.
+ */
+export async function runPlayground(ctx: WorkspaceContext, item?: PlaygroundItem) {
+    const folderContext = ctx.currentFolder;
+    if (!folderContext || !item) {
+        return false;
+    }
+    const id = item.label ?? item.id;
+    const task = createSwiftTask(
+        ["play", id],
+        `Play "${id}"`,
+        {
+            cwd: folderContext.folder,
+            scope: folderContext.workspaceFolder,
+            packageName: packageName(folderContext),
+            presentationOptions: { reveal: vscode.TaskRevealKind.Always },
+        },
+        folderContext.toolchain
+    );
+
+    await vscode.tasks.executeTask(task);
+    return true;
+}

src/sourcekit-lsp/LanguageClientConfiguration.ts

@@ -36,6 +36,7 @@ function initializationOptions(swiftVersion: Version): any {
             supportedCommands: {
                 "swift.run": "swift.run",
                 "swift.debug": "swift.debug",
+                "swift.play": "swift.play",
             },
         },
     };
@@ -254,6 +255,9 @@ export function lspClientOptions(
                         case "swift.debug":
                             codelens.command.title = `$(debug)\u00A0${codelens.command.title}`;
                             break;
+                        case "swift.play":
+                            codelens.command.title = `$(play)\u00A0${codelens.command.title}`;
+                            break;
                     }
                     return codelens;
                 });

src/tasks/SwiftTaskProvider.ts

@@ -312,7 +312,11 @@ export function createSwiftTask(
     } else {
         cwd = config.cwd.fsPath;
     }*/
-    const env = { ...configuration.swiftEnvironmentVariables, ...swiftRuntimeEnv(), ...cmdEnv };
+    const env = {
+        ...swiftRuntimeEnv(), // From process.env first
+        ...configuration.swiftEnvironmentVariables, // Then swiftEnvironmentVariables settings
+        ...cmdEnv, // Task configuration takes highest precedence
+    };
     const presentation = config?.presentationOptions ?? {};
     if (config?.packageName) {
         name += ` (${config?.packageName})`;
@@ -469,9 +473,9 @@ export class SwiftTaskProvider implements vscode.TaskProvider {
         const env = platform?.env ?? task.definition.env;
         const fullCwd = resolveTaskCwd(task, platform?.cwd ?? task.definition.cwd);
         const fullEnv = {
-            ...configuration.swiftEnvironmentVariables,
-            ...swiftRuntimeEnv(),
-            ...env,
+            ...swiftRuntimeEnv(), // From process.env first
+            ...configuration.swiftEnvironmentVariables, // Then swiftEnvironmentVariables settings
+            ...env, // Task configuration takes highest precedence
         };
 
         const presentation = task.definition.presentation ?? task.presentationOptions ?? {};