feat(essentials): add preferReuse setting (#4221)

* feat: expose preferReuse and preferCached

* chore: add release data

* remove preferCached

* remove preferCached from config

* set all release strategies

* add default

* add test

* remove unused

* docs: improve explanation

Co-authored-by: Kristoffer K. <merceyz@users.noreply.github.com>

* style: inline type predicate

Co-authored-by: Kristoffer K. <merceyz@users.noreply.github.com>

* refactor: remove unused

Co-authored-by: Kristoffer K. <merceyz@users.noreply.github.com>

* fix: move preferReuse config

* refactor: use makeTemporaryEnv config creator

* fix: remove unused

* docs: improve explanation

Co-authored-by: Kristoffer K. <merceyz@users.noreply.github.com>

* fix: escape `

Co-authored-by: Kristoffer K. <merceyz@users.noreply.github.com>
(cherry picked from commit 5681a5f)

Author: marionebl

.yarn/versions/efc24e59.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/add.test.ts

@@ -215,6 +215,23 @@ describe(`Commands`, () => {
       }),
     );
 
+    test(
+      `it should not upgrade the existing dependency in the current project for preferReuse`,
+      makeTemporaryEnv({
+        devDependencies: {
+          [`no-deps`]: `1.0.0`,
+        },
+      }, {preferReuse: true}, async ({path, run, source}) => {
+        await run(`add`, `no-deps`);
+
+        await expect(xfs.readJsonPromise(`${path}/package.json` as PortablePath)).resolves.toMatchObject({
+          devDependencies: {
+            [`no-deps`]: `1.0.0`,
+          },
+        });
+      }),
+    );
+
     test(
       `it should add a new peer dependency to the current project`,
       makeTemporaryEnv({}, async ({path, run, source}) => {

packages/gatsby/static/configuration/yarnrc.json

@@ -695,6 +695,12 @@
       "type": "boolean",
       "default": false
     },
+    "preferReuse": {
+      "_package": "@yarnpkg/plugin-essentials",
+      "description": "If true, `yarn add` will attempt to reuse the most common dependency range in other workspaces.",
+      "type": "boolean",
+      "default": false
+    },
     "preferTruncatedLines": {
       "_package": "@yarnpkg/core",
       "description": "If true, Yarn will truncate lines that would go beyond the size of the terminal. If progress bars are disabled, lines will never be truncated. Forgettable lines (e.g. the fetch step logs) are always truncated.",

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

@@ -128,19 +128,23 @@ export default class AddCommand extends BaseCommand {
     });
 
     const interactive = this.interactive ?? configuration.get(`preferInteractive`);
+    const reuse = interactive || configuration.get(`preferReuse`);
 
     const modifier = suggestUtils.getModifier(this, project);
 
     const strategies = [
-      ...interactive ? [
-        suggestUtils.Strategy.REUSE,
-      ] : [],
+      reuse ?
+        suggestUtils.Strategy.REUSE
+        : undefined,
+
       suggestUtils.Strategy.PROJECT,
-      ...this.cached ? [
-        suggestUtils.Strategy.CACHE,
-      ] : [],
+
+      this.cached ?
+        suggestUtils.Strategy.CACHE
+        : undefined,
+
       suggestUtils.Strategy.LATEST,
-    ];
+    ].filter((strategy): strategy is suggestUtils.Strategy => typeof strategy !== `undefined`);
 
     const maxResults = interactive
       ? Infinity

packages/plugin-essentials/sources/index.ts

@@ -108,6 +108,7 @@ declare module '@yarnpkg/core' {
     // One in packages/plugin-essentials and one virtual package.
     // Defining this property with two different enum instances leads to a compiler error.
     defaultSemverRangePrefix: `^` | `~` | ``;
+    preferReuse: boolean;
   }
 }
 
@@ -125,6 +126,12 @@ const plugin: Plugin = {
       values: [`^`, `~`, ``],
       default: suggestUtils.Modifier.CARET,
     },
+
+    preferReuse: {
+      description: `If true, \`yarn add\` will attempt to reuse the most common dependency range in other workspaces.`,
+      type: SettingsType.BOOLEAN,
+      default: false,
+    },
   },
   commands: [
     cleanCache,