feat: yarn run --json (#5988)

**What's the problem this PR addresses?**
Adds a `--json` option to the `yarn run` CLI command

Closes #5539 

**How did you fix it?**
Changed the command object defined in
berry/packages/plugin-essentials/sources/commands/runindex.ts in order
to add a `--json` option, and format the output.

**Checklist**
- [x] I have read the [Contributing
Guide](https://yarnpkg.com/advanced/contributing).
- [x] I have set the packages that need to be released for my changes to
be effective.
- [x] I will check that all automated PR checks pass before the PR gets
reviewed.

---------

Co-authored-by: Maël Nison <[email protected]>

Author: jplukas

.yarn/versions/4db9f07d.yml

@@ -0,0 +1,23 @@
+releases:
+  "@yarnpkg/cli": minor
+  "@yarnpkg/plugin-essentials": minor
+
+declined:
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-constraints"
+  - "@yarnpkg/plugin-dlx"
+  - "@yarnpkg/plugin-init"
+  - "@yarnpkg/plugin-interactive-tools"
+  - "@yarnpkg/plugin-nm"
+  - "@yarnpkg/plugin-npm-cli"
+  - "@yarnpkg/plugin-pack"
+  - "@yarnpkg/plugin-patch"
+  - "@yarnpkg/plugin-pnp"
+  - "@yarnpkg/plugin-pnpm"
+  - "@yarnpkg/plugin-stage"
+  - "@yarnpkg/plugin-typescript"
+  - "@yarnpkg/plugin-version"
+  - "@yarnpkg/plugin-workspace-tools"
+  - "@yarnpkg/builder"
+  - "@yarnpkg/core"
+  - "@yarnpkg/doctor"

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

@@ -1,4 +1,5 @@
 import {ppath, xfs} from '@yarnpkg/fslib';
+import {misc}       from 'pkg-tests-core';
 
 describe(`Commands`, () => {
   for (const [description, args] of [[`with prefix`, [`run`]], [`without prefix`, []]]) {
@@ -158,6 +159,27 @@ describe(`Commands`, () => {
         },
       ),
     );
+    test(`it should print the list of available scripts as JSON if no parameters passed to command`,
+      makeTemporaryEnv(
+        {
+          scripts: {
+            foo: `echo hello`,
+            bar: `echo hi`,
+          },
+        },
+        async ({path, run, source}) => {
+          const {stdout} = await run(`run`, `--json`);
+
+          expect(misc.parseJsonStream(stdout)).toEqual([{
+            name: `foo`,
+            script: `echo hello`,
+          }, {
+            name: `bar`,
+            script: `echo hi`,
+          }]);
+        },
+      ),
+    );
 
     test(`it should normalize scoped bin entries`,
       makeTemporaryEnv(

packages/plugin-essentials/sources/commands/runIndex.ts

@@ -1,6 +1,7 @@
 import {BaseCommand, WorkspaceRequiredError}  from '@yarnpkg/cli';
 import {Configuration, Project, StreamReport} from '@yarnpkg/core';
 import {miscUtils}                            from '@yarnpkg/core';
+import {Option}                               from 'clipanion';
 import {inspect}                              from 'util';
 
 // eslint-disable-next-line arca/no-default-export
@@ -9,6 +10,10 @@ export default class RunIndexCommand extends BaseCommand {
     [`run`],
   ];
 
+  json = Option.Boolean(`--json`, false, {
+    description: `Format the output as an NDJSON stream`,
+  });
+
   async execute() {
     const configuration = await Configuration.find(this.context.cwd, this.context.plugins);
     const {project, workspace} = await Project.find(configuration, this.context.cwd);
@@ -19,6 +24,7 @@ export default class RunIndexCommand extends BaseCommand {
     const report = await StreamReport.start({
       configuration,
       stdout: this.context.stdout,
+      json: this.json,
     }, async report => {
       const scripts = workspace!.manifest.scripts;
       const keys = miscUtils.sortMap(scripts.keys(), key => key);
@@ -32,8 +38,9 @@ export default class RunIndexCommand extends BaseCommand {
         return Math.max(max, key.length);
       }, 0);
 
-      for (const [key, value] of scripts.entries()) {
-        report.reportInfo(null, `${key.padEnd(maxKeyLength, ` `)}   ${inspect(value, inspectConfig)}`);
+      for (const [key, script] of scripts.entries()) {
+        report.reportInfo(null, `${key.padEnd(maxKeyLength, ` `)}   ${inspect(script, inspectConfig)}`);
+        report.reportJson({name: key, script});
       }
     });