feat(essentials): Add --no-private flag to list command (#4830)

Author: RDIL

.yarn/versions/5fb9cb98.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/workspaces/list.test.js

@@ -159,6 +159,39 @@ describe(`Commands`, () => {
       }),
     );
 
+    test(
+      `--no-private excludes private workspaces`,
+      makeTemporaryEnv({
+        private: true,
+        workspaces: [`packages/*`],
+      }, async ({run, path}) => {
+        await writeJson(`${path}/packages/workspace-a/package.json`, {
+          name: `workspace-a`,
+          private: true,
+          version: `1.0.0`,
+        });
+
+        await writeJson(`${path}/packages/workspace-b/package.json`, {
+          name: `workspace-b`,
+          version: `1.0.0`,
+        });
+
+        await expect(
+          parseJsonStream(
+            (await run(`workspaces`, `list`, `-v`, `--no-private`, `--json`)).stdout,
+            `location`,
+          ),
+        ).toEqual({
+          [`packages/workspace-b`]: {
+            location: `packages/workspace-b`,
+            name: `workspace-b`,
+            workspaceDependencies: [],
+            mismatchedWorkspaceDependencies: [],
+          },
+        });
+      }),
+    );
+
     test(
       `--since returns only changed workspaces`,
       makeWorkspacesListSinceEnv(async ({path, run}) => {

packages/plugin-essentials/sources/commands/workspaces/list.ts

@@ -19,6 +19,8 @@ export default class WorkspacesListCommand extends BaseCommand {
 
       - If \`-R,--recursive\` is set, Yarn will find workspaces to run the command on by recursively evaluating \`dependencies\` and \`devDependencies\` fields, instead of looking at the \`workspaces\` fields.
 
+      - If \`--no-private\` is set, Yarn will not list any workspaces that have the \`private\` field set to \`true\`.
+
       - If both the \`-v,--verbose\` and \`--json\` options are set, Yarn will also return the cross-dependencies between each workspaces (useful when you wish to automatically generate Buck / Bazel rules).
     `,
   });
@@ -32,6 +34,10 @@ export default class WorkspacesListCommand extends BaseCommand {
     description: `Find packages via dependencies/devDependencies instead of using the workspaces field`,
   });
 
+  noPrivate = Option.Boolean(`--no-private`, {
+    description: `Exclude workspaces that have the private field set to true`,
+  });
+
   verbose = Option.Boolean(`-v,--verbose`, false, {
     description: `Also return the cross-dependencies between workspaces`,
   });
@@ -62,6 +68,9 @@ export default class WorkspacesListCommand extends BaseCommand {
       for (const workspace of workspaces) {
         const {manifest} = workspace;
 
+        if (manifest.private && this.noPrivate)
+          continue;
+
         let extra;
         if (this.verbose) {
           const workspaceDependencies = new Set<Workspace>();