Add swift.packageArguments setting

Adds a new setting to provide arguments to swift commands that can
resolve packages. This applies to `swift package resolve`, `swift
package update`, `swift build` and `swift test`.

This lets users set package resolution specific flags that should be
used whenever resolution is performed, such as
`--replace-scm-with-registry`.

Issue: #1340

Author: plemarquand

Diff for: package.json

@@ -271,7 +271,15 @@
             "items": {
               "type": "string"
             },
-            "markdownDescription": "Additional arguments to pass to `swift` commands such as `swift build`, `swift package`, `swift test`, etc... Keys and values should be provided as individual entries in the list. If you have created a copy of the build task in `tasks.json` then these build arguments will not be propagated to that task."
+            "markdownDescription": "Additional arguments to pass to `swift build` and `swift test`. Keys and values should be provided as individual entries in the list. If you have created a copy of the build task in `tasks.json` then these build arguments will not be propagated to that task."
+          },
+          "swift.packageArguments": {
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string"
+            },
+            "markdownDescription": "Additional arguments to pass to swift commands that do package resolution, such as `swift package resolve`, `swift package update`, `swift build` and `swift test`. Keys and values should be provided as individual entries in the list. If you have created a copy of the build task in `tasks.json` then these build arguments will not be propagated to that task."
           },
           "swift.additionalTestArguments": {
             "type": "array",
@@ -1439,4 +1447,4 @@
     "vscode-languageclient": "^9.0.1",
     "xml2js": "^0.6.2"
   }
-}
+}

Diff for: src/commands/dependencies/resolve.ts

@@ -17,6 +17,7 @@ import { FolderContext } from "../../FolderContext";
 import { createSwiftTask, SwiftTaskProvider } from "../../tasks/SwiftTaskProvider";
 import { WorkspaceContext } from "../../WorkspaceContext";
 import { executeTaskWithUI, updateAfterError } from "../utilities";
+import configuration from "../../configuration";
 
 /**
  * Executes a {@link vscode.Task task} to resolve this package's dependencies.
@@ -39,7 +40,7 @@ export async function resolveFolderDependencies(
     checkAlreadyRunning?: boolean
 ) {
     const task = createSwiftTask(
-        ["package", "resolve"],
+        ["package", "resolve", ...configuration.packageArguments],
         SwiftTaskProvider.resolvePackageName,
         {
             cwd: folderContext.folder,

Diff for: src/commands/dependencies/update.ts

@@ -17,6 +17,7 @@ import { FolderContext } from "../../FolderContext";
 import { WorkspaceContext } from "../../WorkspaceContext";
 import { createSwiftTask, SwiftTaskProvider } from "../../tasks/SwiftTaskProvider";
 import { executeTaskWithUI, updateAfterError } from "./../utilities";
+import configuration from "../../configuration";
 
 /**
  * Executes a {@link vscode.Task task} to update this package's dependencies.
@@ -36,7 +37,7 @@ export async function updateDependencies(ctx: WorkspaceContext) {
  */
 export async function updateFolderDependencies(folderContext: FolderContext) {
     const task = createSwiftTask(
-        ["package", "update"],
+        ["package", "update", ...configuration.packageArguments],
         SwiftTaskProvider.updatePackageName,
         {
             cwd: folderContext.folder,

Diff for: src/commands/resetPackage.ts

@@ -17,6 +17,7 @@ import { FolderContext } from "../FolderContext";
 import { createSwiftTask, SwiftTaskProvider } from "../tasks/SwiftTaskProvider";
 import { WorkspaceContext } from "../WorkspaceContext";
 import { executeTaskWithUI } from "./utilities";
+import configuration from "../configuration";
 
 /**
  * Executes a {@link vscode.Task task} to reset the complete cache/build directory.
@@ -53,7 +54,7 @@ export async function folderResetPackage(folderContext: FolderContext) {
                 return false;
             }
             const resolveTask = createSwiftTask(
-                ["package", "resolve"],
+                ["package", "resolve", ...configuration.packageArguments],
                 SwiftTaskProvider.resolvePackageName,
                 {
                     cwd: folderContext.folder,

Diff for: src/configuration.ts

@@ -239,6 +239,10 @@ const configuration = {
     get buildArguments(): string[] {
         return vscode.workspace.getConfiguration("swift").get<string[]>("buildArguments", []);
     },
+    /** swift package arguments */
+    get packageArguments(): string[] {
+        return vscode.workspace.getConfiguration("swift").get<string[]>("packageArguments", []);
+    },
     /** thread/address sanitizer */
     get sanitizer(): string {
         return vscode.workspace.getConfiguration("swift").get<string>("sanitizer", "off");

Diff for: src/tasks/SwiftTaskProvider.ts

@@ -89,6 +89,8 @@ export function buildOptions(toolchain: SwiftToolchain, debug = true): string[]
         args.push(...sanitizer.buildFlags);
     }
     args.push(...configuration.buildArguments);
+    // build can also trigger package resolution
+    args.push(...configuration.packageArguments);
     return args;
 }
 

Diff for: test/integration-tests/WorkspaceContext.test.ts

@@ -96,6 +96,7 @@ suite("WorkspaceContext Test Suite", () => {
 
         suiteTeardown(async () => {
             await swiftConfig.update("buildArguments", undefined);
+            await swiftConfig.update("packageArguments", undefined);
             await swiftConfig.update("path", undefined);
             await swiftConfig.update("diagnosticsStyle", undefined);
         });
@@ -163,6 +164,19 @@ suite("WorkspaceContext Test Suite", () => {
             await swiftConfig.update("buildArguments", []);
         });
 
+        test("Package Arguments Settings", async () => {
+            const folder = workspaceContext.folders.find(
+                f => f.folder.fsPath === packageFolder.fsPath
+            );
+            assert(folder);
+            await swiftConfig.update("diagnosticsStyle", undefined);
+            await swiftConfig.update("packageArguments", ["--replace-scm-with-registry"]);
+            const buildAllTask = createBuildAllTask(folder);
+            const execution = buildAllTask.execution as SwiftExecution;
+            assertContainsArg(execution, "--replace-scm-with-registry");
+            await swiftConfig.update("packageArguments", []);
+        });
+
         test("Swift Path", async () => {
             /* Temporarily disabled (need swift path to update immediately for this to work)
             const folder = workspaceContext.folders.find(