yarn-berry-deduplicate 2.0.0 → 6.0.2

package/README.md

@@ -1,29 +1,38 @@
-Builds: [![CircleCI](https://circleci.com/gh/atlassian/yarn-deduplicate.svg?style=svg)](https://circleci.com/gh/atlassian/yarn-deduplicate)
-
-# Yarn deduplicate
+# yarn-deduplicate
 
 Cleans up `yarn.lock` by removing duplicates.
 
+Builds:
+[![Node.js CI](https://github.com/scinos/yarn-deduplicate/actions/workflows/node.js.yml/badge.svg)](https://github.com/scinos/yarn-deduplicate/actions/workflows/node.js.yml)
+
+This package only works with Yarn v1. Yarn v2 supports package deduplication
+[natively](https://github.com/yarnpkg/berry/pull/1558)!
+
 A duplicate package is when two dependencies are resolved to a different version, even when a single
-version matches the range specified in the dependencies. See the [Deduplication
-strategies](#deduplication-strategies) section for a few examples.
+version matches the range specified in the dependencies. See the
+[Deduplication strategies](#deduplication-strategies) section for a few examples.
 
 ## Installation
 
 Install the package globally:
 
-```bash
+```sh
 npm install -g yarn-deduplicate
 ```
 
 or
 
-```bash
+```sh
 yarn global add yarn-deduplicate
 ```
 
-This package also works wth [npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b),
-so you don't need to install it.
+This package also works wth
+[npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b), so you
+don't need to install it. For example, to recreate the most common scenario below with `npx`, run:
+
+```sh
+npx yarn-deduplicate yarn.lock
+```
 
 ---
 
@@ -31,7 +40,7 @@ so you don't need to install it.
 
 The most common scenario is to run
 
-```bash
+```sh
 yarn-deduplicate yarn.lock
 ```
 
@@ -41,7 +50,7 @@ If you do not specify the yarn.lock path, it defaults to `yarn.lock`.
 
 Check all available options with:
 
-```bash
+```sh
 yarn-deduplicate --help
 ```
 
@@ -77,7 +86,7 @@ https://classic.yarnpkg.com/en/docs/cli/dedupe/, it says
 
 > The dedupe command isn’t necessary. `yarn install` will already dedupe.
 
-This is, however, not exactly true. There are cases where yarn will *not* deduplicate existing
+This is, however, not exactly true. There are cases where yarn will _not_ deduplicate existing
 packages. For example, this scenario:
 
 - Install `libA`. It depends on `libB ^1.1.0`. At this point, the latest version of `libB` is
@@ -89,48 +98,49 @@ packages. For example, this scenario:
 In the above scenario, you'll end up with `libB@1.1.2` and `libB@1.1.3` in your repo.
 
 Find more examples in:
+
 - [yarn-deduplicate — The Hero We Need](https://medium.com/@bnaya/yarn-deduplicate-the-hero-we-need-f4497a362128)
 - [De-duplicating yarn.lock](https://medium.com/@scinos/de-duplicating-yarn-lock-ae30be4aa41a)
 - https://github.com/yarnpkg/yarn/issues/3778
 
 ### Deduplication strategies
 
-`highest`
-It will try to use the highest installed version. For example, with the following `yarn.lock`:
+`--strategy <strategy>`
 
-```
+`highest` will try to use the highest installed version. For example, with the following
+`yarn.lock`:
+
+```text
 library@^1.1.0:
-    version "1.2.0"
+  version "1.2.0"
 
 library@^1.2.0:
-    version "1.2.0"
+  version "1.2.0"
 
 library@^1.3.0:
-    version "1.3.0"
+  version "1.3.0"
 ```
 
 It will deduplicate `library@^1.1.0` and `library@^1.2.0` to `1.3.0`
 
-`fewer`
-It will try to minimize the number of installed versions by trying to deduplicate to the version
-that satisfies most of the ranges first. For example, with the following `yarn.lock`:
+`fewer` will try to minimize the number of installed versions by trying to deduplicate to the
+version that satisfies most of the ranges first. For example, with the following `yarn.lock`:
 
-```
+```text
 library@*:
-    version "2.0.0"
+  version "2.0.0"
 
 library@>=1.1.0:
-    version "3.0.0"
+  version "3.0.0"
 
 library@^1.2.0:
-    version "1.2.0"
+  version "1.2.0"
 ```
 
 It will deduplicate `library@*` and `library@>=1.1.0` to `1.2.0`.
 
-Note that this will cause some packages to **downgrade** it version. Be sure to check the changelogs
-between all versions and understand the consequences of that downgrade. If unsure, don't use this
-strategy.
+Note that this may cause some packages to be **downgraded**. Be sure to check the changelogs between
+all versions and understand the consequences of that downgrade. If unsure, don't use this strategy.
 
 It is not recommended to use different strategies for different packages. There is no guarantee that
 the strategy will be honored in subsequent runs of `yarn-deduplicate` unless the same set of flags
@@ -141,14 +151,78 @@ is specified again.
 `--packages <package1> <package2> <packageN>`
 
 Receives a list of packages to deduplicate. It will ignore any other duplicated package not in the
-list. This option is recommended when the number of duplicated packages in `yarn.lock` is too big
-to be easily reviewed by a human. This will allow for a more controlled and progressive
-deduplication of `yarn.lock`.
+list. This option is recommended when the number of duplicated packages in `yarn.lock` is too big to
+be easily reviewed by a human. This will allow for a more controlled and progressive deduplication
+of `yarn.lock`.
+
+`--scopes <scope1> <scope2> <scopeN>`
+
+Receives a list of scopes to deduplicate. It will ignore any other duplicated package not in the
+list. This option is recommended when deduplicating a large number of inter-dependent packages from
+a single scope, such as @babel. This will allow for a more controlled and progressive deduplication
+of `yarn.lock` without specifying each package individually.
+
+### Excluding packages
+
+`--exclude <package1> <package2> <packageN`
+
+`--exclude-scopes <scope1> <scope2> <scopeN>`
+
+With these commands you can exclude certain packages/scopes from the deduplication process. This is
+specially useful if you want to apply a different strategy for a scope, for example.
+
+### Pre-release versions
+
+By default, `yarn-deduplicate` will only match pre-release versions if they share they share the
+same `major`, `minor` and `patch` versions (example: `^1.2.3-alpha.1` and `1.2.3-alpha.2` can be
+deduplicated, but `^1.2.3` and `1.2.4-alpha.1` can't). This matches the behaviour of
+[semver](https://docs.npmjs.com/misc/semver#prerelease-tags).
+
+To change this behaviour you can use the flag `--includePrerelease`. This will treat all pre-release
+versionas as if they were normal versions (`^1.2.3` and `1.2.4-alpha.1` can be deduplicated).
+
+### Usage in CI
+
+This tool can be used as part of a CI workflow. Adding the flag `--fail` will force the process to
+exit with status 1 if there are duplicated packages. Example:
+
+```sh
+# Print the list of duplicated packages and exit with status 1
+yarn-deduplicate --list --fail
+
+# Deduplicate yarn.lock and exit with status 1 if changes were required
+yarn-deduplicate --fail
+```
 
 ---
 
 ## Migration guide
 
+### From 2.x to 3.x
+
+In this version we have adopted variadic arguments from commander.js. These are the equivalent
+commands:
+
+```sh
+#Old
+yarn-deduplicate --packages libA,libB
+yarn-deduplicate --scopes @scopeA,@scopeB
+yarn-deduplicate --exclude libA,libB
+
+#New
+yarn-deduplicate --packages libA libB
+yarn-deduplicate --scopes @scopeA @scopeB
+yarn-deduplicate --exclude libA libB
+```
+
+A consequence of this change is that if you were using one or more of the affected options (
+`--packages`, `--scopes` or `--exclude`) **and** a custom path for `yarn.lock`, you need to use `--`
+to "stop" package/scope/exclude parsing:
+
+```sh
+yarn-deduplicate --packages libA libB -- path/to/yarn.lock
+```
+
 ### From 0.x to 1.x
 
 In this version we have renamed the project and refactored the CLI. These are the equivalent
@@ -156,7 +230,7 @@ commands:
 
 #### Installation
 
-```bash
+```sh
 # Old
 npm install -g yarn-tools
 
@@ -166,7 +240,7 @@ npm install -g yarn-deduplicate
 
 #### List duplicates
 
-```bash
+```sh
 # Old
 yarn-tools list-duplicates path/to/yarn.lock
 
@@ -175,7 +249,8 @@ yarn-deduplicate --list path/to/yarn.lock
 ```
 
 ### Deduplicate yarn.lock
-```bash
+
+```sh
 # Old
 yarn-tools fix-duplicates path/to/yarn.lock > tmp
 mv tmp path/to/yarn.lock
@@ -184,9 +259,9 @@ mv tmp path/to/yarn.lock
 yarn-deduplicate path/to/yarn.lock
 ```
 
-
 ### Limit packages to deduplicate yarn.lock
-```bash
+
+```sh
 # Old
 yarn-tools fix-duplicates path/to/yarn.lock package1 package2
 
@@ -195,35 +270,7 @@ yarn-tools fix-duplicates path/to/yarn.lock package1 package2
 yarn-deduplicate --packages package1,package2 path/to/yarn.lock
 ```
 
-
-## Contributors
-
-Pull requests, issues and comments welcome. For pull requests:
-
-* Add tests for new features and bug fixes
-* Follow the existing style
-* Separate unrelated changes into multiple pull requests
-
-See the existing issues for things to start contributing.
-
-For bigger changes, make sure you start a discussion first by creating
-an issue and explaining the intended change.
-
-Atlassian requires contributors to sign a Contributor License Agreement,
-known as a CLA. This serves as a record stating that the contributor is
-entitled to contribute the code/documentation/translation to the project
-and is willing to have it used in distributions and derivative works
-(or is willing to transfer ownership).
-
-Prior to accepting your contributions we ask that you please follow the appropriate
-link below to digitally sign the CLA. The Corporate CLA is for those who are
-contributing as a member of an organization and the individual CLA is for
-those contributing as an individual.
-
-* [CLA for corporate contributors](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=e1c17c66-ca4d-4aab-a953-2c231af4a20b)
-* [CLA for individuals](https://na2.docusign.net/Member/PowerFormSigning.aspx?PowerFormId=3f94fbdc-2fbe-46ac-b14c-5d152700ae5d)
-
 ## License
 
-Copyright (c) 2017 Atlassian and others.
-Apache 2.0 licensed, see [LICENSE.txt](LICENSE.txt) file.
+Copyright (c) 2022 Sergio Cinos and others. Apache 2.0 licensed, see [LICENSE.txt](LICENSE.txt)
+file.

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,95 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const commander_1 = require("commander");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const index_js_1 = require("./index.js");
+const version = require('../package.json').version;
+const FAIL_MESSAGE = '\nFound duplicated entries. Run yarn-deduplicate to deduplicate them.';
+commander_1.program
+    .version(version)
+    .usage('[options] [yarn.lock path (default: yarn.lock)]')
+    .option('-s, --strategy <strategy>', 'deduplication strategy. Valid values: fewer, highest, both. Default is "both"', 'both')
+    .option('-l, --list', 'do not change yarn.lock, just output the diagnosis')
+    .option('-f, --fail', 'if there are duplicates in yarn.lock, terminate the script with exit status 1')
+    .option('--scopes <scopes...>', 'a list of scopes to deduplicate. Defaults to all packages.')
+    .option('--packages <packages...>', 'a list of packages to deduplicate. Defaults to all packages.')
+    .option('--exclude <exclude...>', 'a list of packages not to deduplicate.')
+    .option('--exclude-scopes <excluded scopes...>', 'a list of scopes not to deduplicate.')
+    .option('--print', 'instead of saving the deduplicated yarn.lock, print the result in stdout')
+    .option('--includePrerelease', 'Include prereleases in version comparisons, e.g. ^1.0.0 will be satisfied by 1.0.1-alpha');
+commander_1.program.parse(process.argv);
+const { strategy, scopes, packages, exclude, excludeScopes, list, fail, includePrerelease, print, noStats, } = commander_1.program.opts();
+const file = commander_1.program.args.length ? commander_1.program.args[0] : 'yarn.lock';
+if (scopes && packages) {
+    console.error('Please specify either scopes or packages, not both.');
+    commander_1.program.help();
+}
+if (strategy !== 'highest' && strategy !== 'fewer' && strategy !== 'both') {
+    console.error(`Invalid strategy ${strategy}`);
+    commander_1.program.help();
+}
+try {
+    const yarnLock = fs_1.default.readFileSync(file, 'utf8');
+    const useMostCommon = strategy === 'fewer';
+    if (list) {
+        if (strategy !== 'highest' && strategy !== 'fewer') {
+            console.error(`Invalid strategy ${strategy}`);
+            commander_1.program.help();
+        }
+        const duplicates = (0, index_js_1.listDuplicates)(yarnLock, {
+            useMostCommon,
+            includeScopes: scopes,
+            includePackages: packages,
+            excludePackages: exclude,
+            excludeScopes: excludeScopes,
+            includePrerelease: includePrerelease,
+        });
+        duplicates.forEach((logLine) => console.log(logLine));
+        if (fail && duplicates.length > 0) {
+            console.error(FAIL_MESSAGE);
+            process.exit(1);
+        }
+    }
+    else {
+        let dedupedYarnLock = (0, index_js_1.fixDuplicates)(yarnLock, {
+            useMostCommon,
+            includeScopes: scopes,
+            includePackages: packages,
+            excludePackages: exclude,
+            excludeScopes: excludeScopes,
+            includePrerelease: includePrerelease,
+        });
+        if (strategy === 'both') {
+            dedupedYarnLock = (0, index_js_1.fixDuplicates)(yarnLock, {
+                useMostCommon: false,
+                includeScopes: scopes,
+                includePackages: packages,
+                excludePackages: exclude,
+                excludeScopes: excludeScopes,
+                includePrerelease: includePrerelease,
+            });
+        }
+        if (print) {
+            console.log(dedupedYarnLock);
+        }
+        else {
+            const eolMatch = yarnLock.match(/(\r?\n)/);
+            if (eolMatch && eolMatch[0] === '\r\n') {
+                dedupedYarnLock = dedupedYarnLock.replace(/\n/g, '\r\n');
+            }
+            fs_1.default.writeFileSync(file, dedupedYarnLock);
+        }
+        if (fail && yarnLock !== dedupedYarnLock) {
+            console.error(FAIL_MESSAGE);
+            process.exit(1);
+        }
+    }
+    process.exit(0);
+}
+catch (e) {
+    console.error(e);
+    process.exit(1);
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";;;;AAEA,yCAAoC;AACpC,oDAAoB;AAEpB,yCAA2D;AAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC;AAEnD,MAAM,YAAY,GAAG,uEAAuE,CAAC;AAE7F,mBAAO;KACF,OAAO,CAAC,OAAO,CAAC;KAChB,KAAK,CAAC,iDAAiD,CAAC;KACxD,MAAM,CACH,2BAA2B,EAC3B,+EAA+E,EAC/E,MAAM,CACT;KACA,MAAM,CAAC,YAAY,EAAE,oDAAoD,CAAC;KAC1E,MAAM,CACH,YAAY,EACZ,+EAA+E,CAClF;KACA,MAAM,CAAC,sBAAsB,EAAE,4DAA4D,CAAC;KAC5F,MAAM,CACH,0BAA0B,EAC1B,8DAA8D,CACjE;KACA,MAAM,CAAC,wBAAwB,EAAE,wCAAwC,CAAC;KAC1E,MAAM,CAAC,uCAAuC,EAAE,sCAAsC,CAAC;KACvF,MAAM,CAAC,SAAS,EAAE,0EAA0E,CAAC;KAC7F,MAAM,CACH,qBAAqB,EACrB,0FAA0F,CAC7F,CAAC;AAEF,mBAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAEhC,MAAM,EACF,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,OAAO,EACP,aAAa,EACb,IAAI,EACJ,IAAI,EACJ,iBAAiB,EACjB,KAAK,EACL,OAAO,GACV,GAAG,mBAAO,CAAC,IAAI,EAAE,CAAC;AAEnB,MAAM,IAAI,GAAG,mBAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,mBAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;AAEjE,IAAI,MAAM,IAAI,QAAQ,EAAE;IACpB,OAAO,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAC;IACrE,mBAAO,CAAC,IAAI,EAAE,CAAC;CAClB;AAED,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,OAAO,IAAI,QAAQ,KAAK,MAAM,EAAE;IACvE,OAAO,CAAC,KAAK,CAAC,oBAAoB,QAAQ,EAAE,CAAC,CAAC;IAC9C,mBAAO,CAAC,IAAI,EAAE,CAAC;CAClB;AAED,IAAI;IACA,MAAM,QAAQ,GAAG,YAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,QAAQ,KAAK,OAAO,CAAC;IAE3C,IAAI,IAAI,EAAE;QACN,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,OAAO,EAAE;YAChD,OAAO,CAAC,KAAK,CAAC,oBAAoB,QAAQ,EAAE,CAAC,CAAC;YAC9C,mBAAO,CAAC,IAAI,EAAE,CAAC;SAClB;QAED,MAAM,UAAU,GAAG,IAAA,yBAAc,EAAC,QAAQ,EAAE;YACxC,aAAa;YACb,aAAa,EAAE,MAAM;YACrB,eAAe,EAAE,QAAQ;YACzB,eAAe,EAAE,OAAO;YACxB,aAAa,EAAE,aAAa;YAC5B,iBAAiB,EAAE,iBAAiB;SACvC,CAAC,CAAC;QACH,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;QACtD,IAAI,IAAI,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACnB;KACJ;SAAM;QACH,IAAI,eAAe,GAAG,IAAA,wBAAa,EAAC,QAAQ,EAAE;YAC1C,aAAa;YACb,aAAa,EAAE,MAAM;YACrB,eAAe,EAAE,QAAQ;YACzB,eAAe,EAAE,OAAO;YACxB,aAAa,EAAE,aAAa;YAC5B,iBAAiB,EAAE,iBAAiB;SACvC,CAAC,CAAC;QAEH,IAAI,QAAQ,KAAK,MAAM,EAAE;YACrB,eAAe,GAAG,IAAA,wBAAa,EAAC,QAAQ,EAAE;gBACtC,aAAa,EAAE,KAAK;gBACpB,aAAa,EAAE,MAAM;gBACrB,eAAe,EAAE,QAAQ;gBACzB,eAAe,EAAE,OAAO;gBACxB,aAAa,EAAE,aAAa;gBAC5B,iBAAiB,EAAE,iBAAiB;aACvC,CAAC,CAAC;SACN;QAED,IAAI,KAAK,EAAE;YACP,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;SAChC;aAAM;YACH,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YAC3C,IAAI,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE;gBACpC,eAAe,GAAG,eAAe,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;aAC5D;YACD,YAAE,CAAC,aAAa,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;SAC3C;QAED,IAAI,IAAI,IAAI,QAAQ,KAAK,eAAe,EAAE;YACtC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC5B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACnB;KACJ;IAED,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CACnB;AAAC,OAAO,CAAC,EAAE;IACR,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CACnB"}

package/dist/index.d.ts

@@ -0,0 +1,44 @@
+import { Descriptor } from '@yarnpkg/core';
+type YarnEntry = {
+    version: string;
+    resolution: string;
+    dependencies?: Record<string, string>;
+    checksum?: string;
+    languageName?: 'node';
+    linkType?: 'hard' | 'soft';
+};
+type Packages = Record<string, Package[]>;
+type Package = {
+    installedVersion: string;
+    packageKey: string;
+    packageName: string;
+    pkg: YarnEntry;
+    ignored: boolean;
+    descriptorString: string;
+    descriptor: Descriptor;
+    satisfiedBy: Set<string>;
+    candidateVersions?: string[];
+    requestedProtocol: string;
+    requestedVersion: string;
+    bestVersion?: string;
+    versions: Versions;
+};
+type Version = {
+    pkg: YarnEntry;
+    satisfies: Set<Package>;
+};
+type Versions = Map<string, Version>;
+type Options = {
+    includeScopes?: string[];
+    includePackages?: string[];
+    excludePackages?: string[];
+    excludeScopes?: string[];
+    useMostCommon?: boolean;
+    includePrerelease?: boolean;
+};
+export declare const getBest: (packages: Packages, options?: Options) => Package[];
+export declare const getDuplicates: (packages: Packages, options?: Options) => Package[];
+export declare const listDuplicates: (yarnLock: string, options?: Options) => string[];
+export declare const fixDuplicates: (yarnLock: string, options?: Options) => string;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAe,MAAM,eAAe,CAAC;AAIxD,KAAK,SAAS,GAAG;IACb,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC7B,CAAA;AAID,KAAK,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;AAE1C,KAAK,OAAO,GAAG;IACX,gBAAgB,EAAC,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,SAAS,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,UAAU,CAAC;IACvB,WAAW,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAA;CACrB,CAAA;AAED,KAAK,OAAO,GAAG;IACX,GAAG,EAAE,SAAS,CAAC;IACf,SAAS,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;CAC1B,CAAA;AAED,KAAK,QAAQ,GAAG,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAErC,KAAK,OAAO,GAAG;IACX,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAA;AAyID,eAAO,MAAM,OAAO,aACN,QAAQ,YACT,OAAO,KACjB,OAAO,EAUT,CAAC;AAEF,eAAO,MAAM,aAAa,aACZ,QAAQ,YACT,OAAO,KACjB,OAAO,EAGT,CAAC;AAEF,eAAO,MAAM,cAAc,aAAa,MAAM,YAAW,OAAO,KAAQ,MAAM,EAS7E,CAAC;AAOF,eAAO,MAAM,aAAa,aAAe,MAAM,YAAW,OAAO,WAyBhE,CAAC"}

package/dist/index.js

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fixDuplicates = exports.listDuplicates = exports.getDuplicates = exports.getBest = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@yarnpkg/core");
+const yarnParsers = tslib_1.__importStar(require("@yarnpkg/parsers"));
+const semver_1 = tslib_1.__importDefault(require("semver"));
+const parseYarnLock = (file) => yarnParsers.parseSyml(file);
+const extractPackages = (yarnEntries, { includeScopes = [], includePackages = [], excludePackages = [], excludeScopes = [], } = {}) => {
+    const packages = {};
+    const re = /^(?:([^:]*):)?([^@]*?)$/;
+    for (const [entryName, entry] of Object.entries(yarnEntries)) {
+        if (entryName === '__metadata')
+            continue;
+        for (const descriptorString of entryName.split(', ')) {
+            const descriptor = core_1.structUtils.parseDescriptor(descriptorString);
+            const [, requestedProtocol, requestedVersion] = descriptor.range.match(re) || [];
+            const packageName = core_1.structUtils.stringifyIdent(descriptor);
+            let ignored = requestedProtocol !== 'npm' || entry.linkType !== 'hard';
+            // If there is a list of scopes, only process those.
+            if (includeScopes.length > 0 &&
+                !includeScopes.find((scope) => packageName.startsWith(`${scope}/`))) {
+                ignored = true;
+            }
+            else if (excludeScopes.length > 0 &&
+                excludeScopes.find((scope) => packageName.startsWith(`${scope}/`))) {
+                ignored = true;
+            }
+            // If there is a list of package names, only process those.
+            else if (includePackages.length > 0 && !includePackages.includes(packageName)) {
+                ignored = true;
+            }
+            else if (excludePackages.length > 0 && excludePackages.includes(packageName)) {
+                ignored = true;
+            }
+            const packageKey = ignored ? entryName : packageName + '@' + requestedProtocol;
+            packages[packageKey] = packages[packageKey] || [];
+            packages[packageKey].push({
+                packageKey,
+                packageName,
+                pkg: entry,
+                descriptorString,
+                descriptor,
+                ignored,
+                requestedProtocol,
+                requestedVersion,
+                installedVersion: entry.version,
+                satisfiedBy: new Set(),
+                versions: new Map()
+            });
+        }
+    }
+    ;
+    return packages;
+};
+const computePackageInstances = (packages, packageKey, { useMostCommon = false, includePrerelease = false, } = {}) => {
+    // Instances of this package in the tree
+    const packageInstances = packages[packageKey];
+    // Extract the list of unique versions for this package
+    const versions = new Map();
+    for (const packageInstance of packageInstances) {
+        if (packageInstance.ignored)
+            continue;
+        if (versions.has(packageInstance.installedVersion))
+            continue;
+        versions.set(packageInstance.installedVersion, {
+            pkg: packageInstance.pkg,
+            satisfies: new Set(),
+        });
+    }
+    // Link each package instance with all the versions it could satisfy.
+    for (const [version, { satisfies }] of versions) {
+        packageInstances.forEach((packageInstance) => {
+            // We can assume that the installed version always satisfied the requested version.
+            packageInstance.satisfiedBy.add(packageInstance.installedVersion);
+            // In some cases the requested version is invalid form a semver point of view (for
+            // example `sinon@next`). Just ignore those cases, they won't get deduped.
+            if (semver_1.default.validRange(packageInstance.requestedVersion, { includePrerelease }) &&
+                semver_1.default.satisfies(version, packageInstance.requestedVersion, { includePrerelease })) {
+                satisfies.add(packageInstance);
+                packageInstance.satisfiedBy.add(version);
+            }
+        });
+    }
+    ;
+    // Sort the list of satisfied versions
+    packageInstances.forEach((packageInstance) => {
+        if (packageInstance.ignored) {
+            packageInstance.bestVersion = packageInstance.installedVersion;
+            return;
+        }
+        // Save all versions for future reference
+        packageInstance.versions = versions;
+        // Compute the versions that actually satisfy this instance
+        packageInstance.candidateVersions = Array.from(packageInstance.satisfiedBy);
+        packageInstance.candidateVersions.sort((versionA, versionB) => {
+            if (useMostCommon) {
+                // Sort verions based on how many packages it satisfies. In case of a tie, put the
+                // highest version first.
+                const satisfiesA = versions.get(versionA).satisfies;
+                const satisfiesB = versions.get(versionB).satisfies;
+                if (satisfiesB.size > satisfiesA.size)
+                    return 1;
+                if (satisfiesB.size < satisfiesA.size)
+                    return -1;
+            }
+            return semver_1.default.rcompare(versionA, versionB);
+        });
+        // The best package is always the first one in the list thanks to the sorting above.
+        packageInstance.bestVersion = packageInstance.candidateVersions[0];
+    });
+    return packageInstances;
+};
+const getBest = (packages, options = {}) => {
+    return Object.keys(packages)
+        .reduce((acc, name) => acc.concat(computePackageInstances(packages, name, options)), []);
+};
+exports.getBest = getBest;
+const getDuplicates = (packages, options = {}) => {
+    return (0, exports.getBest)(packages, options)
+        .filter(({ bestVersion, installedVersion }) => bestVersion !== installedVersion);
+};
+exports.getDuplicates = getDuplicates;
+const listDuplicates = (yarnLock, options = {}) => {
+    const yarnEntries = parseYarnLock(yarnLock);
+    const packages = extractPackages(yarnEntries);
+    const duplicates = (0, exports.getDuplicates)(packages, options);
+    const result = duplicates.map(({ bestVersion, packageName, installedVersion, requestedVersion }) => {
+        return `Package "${packageName}" wants ${requestedVersion} and could get ${bestVersion}, but got ${installedVersion}`;
+    });
+    return result;
+};
+exports.listDuplicates = listDuplicates;
+const yarnLockHeader = `${[
+    `# This file is generated by running "yarn install" inside your project.\n`,
+    `# Manual changes might be lost - proceed with caution!\n`,
+].join(``)}\n`;
+const fixDuplicates = (yarnLock, options = {}) => {
+    const yarnEntries = parseYarnLock(yarnLock);
+    const packages = extractPackages(yarnEntries);
+    const bestPackages = (0, exports.getBest)(packages, options);
+    const packageResolutions = {};
+    for (const bestPackage of bestPackages) {
+        const { descriptorString, bestVersion, requestedProtocol, installedVersion, pkg, descriptor, ignored, packageKey } = bestPackage;
+        const keyWithBestVersion = ignored ? packageKey : core_1.structUtils.stringifyDescriptor({
+            ...descriptor,
+            range: requestedProtocol + ':' + bestVersion
+        });
+        packageResolutions[keyWithBestVersion] = packageResolutions[keyWithBestVersion] || { keys: [] };
+        packageResolutions[keyWithBestVersion].keys.push(descriptorString);
+        if (bestVersion === installedVersion)
+            packageResolutions[keyWithBestVersion].pkg = pkg;
+    }
+    const newYarnEntries = { __metadata: yarnEntries.__metadata };
+    for (const packageResolution of Object.values(packageResolutions)) {
+        const key = packageResolution.keys.join(', ');
+        newYarnEntries[key] = packageResolution.pkg;
+    }
+    return yarnLockHeader + yarnParsers.stringifySyml(newYarnEntries);
+};
+exports.fixDuplicates = fixDuplicates;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,wCAAwD;AACxD,sEAAgD;AAChD,4DAA4B;AA+C5B,MAAM,aAAa,GAAG,CAAC,IAAW,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAgB,CAAC;AAElF,MAAM,eAAe,GAAG,CACpB,WAAwB,EACxB,EACI,aAAa,GAAG,EAAE,EAClB,eAAe,GAAG,EAAE,EACpB,eAAe,GAAG,EAAE,EACpB,aAAa,GAAG,EAAE,MACT,EAAE,EACP,EAAE;IACV,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,EAAE,GAAG,yBAAyB,CAAC;IAErC,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QAC1D,IAAI,SAAS,KAAK,YAAY;YAAE,SAAS;QAEzC,KAAK,MAAM,gBAAgB,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,EAAC;YACjD,MAAM,UAAU,GAAG,kBAAW,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;YACjE,MAAM,CAAC,EAAE,iBAAiB,EAAE,gBAAgB,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;YAEjF,MAAM,WAAW,GAAG,kBAAW,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YAE3D,IAAI,OAAO,GAAG,iBAAiB,KAAK,KAAK,IAAI,KAAK,CAAC,QAAQ,KAAK,MAAM,CAAC;YAEvE,oDAAoD;YACpD,IACI,aAAa,CAAC,MAAM,GAAG,CAAC;gBACxB,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,EACrE;gBACE,OAAO,GAAG,IAAI,CAAC;aAClB;iBAAM,IACH,aAAa,CAAC,MAAM,GAAG,CAAC;gBACxB,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,EACpE;gBACE,OAAO,GAAG,IAAI,CAAC;aAClB;YAED,2DAA2D;iBACtD,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;gBAC3E,OAAO,GAAG,IAAI,CAAC;aAClB;iBAAM,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,IAAI,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;gBAC5E,OAAO,GAAG,IAAI,CAAC;aAClB;YAED,MAAM,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,GAAG,GAAG,GAAG,iBAAiB,CAAC;YAC/E,QAAQ,CAAC,UAAU,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;YAElD,QAAQ,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC;gBACtB,UAAU;gBACV,WAAW;gBACX,GAAG,EAAE,KAAK;gBACV,gBAAgB;gBAChB,UAAU;gBACV,OAAO;gBACP,iBAAiB;gBACjB,gBAAgB;gBAChB,gBAAgB,EAAE,KAAK,CAAC,OAAO;gBAC/B,WAAW,EAAE,IAAI,GAAG,EAAE;gBACtB,QAAQ,EAAE,IAAI,GAAG,EAAE;aACtB,CAAC,CAAC;SACN;KACJ;IAAA,CAAC;IACF,OAAO,QAAQ,CAAC;AACpB,CAAC,CAAC;AAIF,MAAM,uBAAuB,GAAG,CAAC,QAAkB,EAAE,UAAkB,EACnE,EACI,aAAa,GAAG,KAAK,EACrB,iBAAiB,GAAG,KAAK,MAChB,EAAE,EAAa,EAAE;IAC9B,wCAAwC;IACxC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;IAE9C,uDAAuD;IACvD,MAAM,QAAQ,GAAY,IAAI,GAAG,EAAE,CAAC;IACpC,KAAK,MAAM,eAAe,IAAI,gBAAgB,EAAE;QAC5C,IAAI,eAAe,CAAC,OAAO;YAAE,SAAS;QACtC,IAAI,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,gBAAgB,CAAC;YAAE,SAAS;QAC7D,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,gBAAgB,EAAE;YAC3C,GAAG,EAAE,eAAe,CAAC,GAAG;YACxB,SAAS,EAAE,IAAI,GAAG,EAAE;SACvB,CAAC,CAAA;KACL;IAED,qEAAqE;IACrE,KAAK,MAAM,CAAC,OAAO,EAAE,EAAC,SAAS,EAAC,CAAC,IAAI,QAAQ,EAAE;QAC3C,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;YACzC,mFAAmF;YACnF,eAAe,CAAC,WAAW,CAAC,GAAG,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;YAClE,kFAAkF;YAClF,0EAA0E;YAC1E,IACI,gBAAM,CAAC,UAAU,CAAC,eAAe,CAAC,gBAAgB,EAAE,EAAE,iBAAiB,EAAE,CAAC;gBAC1E,gBAAM,CAAC,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,gBAAgB,EAAE,EAAE,iBAAiB,EAAE,CAAC,EACpF;gBACE,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;gBAC/B,eAAe,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;aAC5C;QACL,CAAC,CAAC,CAAC;KACN;IAAA,CAAC;IAEF,sCAAsC;IACtC,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;QACzC,IAAI,eAAe,CAAC,OAAO,EAAE;YACzB,eAAe,CAAC,WAAW,GAAG,eAAe,CAAC,gBAAgB,CAAC;YAC/D,OAAO;SACV;QAED,yCAAyC;QACzC,eAAe,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAEpC,2DAA2D;QAC3D,eAAe,CAAC,iBAAiB,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAC5E,eAAe,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,QAAe,EAAE,QAAe,EAAE,EAAE;YACxE,IAAI,aAAa,EAAE;gBACf,kFAAkF;gBAClF,yBAAyB;gBACzB,MAAM,UAAU,GAAI,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAa,CAAC,SAAS,CAAC;gBACjE,MAAM,UAAU,GAAI,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAa,CAAC,SAAS,CAAC;gBACjE,IAAI,UAAU,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI;oBAAE,OAAO,CAAC,CAAC;gBAChD,IAAI,UAAU,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI;oBAAE,OAAO,CAAC,CAAC,CAAC;aACpD;YACD,OAAO,gBAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,oFAAoF;QACpF,eAAe,CAAC,WAAW,GAAG,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,OAAO,gBAAgB,CAAC;AAC5B,CAAC,CAAC;AAEK,MAAM,OAAO,GAAG,CACnB,QAAkB,EAClB,UAAmB,EAAE,EACZ,EAAE;IAEX,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;SACvB,MAAM,CACH,CAAC,GAAa,EAAE,IAAI,EAAE,EAAE,CACpB,GAAG,CAAC,MAAM,CACN,uBAAuB,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC,CACnD,EACL,EAAE,CACL,CAAC;AACV,CAAC,CAAC;AAbW,QAAA,OAAO,WAalB;AAEK,MAAM,aAAa,GAAG,CACzB,QAAkB,EAClB,UAAmB,EAAE,EACZ,EAAE;IACX,OAAO,IAAA,eAAO,EAAC,QAAQ,EAAE,OAAO,CAAC;SAC5B,MAAM,CAAC,CAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAAC,WAAW,KAAK,gBAAgB,CAAC,CAAC;AACzF,CAAC,CAAC;AANW,QAAA,aAAa,iBAMxB;AAEK,MAAM,cAAc,GAAG,CAAC,QAAe,EAAE,UAAmB,EAAE,EAAY,EAAE;IAC/E,MAAM,WAAW,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;IAC9C,MAAM,UAAU,GAAG,IAAA,qBAAa,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAEpD,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,EAAE,EAAE;QAC/F,OAAO,YAAY,WAAW,WAAW,gBAAgB,kBAAkB,WAAW,aAAa,gBAAgB,EAAE,CAAC;IAC1H,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAClB,CAAC,CAAC;AATW,QAAA,cAAc,kBASzB;AAEF,MAAM,cAAc,GAAG,GAAG;IACtB,2EAA2E;IAC3E,0DAA0D;CAC3D,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC;AAEV,MAAM,aAAa,GAAG,CAAE,QAAgB,EAAE,UAAmB,EAAE,EAAG,EAAE;IACvE,MAAM,WAAW,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC5C,MAAM,QAAQ,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;IAC9C,MAAM,YAAY,GAAG,IAAA,eAAO,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAChD,MAAM,kBAAkB,GAAuB,EAAE,CAAC;IAElD,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE;QACpC,MAAM,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,WAAW,CAAC;QAEjI,MAAM,kBAAkB,GAAG,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,kBAAW,CAAC,mBAAmB,CAAC;YAC9E,GAAG,UAAU;YACb,KAAK,EAAE,iBAAiB,GAAG,GAAG,GAAG,WAAW;SAC/C,CAAC,CAAC;QACH,kBAAkB,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC,kBAAkB,CAAC,IAAI,EAAC,IAAI,EAAC,EAAE,EAAC,CAAC;QAC7F,kBAAkB,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACnE,IAAI,WAAW,KAAK,gBAAgB;YAAE,kBAAkB,CAAC,kBAAkB,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;KAC1F;IAED,MAAM,cAAc,GAAgB,EAAE,UAAU,EAAE,WAAW,CAAC,UAAU,EAAE,CAAC;IAC3E,KAAK,MAAM,iBAAiB,IAAI,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,EAAE;QAC/D,MAAM,GAAG,GAAG,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,cAAc,CAAC,GAAG,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC;KAC/C;IAED,OAAO,cAAc,GAAG,WAAW,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;AACtE,CAAC,CAAC;AAzBW,QAAA,aAAa,iBAyBxB"}