feat(core): add root level forwardAllArgs

nrwl · Apr 10, 2024 · 350e783 · 350e783
1 parent caf663f
commit 350e783
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 3 deletions.
diff --git a/docs/generated/packages/nx/executors/run-commands.json b/docs/generated/packages/nx/executors/run-commands.json
@@ -121,6 +121,11 @@
         "items": { "type": "string" },
         "$default": { "$source": "unparsed" },
         "x-priority": "internal"
+      },
+      "forwardAllArgs": {
+        "type": "boolean",
+        "description": "Whether arguments should be forwarded when interpolation is not present.",
+        "default": true
       }
     },
     "additionalProperties": true,

diff --git a/packages/nx/src/executors/run-commands/run-commands.impl.spec.ts b/packages/nx/src/executors/run-commands/run-commands.impl.spec.ts
@@ -37,19 +37,61 @@ describe('Run Commands', () => {
   });
 
   it('should not pass --args into underlying command', async () => {
-    const f = fileSync().name;
     const result = await runCommands(
       {
         command: `echo`,
         __unparsed__: ['--args=--key=123'],
         args: '--key=123',
-        unparsedCommandArgs: { args: '--key=123' },
       },
       context
     );
     expect(result.terminalOutput.trim()).not.toContain('--args=--key=123');
   });
 
+  it('should not foward any args to underlying command if forwardAllArgs is false', async () => {
+    let result = await runCommands(
+      {
+        command: `echo`,
+        key: 123,
+        __unparsed__: [],
+        forwardAllArgs: false,
+      },
+      context
+    );
+    expect(result.terminalOutput.trim()).not.toContain('--key=123');
+
+    result = await runCommands(
+      {
+        command: `echo`,
+        key: 123,
+        __unparsed__: [],
+        forwardAllArgs: true,
+      },
+      context
+    );
+    expect(result.terminalOutput.trim()).toContain('--key=123');
+
+    result = await runCommands(
+      {
+        commands: [
+          {
+            command: `echo 1`,
+            forwardAllArgs: true,
+          },
+          {
+            command: `echo 2`,
+          },
+        ],
+        __unparsed__: ['--args=--key=123'],
+        args: '--key=123',
+        forwardAllArgs: false,
+      },
+      context
+    );
+    expect(result.terminalOutput).toContain('1 --key=123');
+    expect(result.terminalOutput).not.toContain('2 --key=123');
+  });
+
   it('should interpolate all unknown args as if they were --args', async () => {
     const f = fileSync().name;
     const result = await runCommands(

diff --git a/packages/nx/src/executors/run-commands/run-commands.impl.ts b/packages/nx/src/executors/run-commands/run-commands.impl.ts
@@ -51,6 +51,7 @@ export interface RunCommandsOptions extends Json {
   readyWhen?: string;
   cwd?: string;
   env?: Record<string, string>;
+  forwardAllArgs?: boolean; // default is true
   args?: string | string[];
   envFile?: string;
   __unparsed__: string[];
@@ -72,6 +73,7 @@ const propKeys = [
   'usePty',
   'streamOutput',
   'verbose',
+  'forwardAllArgs',
 ];
 
 export interface NormalizedRunCommandsOptions extends RunCommandsOptions {
@@ -240,7 +242,7 @@ function normalizeOptions(
     c.command = interpolateArgsIntoCommand(
       c.command,
       options as NormalizedRunCommandsOptions,
-      c.forwardAllArgs ?? true
+      c.forwardAllArgs ?? options.forwardAllArgs ?? true
     );
   });
   return options as NormalizedRunCommandsOptions;

diff --git a/packages/nx/src/executors/run-commands/schema.json b/packages/nx/src/executors/run-commands/schema.json
@@ -135,6 +135,11 @@
         "$source": "unparsed"
       },
       "x-priority": "internal"
+    },
+    "forwardAllArgs": {
+      "type": "boolean",
+      "description": "Whether arguments should be forwarded when interpolation is not present.",
+      "default": true
     }
   },
   "additionalProperties": true,