Add support for yarn-berry lockfiles (#28)

* Add support for yarn-berry lockfiles

* use @yarnpkg/parsers to parse lockfile

* Update docs

* Update package.json

Co-authored-by: Joel Arvidsson <[email protected]>

* update lockfile

---------

Co-authored-by: Mike Duminy <[email protected]>
Co-authored-by: Joel Arvidsson <[email protected]>

.gitignore

@@ -4,3 +4,4 @@
 # Generated files
 *.log
 node_modules/
+.yarn/

README.md

@@ -23,6 +23,8 @@ npx diglett npm <optional path to project>
 npx diglett yarn <optional path to project>
 ```
 
+Supports both yarn v1 and yarn berry.
+
 ### Yarn workspaces
 
 ```
@@ -31,6 +33,8 @@ npx diglett yarn-workspace <optional path to project> [--package <package name>]
 
 By default all workspace packages are analyzed. If you just want to analyze one, pass the `--package` option with the package name – not folder name. It's possible to pass the `--package` option multiple times to analyze multiple packages.
 
+Supports both yarn v1 and yarn berry.
+
 ## General options
 
 | **Name**           | **Description**                                                | **Default** |

package.json

@@ -5,8 +5,8 @@
   "main": "src/cli.js",
   "scripts": {
     "test": "jest",
-    "check-format": "prettier --check {src,test}/**/*.js README.md",
-    "format": "prettier --write {src,test}/**/*.js README.md"
+    "check-format": "prettier --check \"{src,test}/**/*.js\" README.md",
+    "format": "prettier --write \"{src,test}/**/*.js\" README.md"
   },
   "bin": {
     "diglett": "./bin/diglett"
@@ -37,7 +37,7 @@
   },
   "homepage": "https://github.com/oblador/diglett#readme",
   "dependencies": {
-    "@yarnpkg/lockfile": "^1.1.0",
+    "@yarnpkg/parsers": "^2.5.1",
     "chalk": "^3.0.0",
     "glob": "^7.1.6",
     "yargs": "^15.1.0"

src/commands/yarn-workspace.js

@@ -1,4 +1,3 @@
-const fs = require('fs');
 const path = require('path');
 const glob = require('glob');
 const sharedArguments = require('../sharedArguments');

src/errors.js

@@ -1,5 +1,3 @@
-const path = require('path');
-
 class DiglettError extends Error {
   constructor(message, errorType) {
     super(message);

src/fs.js

@@ -1,6 +1,6 @@
 const fs = require('fs');
 const path = require('path');
-const lockfile = require('@yarnpkg/lockfile');
+const { parseSyml } = require('@yarnpkg/parsers');
 const { FileNotFoundError, ParseError } = require('./errors');
 
 function readFile(fileName, projectPath) {
@@ -22,11 +22,12 @@ function readJSON(fileName, projectPath) {
 
 function readYarnLockfile(projectPath) {
   const file = readFile('yarn.lock', projectPath);
-  const parsed = lockfile.parse(file);
-  if (parsed.type !== 'success') {
+
+  try {
+    return parseSyml(file);
+  } catch {
     throw new ParseError('Failed to parse yarn.lock');
   }
-  return parsed.object;
 }
 
 function readPackageJSON(projectPath) {

src/getDuplicateDependencies.js

@@ -1,5 +1,3 @@
-const groupYarnDependencies = require('./groupYarnDependencies');
-
 function getDuplicateDependencies(groupedVersions, packageNamePattern) {
   const duplicates = new Map();
   groupedVersions.forEach((versions, packageName) => {

src/groupYarnDependencies.js

@@ -1,4 +1,24 @@
 const { StaleLockfileError } = require('./errors');
+const parseYarnDescriptor = require('./parseYarnDescriptor');
+
+function resolveDependency(packageName, requestedVersion, dependencies) {
+  // yarn v1 uses a simple format for the key: `${packageName}@${version}`
+  const simpleKey = `${packageName}@${requestedVersion}`;
+  if (simpleKey in dependencies) return dependencies[simpleKey];
+
+  for (const [key, value] of Object.entries(dependencies)) {
+    // ignore metadata keys
+    if (key === '__metadata') continue;
+
+    // yarn v2 uses a more complex format for the key: `${packageName}@${protocol}${version}`
+    const { packageName: name, version } = parseYarnDescriptor(key);
+    if (name === packageName && version === requestedVersion) {
+      return value;
+    }
+  }
+
+  return null;
+}
 
 function groupYarnDependencies(
   packageDependencies,
@@ -16,18 +36,22 @@ function groupYarnDependencies(
     }
 
     const versions = installedVersions.get(packageName);
-    const dependencyKey = `${packageName}@${requestedVersion}`;
-    const resolvedDependency = dependencies[dependencyKey];
+    const resolvedDependency = resolveDependency(
+      packageName,
+      requestedVersion,
+      dependencies
+    );
+
     if (!resolvedDependency) {
       throw new StaleLockfileError(
-        `Unable to find resolution for "${dependencyKey}", ensure yarn.lock is up to date`
+        `Unable to find resolution for package "${packageName}" and version "${requestedVersion}", ensure yarn.lock is up to date`
       );
     }
     const installedVersion = resolvedDependency.version;
 
     if (!versions.has(installedVersion)) {
       versions.add(installedVersion);
-      const subDependencies = dependencies[dependencyKey].dependencies;
+      const subDependencies = resolvedDependency.dependencies;
       for (const subDependency in subDependencies) {
         populateVersions(
           subDependency,

src/parseYarnDescriptor.js

@@ -0,0 +1,46 @@
+/**
+ * A regular expression for parsing a yarn berry descriptor.
+ */
+const PARSE_REGEX = /(^@?[^/]+?\/?[^@/]+?)@(?:.*:)*(.+)/;
+
+/**
+ * @typedef {Object} ParsedDescriptor
+ * @property {string} packageName
+ * @property {string} version
+ */
+
+/**
+ * Parses a yarn descriptor into an object.
+ * Handles both yarn v1 and yarn berry descriptors.
+ *
+ * Supported formats:
+ * - "package@version"
+ * - "@scope/package@version"
+ * - "package@protocol:version"
+ * - "@scope/package@protocol:version"
+ *
+ * Examples:
+ * - yarn v1: "@material/[email protected]"
+ * - yarn berry: "@material/ripple@npm:1.0.0"
+ *
+ * Both will be parsed to:
+ * ```
+ * {
+ *  package: '@material/ripple',
+ *  version: '1.0.0',
+ * }
+ * ```
+ *
+ * @param {string} descriptor - The yarn descriptor to parse.
+ * @returns {ParsedDescriptor} The parsed descriptor.
+ */
+function parseYarnDescriptor(descriptor) {
+  const result = PARSE_REGEX.exec(descriptor);
+  if (!result) {
+    throw new Error(`Unable to parse descriptor: ${descriptor}`);
+  }
+  const [, packageName, version] = result;
+  return { packageName, version };
+}
+
+module.exports = parseYarnDescriptor;

test/fixtures/yarn-berry/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules