Add --label argument to workspaces foreach.

Author: seansfkelley

packages/acceptance-tests/pkg-tests-specs/sources/commands/workspaces/__snapshots__/foreach.test.js.snap

@@ -186,6 +186,42 @@ Done
 }
 `;
 
+exports[`Commands workspace foreach should not prefix the output when run with --verbose and --no-label 1`] = `
+{
+  "code": 0,
+  "stderr": "",
+  "stdout": "Process started
+Test Workspace A
+Process exited (exit code 0)
+
+Process started
+Test Workspace B
+Process exited (exit code 0)
+
+Process started
+Test Workspace C
+Process exited (exit code 0)
+
+Process started
+Test Workspace D
+Process exited (exit code 0)
+
+Process started
+Test Workspace E
+Process exited (exit code 0)
+
+Process started
+Test Workspace F
+Process exited (exit code 0)
+
+Process started
+Test Workspace G
+Process exited (exit code 0)
+Done
+",
+}
+`;
+
 exports[`Commands workspace foreach should only run the scripts on workspaces that match the --include list 1`] = `
 {
   "code": 0,
@@ -230,7 +266,7 @@ Done
 }
 `;
 
-exports[`Commands workspace foreach should prefix the output with run with --verbose 1`] = `
+exports[`Commands workspace foreach should prefix the output and including timing information when run with --verbose 1`] = `
 {
   "code": 0,
   "stderr": "",
@@ -266,6 +302,22 @@ Done
 }
 `;
 
+exports[`Commands workspace foreach should prefix the output when run with --label 1`] = `
+{
+  "code": 0,
+  "stderr": "",
+  "stdout": "[workspace-a]: Test Workspace A
+[workspace-b]: Test Workspace B
+[workspace-c]: Test Workspace C
+[workspace-d]: Test Workspace D
+[workspace-e]: Test Workspace E
+[workspace-f]: Test Workspace F
+[workspace-g]: Test Workspace G
+Done
+",
+}
+`;
+
 exports[`Commands workspace foreach should run execute global scripts even on workspaces that don't declare them 1`] = `
 {
   "code": 0,

packages/acceptance-tests/pkg-tests-specs/sources/commands/workspaces/foreach.test.js

@@ -216,8 +216,25 @@ describe(`Commands`, () => {
       ),
     );
 
+
+    test(
+      `should prefix the output when run with --label`,
+      makeTemporaryEnv(
+        {
+          private: true,
+          workspaces: [`packages/*`],
+        },
+        async ({path, run}) => {
+          await setupWorkspaces(path);
+          await run(`install`);
+
+          await expect(run(`workspaces`, `foreach`, `--all`, `--label`, `run`, `print`)).resolves.toMatchSnapshot();
+        },
+      ),
+    );
+
     test(
-      `should prefix the output with run with --verbose`,
+      `should prefix the output and including timing information when run with --verbose`,
       makeTemporaryEnv(
         {
           private: true,
@@ -232,6 +249,22 @@ describe(`Commands`, () => {
       ),
     );
 
+    test(
+      `should not prefix the output when run with --verbose and --no-label`,
+      makeTemporaryEnv(
+        {
+          private: true,
+          workspaces: [`packages/*`],
+        },
+        async ({path, run}) => {
+          await setupWorkspaces(path);
+          await run(`install`);
+
+          await expect(run(`workspaces`, `foreach`, `--all`, `--verbose`, `--no-label`, `run`, `print`)).resolves.toMatchSnapshot();
+        },
+      ),
+    );
+
     test(
       `should not include the prefix or a ➤ character when run with --no-verbose`,
       makeTemporaryEnv(

packages/plugin-workspace-tools/sources/commands/foreach.ts

@@ -42,7 +42,9 @@ export default class WorkspacesForeachCommand extends BaseCommand {
 
       - The command may apply to only some workspaces through the use of \`--include\` which acts as a whitelist. The \`--exclude\` flag will do the opposite and will be a list of packages that mustn't execute the script. Both flags accept glob patterns (if valid Idents and supported by [micromatch](https://github.com/micromatch/micromatch)). Make sure to escape the patterns, to prevent your own shell from trying to expand them.
 
-      Adding the \`-v,--verbose\` flag (automatically enabled in interactive terminal environments) will cause Yarn to print more information; in particular the name of the workspace that generated the output will be printed at the front of each line.
+      The \`-l,--label\` flag will prefix all output with the name of the workspace that generated it.
+
+      The \`-v,--verbose\` flag (automatically enabled in interactive terminal environments) implies \`-l,--label\` and will additionally include start/stop and timing information.
 
       If the command is \`run\` and the script being run does not exist the child workspace will be skipped without error.
     `,
@@ -83,10 +85,14 @@ export default class WorkspacesForeachCommand extends BaseCommand {
     description: `Run the command on all workspaces of the current worktree`,
   });
 
-  verbose = Option.Boolean(`-v,--verbose`, {
+  label = Option.Boolean(`-l,--label`, {
     description: `Prefix each output line with the name of the originating workspace`,
   });
 
+  verbose = Option.Boolean(`-v,--verbose`, {
+    description: `Include start/top and timing information in output; implies \`-l,--label\``,
+  });
+
   parallel = Option.Boolean(`-p,--parallel`, false, {
     description: `Run the commands in parallel`,
   });
@@ -277,6 +283,7 @@ export default class WorkspacesForeachCommand extends BaseCommand {
 
     // --verbose is automatically enabled in TTYs
     const verbose = this.verbose ?? (this.context.stdout as WriteStream).isTTY;
+    const label = this.label ?? this.verbose;
 
     const concurrency = this.parallel ?
       (this.jobs === `unlimited`
@@ -311,14 +318,14 @@ export default class WorkspacesForeachCommand extends BaseCommand {
         if (!parallel && verbose && commandIndex > 1)
           report.reportSeparator();
 
-        const prefix = getPrefix(workspace, {configuration, verbose, commandIndex});
+        const prefix = getPrefix(workspace, {configuration, label, commandIndex});
 
         const [stdout, stdoutEnd] = createStream(report, {prefix, interlaced});
         const [stderr, stderrEnd] = createStream(report, {prefix, interlaced});
 
         try {
           if (verbose)
-            report.reportInfo(null, `${prefix} Process started`);
+            report.reportInfo(null, `${prefix ? `${prefix} ` : ``}Process started`);
 
           const start = Date.now();
 
@@ -337,7 +344,7 @@ export default class WorkspacesForeachCommand extends BaseCommand {
           const end = Date.now();
           if (verbose) {
             const timerMessage = configuration.get(`enableTimers`) ? `, completed in ${formatUtils.pretty(configuration, end - start, formatUtils.Type.DURATION)}` : ``;
-            report.reportInfo(null, `${prefix} Process exited (exit code ${exitCode})${timerMessage}`);
+            report.reportInfo(null, `${prefix ? `${prefix} ` : ``}Process exited (exit code ${exitCode})${timerMessage}`);
           }
 
           if (exitCode === 130) {
@@ -475,11 +482,11 @@ function createStream(report: Report, {prefix, interlaced}: {prefix: string | nu
 type GetPrefixOptions = {
   configuration: Configuration;
   commandIndex: number;
-  verbose: boolean;
+  label: boolean;
 };
 
-function getPrefix(workspace: Workspace, {configuration, commandIndex, verbose}: GetPrefixOptions) {
-  if (!verbose)
+function getPrefix(workspace: Workspace, {configuration, commandIndex, label}: GetPrefixOptions) {
+  if (!label)
     return null;
 
   const name = structUtils.stringifyIdent(workspace.anchoredLocator);