feat(core): add batch flag to run (#19575)

Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com>

docs/generated/cli/affected.md

@@ -79,6 +79,12 @@ Type: `string`
 
 Base of the current branch (usually main)
 
+### batch
+
+Type: `boolean`
+
+Default: `false`
+
 ### configuration
 
 Type: `string`

docs/generated/cli/run-many.md

@@ -81,6 +81,12 @@ Default: `true`
 
 [deprecated] `run-many` runs all targets on all projects in the workspace if no projects are provided. This option is no longer required.
 
+### batch
+
+Type: `boolean`
+
+Default: `false`
+
 ### configuration
 
 Type: `string`

docs/generated/devkit/DefaultTasksRunnerOptions.md

@@ -4,6 +4,7 @@
 
 ### Properties
 
+- [batch](../../devkit/documents/DefaultTasksRunnerOptions#batch): boolean
 - [cacheDirectory](../../devkit/documents/DefaultTasksRunnerOptions#cachedirectory): string
 - [cacheableOperations](../../devkit/documents/DefaultTasksRunnerOptions#cacheableoperations): string[]
 - [cacheableTargets](../../devkit/documents/DefaultTasksRunnerOptions#cacheabletargets): string[]
@@ -16,6 +17,12 @@
 
 ## Properties
 
+### batch
+
+• `Optional` **batch**: `boolean`
+
+---
+
 ### cacheDirectory
 
 • `Optional` **cacheDirectory**: `string`

docs/generated/packages/nx/documents/affected.md

@@ -79,6 +79,12 @@ Type: `string`
 
 Base of the current branch (usually main)
 
+### batch
+
+Type: `boolean`
+
+Default: `false`
+
 ### configuration
 
 Type: `string`

docs/generated/packages/nx/documents/run-many.md

@@ -81,6 +81,12 @@ Default: `true`
 
 [deprecated] `run-many` runs all targets on all projects in the workspace if no projects are provided. This option is no longer required.
 
+### batch
+
+Type: `boolean`
+
+Default: `false`
+
 ### configuration
 
 Type: `string`

e2e/js/src/js-executor-tsc.test.ts

@@ -152,7 +152,7 @@ describe('js:tsc executor', () => {
 
     // check batch build
     rmDist();
-    const batchBuildOutput = runCLI(`build ${parentLib} --skip-nx-cache`, {
+    let batchBuildOutput = runCLI(`build ${parentLib} --skip-nx-cache`, {
       env: { NX_BATCH_MODE: 'true' },
     });
 
@@ -173,6 +173,9 @@ describe('js:tsc executor', () => {
       `Successfully ran target build for project ${parentLib} and 1 task it depends on`
     );
 
+    batchBuildOutput = runCLI(`build ${parentLib} --skip-nx-cache --batch`);
+    expect(batchBuildOutput).toContain(`Running 2 tasks with @nx/js:tsc`);
+
     checkFilesExist(
       // parent
       `dist/libs/${parentLib}/package.json`,

packages/nx/src/command-line/affected/command-object.ts

@@ -2,6 +2,7 @@ import { boolean, CommandModule, middleware } from 'yargs';
 import { linkToNxDevAndExamples } from '../yargs-utils/documentation';
 import {
   withAffectedOptions,
+  withBatch,
   withConfiguration,
   withDepGraphOptions,
   withOutputStyleOption,
@@ -17,7 +18,9 @@ export const yargsAffectedCommand: CommandModule = {
     linkToNxDevAndExamples(
       withAffectedOptions(
         withRunOptions(
-          withOutputStyleOption(withTargetAndConfigurationOption(yargs))
+          withOutputStyleOption(
+            withTargetAndConfigurationOption(withBatch(yargs))
+          )
         )
       )
         .option('all', {

packages/nx/src/command-line/run-many/command-object.ts

@@ -5,6 +5,7 @@ import {
   withOutputStyleOption,
   withTargetAndConfigurationOption,
   withOverrides,
+  withBatch,
 } from '../yargs-utils/shared-options';
 
 export const yargsRunManyCommand: CommandModule = {
@@ -13,7 +14,9 @@ export const yargsRunManyCommand: CommandModule = {
   builder: (yargs) =>
     linkToNxDevAndExamples(
       withRunManyOptions(
-        withOutputStyleOption(withTargetAndConfigurationOption(yargs))
+        withOutputStyleOption(
+          withTargetAndConfigurationOption(withBatch(yargs))
+        )
       ),
       'run-many'
     ),

packages/nx/src/command-line/run/command-object.ts

@@ -1,5 +1,6 @@
 import { CommandModule } from 'yargs';
 import {
+  withBatch,
   withOverrides,
   withRunOneOptions,
 } from '../yargs-utils/shared-options';
@@ -13,7 +14,7 @@ export const yargsRunCommand: CommandModule = {
     (e.g., nx serve myapp --configuration=production)
 
     You can skip the use of Nx cache by using the --skip-nx-cache option.`,
-  builder: (yargs) => withRunOneOptions(yargs),
+  builder: (yargs) => withRunOneOptions(withBatch(yargs)),
   handler: async (args) =>
     (await import('./run-one')).runOne(process.cwd(), withOverrides(args)),
 };

packages/nx/src/command-line/yargs-utils/shared-options.ts

@@ -25,6 +25,7 @@ export interface RunOptions {
   skipNxCache: boolean;
   cloud: boolean;
   dte: boolean;
+  batch: boolean;
 }
 
 export function withRunOptions<T>(yargs: Argv<T>): Argv<T & RunOptions> {
@@ -89,7 +90,7 @@ export function withRunOptions<T>(yargs: Argv<T>): Argv<T & RunOptions> {
     .options('dte', {
       type: 'boolean',
       hidden: true,
-    }) as Argv<Omit<RunOptions, 'projects' | 'exclude'>> as any;
+    }) as Argv<Omit<RunOptions, 'exclude' | 'batch'>> as any;
 }
 
 export function withTargetAndConfigurationOption(
@@ -116,6 +117,16 @@ export function withConfiguration(yargs: Argv) {
   });
 }
 
+export function withBatch(yargs: Argv) {
+  return yargs.options('batch', {
+    type: 'boolean',
+    coerce: (v) => {
+      return v || process.env.BATCH_MODE === 'true';
+    },
+    default: false,
+  }) as any;
+}
+
 export function withAffectedOptions(yargs: Argv) {
   return withExcludeOption(yargs)
     .parserConfiguration({

packages/nx/src/tasks-runner/default-tasks-runner.ts

@@ -24,6 +24,7 @@ export interface DefaultTasksRunnerOptions {
   lifeCycle: LifeCycle;
   captureStderr?: boolean;
   skipNxCache?: boolean;
+  batch?: boolean;
 }
 
 export const defaultTasksRunner: TasksRunner<

packages/nx/src/tasks-runner/run-command.ts

@@ -194,7 +194,11 @@ export async function runCommand(
 }
 
 function setEnvVarsBasedOnArgs(nxArgs: NxArgs, loadDotEnvFiles: boolean) {
-  if (nxArgs.outputStyle == 'stream' || process.env.NX_BATCH_MODE === 'true') {
+  if (
+    nxArgs.outputStyle == 'stream' ||
+    process.env.NX_BATCH_MODE === 'true' ||
+    nxArgs.batch
+  ) {
     process.env.NX_STREAM_OUTPUT = 'true';
     process.env.NX_PREFIX_OUTPUT = 'true';
   }

packages/nx/src/tasks-runner/tasks-schedule.ts

@@ -71,7 +71,7 @@ export class TasksSchedule {
   }
 
   private async scheduleTasks() {
-    if (process.env.NX_BATCH_MODE === 'true') {
+    if (this.options.batch || process.env.NX_BATCH_MODE === 'true') {
       await this.scheduleBatches();
     }
     for (let root of this.notScheduledTaskGraph.roots) {

packages/nx/src/utils/command-line-utils.ts

@@ -35,6 +35,7 @@ export interface NxArgs {
   nxBail?: boolean;
   nxIgnoreCycles?: boolean;
   type?: string;
+  batch?: boolean;
 }
 
 export function createOverrides(__overrides_unparsed__: string[] = []) {