feat(core): introduce an explicit variable for deciding on how output…

… is printed

docs/generated/cli/affected.md

@@ -109,6 +109,14 @@ Default: false
 
 Isolate projects which previously failed
 
+### output-style
+
+Type: string
+
+Choices: [dynamic, static, stream]
+
+Defines how Nx emits outputs tasks logs
+
 ### parallel
 
 Type: string

docs/generated/cli/run-many.md

@@ -73,6 +73,14 @@ Default: false
 
 Only run the target on projects which previously failed
 
+### output-style
+
+Type: string
+
+Choices: [dynamic, static, stream]
+
+Defines how Nx emits outputs tasks logs
+
 ### parallel
 
 Type: string

packages/nx/bin/run-executor.ts

@@ -3,7 +3,7 @@ import { appendFileSync, openSync, writeFileSync } from 'fs';
 if (process.env.NX_TERMINAL_OUTPUT_PATH) {
   setUpOutputWatching(
     process.env.NX_TERMINAL_CAPTURE_STDERR === 'true',
-    process.env.NX_FORWARD_OUTPUT === 'true'
+    process.env.NX_STREAM_OUTPUT === 'true'
   );
 }
 
@@ -45,13 +45,13 @@ function requireCli() {
  * We need to collect all stdout and stderr and store it, so the caching mechanism
  * could store it.
  *
- * Writing stdout and stderr into different stream is too risky when using TTY.
+ * Writing stdout and stderr into different streams is too risky when using TTY.
  *
  * So we are simply monkey-patching the Javascript object. In this case the actual output will always be correct.
  * And the cached output should be correct unless the CLI bypasses process.stdout or console.log and uses some
  * C-binary to write to stdout.
  */
-function setUpOutputWatching(captureStderr: boolean, forwardOutput: boolean) {
+function setUpOutputWatching(captureStderr: boolean, streamOutput: boolean) {
   const stdoutWrite = process.stdout._write;
   const stderrWrite = process.stderr._write;
 
@@ -67,7 +67,7 @@ function setUpOutputWatching(captureStderr: boolean, forwardOutput: boolean) {
   ) => {
     onlyStdout.push(chunk);
     appendFileSync(stdoutAndStderrLogFileHandle, chunk);
-    if (forwardOutput) {
+    if (streamOutput) {
       stdoutWrite.apply(process.stdout, [chunk, encoding, callback]);
     } else {
       callback();
@@ -80,7 +80,7 @@ function setUpOutputWatching(captureStderr: boolean, forwardOutput: boolean) {
     callback: Function
   ) => {
     appendFileSync(stdoutAndStderrLogFileHandle, chunk);
-    if (forwardOutput) {
+    if (streamOutput) {
       stderrWrite.apply(process.stderr, [chunk, encoding, callback]);
     } else {
       callback();

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

@@ -107,7 +107,6 @@ export async function affected(
           env,
           nxArgs,
           overrides,
-          nxArgs.hideCachedOutput ? 'hide-cached-output' : 'default',
           null
         );
         break;

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

@@ -72,7 +72,9 @@ ${daemonHelpOutput}
     describe: 'Run target for multiple listed projects',
     builder: (yargs) =>
       linkToNxDevAndExamples(
-        withRunManyOptions(withParallelOption(withTargetOption(yargs))),
+        withRunManyOptions(
+          withOutputStyleOption(withParallelOption(withTargetOption(yargs)))
+        ),
         'run-many'
       ),
     handler: async (args) => (await import('./run-many')).runMany({ ...args }),
@@ -82,7 +84,9 @@ ${daemonHelpOutput}
     describe: 'Run target for affected projects',
     builder: (yargs) =>
       linkToNxDevAndExamples(
-        withAffectedOptions(withParallelOption(withTargetOption(yargs))),
+        withAffectedOptions(
+          withOutputStyleOption(withParallelOption(withTargetOption(yargs)))
+        ),
         'affected'
       ),
     handler: async (args) =>
@@ -93,7 +97,7 @@ ${daemonHelpOutput}
     describe: false,
     builder: (yargs) =>
       linkToNxDevAndExamples(
-        withAffectedOptions(withParallelOption(yargs)),
+        withAffectedOptions(withOutputStyleOption(withParallelOption(yargs))),
         'affected'
       ),
     handler: async (args) =>
@@ -107,7 +111,7 @@ ${daemonHelpOutput}
     describe: false,
     builder: (yargs) =>
       linkToNxDevAndExamples(
-        withAffectedOptions(withParallelOption(yargs)),
+        withAffectedOptions(withOutputStyleOption(withParallelOption(yargs))),
         'affected'
       ),
     handler: async (args) =>
@@ -121,7 +125,7 @@ ${daemonHelpOutput}
     describe: false,
     builder: (yargs) =>
       linkToNxDevAndExamples(
-        withAffectedOptions(withParallelOption(yargs)),
+        withAffectedOptions(withOutputStyleOption(withParallelOption(yargs))),
         'affected'
       ),
     handler: async (args) =>
@@ -135,7 +139,7 @@ ${daemonHelpOutput}
     describe: false,
     builder: (yargs) =>
       linkToNxDevAndExamples(
-        withAffectedOptions(withParallelOption(yargs)),
+        withAffectedOptions(withOutputStyleOption(withParallelOption(yargs))),
         'affected'
       ),
     handler: async (args) =>
@@ -524,6 +528,14 @@ function withParallelOption(yargs: yargs.Argv): yargs.Argv {
   });
 }
 
+function withOutputStyleOption(yargs: yargs.Argv): yargs.Argv {
+  return yargs.option('output-style', {
+    describe: 'Defines how Nx emits outputs tasks logs',
+    type: 'string',
+    choices: ['dynamic', 'static', 'stream'],
+  });
+}
+
 function withTargetOption(yargs: yargs.Argv): yargs.Argv {
   return yargs.option('target', {
     describe: 'Task to run for affected projects',
@@ -596,6 +608,11 @@ function withRunOneOptions(yargs: yargs.Argv) {
     .option('project', {
       describe: 'Target project',
       type: 'string',
+    })
+    .option('output-style', {
+      describe: 'Defines how Nx emits outputs tasks logs',
+      type: 'string',
+      choices: ['dynamic', 'static', 'stream', 'compact'],
     });
 
   if (executorShouldShowHelp) {

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

@@ -23,15 +23,7 @@ export async function runMany(parsedArgs: yargs.Arguments & RawNxArgs) {
   const projects = projectsToRun(nxArgs, projectGraph);
   const env = readEnvironment();
 
-  await runCommand(
-    projects,
-    projectGraph,
-    env,
-    nxArgs,
-    overrides,
-    nxArgs.hideCachedOutput ? 'hide-cached-output' : 'default',
-    null
-  );
+  await runCommand(projects, projectGraph, env, nxArgs, overrides, null);
 }
 
 function projectsToRun(

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

@@ -49,7 +49,6 @@ export async function runOne(
     env,
     nxArgs,
     overrides,
-    'run-one',
     opts.project
   );
 }

packages/nx/src/tasks-runner/forked-process-task-runner.ts

@@ -96,9 +96,9 @@ export class ForkedProcessTaskRunner {
   public forkProcessPipeOutputCapture(
     task: Task,
     {
-      forwardOutput,
+      streamOutput,
       temporaryOutputPath,
-    }: { forwardOutput: boolean; temporaryOutputPath: string }
+    }: { streamOutput: boolean; temporaryOutputPath: string }
   ) {
     return new Promise<{ code: number; terminalOutput: string }>((res, rej) => {
       try {
@@ -107,34 +107,34 @@ export class ForkedProcessTaskRunner {
           task,
           task.overrides['verbose'] === true
         );
-
-        if (forwardOutput) {
+        if (streamOutput) {
           output.logCommand(args.join(' '));
           output.addNewline();
         }
+
         const p = fork(this.cliPath, serializedArgs, {
           stdio: ['inherit', 'pipe', 'pipe', 'ipc'],
           env: this.getEnvVariablesForTask(
             task,
             process.env.FORCE_COLOR === undefined
               ? 'true'
               : process.env.FORCE_COLOR,
-            undefined,
-            forwardOutput
+            null,
+            null
           ),
         });
         this.processes.add(p);
         let out = [];
         let outWithErr = [];
         p.stdout.on('data', (chunk) => {
-          if (forwardOutput) {
+          if (streamOutput) {
             process.stdout.write(chunk);
           }
           out.push(chunk.toString());
           outWithErr.push(chunk.toString());
         });
         p.stderr.on('data', (chunk) => {
-          if (forwardOutput) {
+          if (streamOutput) {
             process.stderr.write(chunk);
           }
           outWithErr.push(chunk.toString());
@@ -146,7 +146,7 @@ export class ForkedProcessTaskRunner {
           // print all the collected output|
           const terminalOutput = outWithErr.join('');
 
-          if (!forwardOutput) {
+          if (!streamOutput) {
             this.options.lifeCycle.printTaskTerminalOutput(
               task,
               code === 0 ? 'success' : 'failure',
@@ -166,9 +166,9 @@ export class ForkedProcessTaskRunner {
   public forkProcessDirectOutputCapture(
     task: Task,
     {
-      forwardOutput,
+      streamOutput,
       temporaryOutputPath,
-    }: { forwardOutput: boolean; temporaryOutputPath: string }
+    }: { streamOutput: boolean; temporaryOutputPath: string }
   ) {
     return new Promise<{ code: number; terminalOutput: string }>((res, rej) => {
       try {
@@ -177,7 +177,7 @@ export class ForkedProcessTaskRunner {
           task,
           task.overrides['verbose'] === true
         );
-        if (forwardOutput) {
+        if (streamOutput) {
           output.logCommand(args.join(' '));
           output.addNewline();
         }
@@ -187,7 +187,7 @@ export class ForkedProcessTaskRunner {
             task,
             undefined,
             temporaryOutputPath,
-            forwardOutput
+            streamOutput
           ),
         });
         this.processes.add(p);
@@ -198,7 +198,7 @@ export class ForkedProcessTaskRunner {
           let terminalOutput = '';
           try {
             terminalOutput = this.readTerminalOutput(temporaryOutputPath);
-            if (!forwardOutput) {
+            if (!streamOutput) {
               this.options.lifeCycle.printTaskTerminalOutput(
                 task,
                 code === 0 ? 'success' : 'failure',
@@ -252,9 +252,9 @@ export class ForkedProcessTaskRunner {
     task: Task,
     forceColor: string,
     outputPath: string,
-    forwardOutput: boolean
+    streamOutput: boolean
   ) {
-    return {
+    const res = {
       // Start With Dotenv Variables
       ...this.getDotenvVariablesForTask(task),
       // User Process Env Variables override Dotenv Variables
@@ -264,15 +264,23 @@ export class ForkedProcessTaskRunner {
         task,
         forceColor,
         outputPath,
-        forwardOutput
+        streamOutput
       ),
     };
+
+    // we have to delete it because if we invoke Nx from within Nx, we need to reset those values
+    if (!outputPath) {
+      delete res.NX_TERMINAL_OUTPUT_PATH;
+      delete res.NX_STREAM_OUTPUT;
+    }
+    delete res.NX_SET_CLI;
+    return res;
   }
 
   private getNxEnvVariablesForForkedProcess(
     forceColor: string,
     outputPath?: string,
-    forwardOutput?: boolean
+    streamOutput?: boolean
   ) {
     const env: NodeJS.ProcessEnv = {
       FORCE_COLOR: forceColor,
@@ -285,8 +293,8 @@ export class ForkedProcessTaskRunner {
       if (this.options.captureStderr) {
         env.NX_TERMINAL_CAPTURE_STDERR = 'true';
       }
-      if (forwardOutput) {
-        env.NX_FORWARD_OUTPUT = 'true';
+      if (streamOutput) {
+        env.NX_STREAM_OUTPUT = 'true';
       }
     }
     return env;
@@ -296,7 +304,7 @@ export class ForkedProcessTaskRunner {
     task: Task,
     forceColor: string,
     outputPath: string,
-    forwardOutput: boolean
+    streamOutput: boolean
   ) {
     const env: NodeJS.ProcessEnv = {
       NX_TASK_TARGET_PROJECT: task.target.project,
@@ -312,7 +320,7 @@ export class ForkedProcessTaskRunner {
       ...this.getNxEnvVariablesForForkedProcess(
         forceColor,
         outputPath,
-        forwardOutput
+        streamOutput
       ),
       ...env,
     };