yarn-why-duplicate 1.0.0 → 1.2.0

package/.editorconfig

@@ -0,0 +1,13 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/.eslintrc.json

@@ -0,0 +1,4 @@
+{
+  "root": true,
+  "extends": ["@pob/eslint-config/root-module"]
+}

package/.prettierignore

@@ -0,0 +1,2 @@
+CHANGELOG.md
+/.yarn/**/*

package/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+## [1.2.0](https://github.com/christophehurpeau/yarn-why-duplicate/compare/v1.1.0...v1.2.0) (2023-04-25)
+
+
+### Features
+
+* force 1.2.0 ([72688d8](https://github.com/christophehurpeau/yarn-why-duplicate/commit/72688d83af568ebb83fe8ee261b6ac18adf44f0e))
+
+## [1.1.0](https://github.com/christophehurpeau/yarn-why-duplicate/compare/v1.0.0...v1.1.0) (2023-04-25)
+
+
+### Features
+
+* force 1.1.0 ([d333635](https://github.com/christophehurpeau/yarn-why-duplicate/commit/d3336353ffe709910577310116dab70dd8f25f5c))
+
+## 1.0.0 (2023-04-25)
+
+
+### Features
+
+* **deps:** update dependency semver to v7.5.0 ([#4](https://github.com/christophehurpeau/yarn-why-duplicate/issues/4)) ([f9eee30](https://github.com/christophehurpeau/yarn-why-duplicate/commit/f9eee30e153dea0dc8dabb69b2484dd6dd3be0dc))
+* first commit ([c3a6354](https://github.com/christophehurpeau/yarn-why-duplicate/commit/c3a6354ae139baffc75c4582af439db4f496329c))
+
+
+### Bug Fixes
+
+* add try/catch on compareRange ([357eed7](https://github.com/christophehurpeau/yarn-why-duplicate/commit/357eed715012b156d4abd447f9d7232fdc066d72))
+* use virtuals ([340d56a](https://github.com/christophehurpeau/yarn-why-duplicate/commit/340d56a8abc6c81b9973ed5ecb80604e6905990b))
+* virtual child ([8798439](https://github.com/christophehurpeau/yarn-why-duplicate/commit/8798439ccf4f7ee40292ce9fb734e573a37c1d71))

package/README.md

@@ -0,0 +1,22 @@
+<h3 align="center">
+  yarn-why-duplicate
+</h3>
+
+<p align="center">
+  Simple bin to know why a package is duplicated
+</p>
+
+<p align="center">
+  <a href="https://npmjs.org/package/yarn-why-duplicate"><img src="https://img.shields.io/npm/v/yarn-why-duplicate.svg?style=flat-square"></a>
+  <a href="https://npmjs.org/package/yarn-why-duplicate"><img src="https://img.shields.io/npm/dw/yarn-why-duplicate.svg?style=flat-square"></a>
+  <a href="https://npmjs.org/package/yarn-why-duplicate"><img src="https://img.shields.io/node/v/yarn-why-duplicate.svg?style=flat-square"></a>
+  <a href="https://npmjs.org/package/yarn-why-duplicate"><img src="https://img.shields.io/npm/types/yarn-why-duplicate.svg?style=flat-square"></a>
+</p>
+
+## Usage
+
+With yarn berry:
+
+```
+yarn dlx yarn-why-duplicate <dependencyName>
+```

package/bin/yarn-why-duplicate.mjs

@@ -1,31 +1,22 @@
 #!/usr/bin/env node
 
-import { execSync } from 'child_process';
+import { displayDuplicates } from '../lib/displayDuplicates.js';
+import { identifyDuplicates } from '../lib/identifyDuplicates.js';
+import { readAndParseYarnWhy } from '../lib/readAndParseYarnWhy.js';
 
 const pkgName = process.argv.slice(2)[0];
 
-const yarnWhyResult = execSync(`yarn why ${pkgName} --json`, { encoding: 'utf8' })
-  .split('\n')
-  .filter(Boolean)
-  .map((line) => JSON.parse(line));
-
-const groupByVersions = new Map();
+const yarnWhyResult = readAndParseYarnWhy(pkgName);
 
 for (const line of yarnWhyResult) {
-  for (const [key, child] of Object.entries(line.children)) {
-    let values = groupByVersions.get(child.locator);
-    if (!values) {
-      values = [];
-      groupByVersions.set(child.locator, values);
-    }
-    values.push(line.value);
+  if (line.type === 'error') {
+    console.error(`yarn error: ${line.data}`);
+    process.exit(1);
+  } else if (line.type === 'step') {
+    console.error('yarn 1 is not supported, use yarn berry (>=2)');
+    process.exit(1);
   }
 }
 
-for (const [version, values] of groupByVersions.entries()) {
-  console.log(version);
-  for (const value of values) {
-    console.log(`- ${value}`);
-  }
-  console.log();
-}
+const groupByVersions = identifyDuplicates(yarnWhyResult);
+displayDuplicates(groupByVersions);

package/lib/.eslintrc.json

@@ -0,0 +1,4 @@
+{
+  "root": true,
+  "extends": ["@pob/eslint-config/node-module"]
+}

package/lib/displayDuplicates.js

@@ -0,0 +1,32 @@
+import { structUtils, Configuration } from '@yarnpkg/core';
+
+export const displayDuplicates = (
+  groupByVersions,
+  log = console.log,
+  configuration = Configuration.create(process.cwd()),
+) => {
+  if (groupByVersions.length === 0) {
+    log('No version found');
+    return;
+  }
+
+  log(
+    `Found ${groupByVersions.length} version${
+      groupByVersions.length === 1 ? '' : 's'
+    }:`,
+  );
+  log();
+
+  for (const { descriptor, sources } of groupByVersions) {
+    log(structUtils.prettyDescriptor(configuration, descriptor));
+    for (const { source, descriptor } of sources.values()) {
+      log(
+        `- ${structUtils.prettyDescriptor(
+          configuration,
+          source,
+        )} (${structUtils.prettyDescriptor(configuration, descriptor)})`,
+      ); // TODO prettyDescriptor from structUtils
+    }
+    log();
+  }
+};

package/lib/identifyDuplicates.js

@@ -0,0 +1,58 @@
+import { structUtils } from '@yarnpkg/core';
+import { compare as compareRange } from 'semver';
+
+export const identifyDuplicates = (yarnWhyResult) => {
+  const groupByVersions = new Map();
+
+  for (const line of yarnWhyResult) {
+    const descriptor = structUtils.parseDescriptor(line.value);
+    const devirtualizedDescriptor = structUtils.isVirtualDescriptor(descriptor)
+      ? structUtils.devirtualizeDescriptor(descriptor)
+      : descriptor;
+
+    for (const [key, child] of Object.entries(line.children)) {
+      const childDescriptor = structUtils.parseDescriptor(key);
+      const devirtualizedChildDescriptor = structUtils.isVirtualDescriptor(
+        childDescriptor,
+      )
+        ? structUtils.devirtualizeDescriptor(childDescriptor)
+        : childDescriptor;
+
+      let byVersion = groupByVersions.get(
+        devirtualizedChildDescriptor.descriptorHash,
+      );
+      if (!byVersion) {
+        byVersion = {
+          descriptor: devirtualizedChildDescriptor,
+          sources: new Map(),
+        };
+        groupByVersions.set(
+          devirtualizedChildDescriptor.descriptorHash,
+          byVersion,
+        );
+      }
+
+      if (!byVersion.sources.has(devirtualizedDescriptor.descriptorHash)) {
+        byVersion.sources.set(devirtualizedDescriptor.descriptorHash, {
+          source: devirtualizedDescriptor, // source of the dependency
+          descriptor: structUtils.parseDescriptor(child.descriptor), // value parsed from package.json eg date-fns@npm:^1.29.0
+          locator: structUtils.parseLocator(child.locator), // value resolved by yarn eg date-fns@npm:1.30.1
+        });
+      }
+    }
+  }
+
+  const groups = [...groupByVersions.values()];
+  groups.sort((a, b) => {
+    const aRange = structUtils.parseRange(a.descriptor.range);
+    const bRange = structUtils.parseRange(b.descriptor.range);
+
+    try {
+      return -compareRange(aRange.selector, bRange.selector);
+    } catch {
+      return 0;
+    }
+  });
+
+  return groups;
+};

package/lib/readAndParseYarnWhy.js

@@ -0,0 +1,24 @@
+import { spawnSync } from 'child_process';
+
+export const parseYarnWhy = (content) => {
+  return content
+    .split('\n')
+    .filter(Boolean)
+    .map((line) => JSON.parse(line));
+};
+
+export const readAndParseYarnWhy = (pkgName) => {
+  const { stdout, stderr } = spawnSync('yarn', ['why', pkgName, '--json'], {
+    encoding: 'utf8',
+    stdio: 'pipe',
+    pwd: process.cwd(),
+  });
+  if (stderr) {
+    try {
+      return parseYarnWhy(stderr);
+    } catch {
+      throw new Error(`yarn failed: ${stderr}`);
+    }
+  }
+  return parseYarnWhy(stdout);
+};

package/package.json

@@ -1,26 +1,58 @@
 {
   "name": "yarn-why-duplicate",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Simple bin to know why a package is duplicated",
-  "main": "bin/yarn-why-duplicate.mjs",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/christophehurpeau/yarn-why-duplicate.git"
-  },
-  "bin": {
-    "yarn-why-duplicate": "./bin/yarn-why-duplicate.mjs"
-  },
   "keywords": [
     "yarn",
     "berry"
   ],
-  "author": "Christophe Hurpeau",
+  "author": "Christophe Hurpeau <christophe@hurpeau.com> (https://christophe.hurpeau.com)",
   "license": "ISC",
+  "repository": "https://github.com/christophehurpeau/yarn-why-duplicate.git",
+  "homepage": "https://github.com/christophehurpeau/yarn-why-duplicate#readme",
   "bugs": {
     "url": "https://github.com/christophehurpeau/yarn-why-duplicate/issues"
   },
-  "homepage": "https://github.com/christophehurpeau/yarn-why-duplicate#readme"
+  "type": "module",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "packageManager": "yarn@3.5.0",
+  "main": "./lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "bin": "./bin/yarn-why-duplicate.mjs",
+  "scripts": {
+    "checks": "node scripts/check-package.js",
+    "clean:build": "true",
+    "lint": "yarn run lint:prettier && yarn run lint:eslint",
+    "lint:eslint": "eslint --report-unused-disable-directives --resolve-plugins-relative-to . --quiet *.{js,cjs,mjs} lib bin scripts",
+    "lint:prettier": "pob-root-prettier --check .",
+    "lint:prettier:fix": "pob-root-prettier --write .",
+    "postinstallDev": "pob-root-postinstall",
+    "test": "node --test",
+    "test:coverage": "node --test",
+    "test:watch": "node --test --watch"
+  },
+  "prettier": "@pob/root/prettier-config",
+  "commitlint": {
+    "extends": [
+      "@pob/commitlint-config"
+    ]
+  },
+  "pob": {},
+  "dependencies": {
+    "@yarnpkg/core": "4.0.0-rc.42",
+    "semver": "7.5.0"
+  },
+  "devDependencies": {
+    "@pob/commitlint-config": "5.1.1",
+    "@pob/eslint-config": "50.0.4",
+    "@pob/root": "7.8.0",
+    "check-package-dependencies": "6.3.2",
+    "eslint": "8.39.0"
+  }
 }

package/scripts/check-package.js

@@ -0,0 +1,3 @@
+import { createCheckPackage } from 'check-package-dependencies';
+
+await createCheckPackage().checkRecommended({}).run();