flatlock 1.1.0 → 1.2.0

package/src/parsers/yarn-classic.js

@@ -1,16 +1,19 @@
 import yarnLockfile from '@yarnpkg/lockfile';
 
-const { parse } = yarnLockfile;
+/** @typedef {import('./types.js').Dependency} Dependency */
 
 /**
- * @typedef {Object} Dependency
- * @property {string} name - Package name
- * @property {string} version - Resolved version
- * @property {string} [integrity] - Integrity hash
- * @property {string} [resolved] - Resolution URL
- * @property {boolean} [link] - True if this is a symlink
+ * @typedef {Object} YarnClassicParseResult
+ * @property {'success' | 'merge' | 'conflict'} type - Parse result type
+ * @property {Record<string, any>} object - Parsed lockfile object
  */
 
+/**
+ * The yarn classic parse function (handles CJS/ESM interop)
+ * @type {(content: string) => YarnClassicParseResult}
+ */
+export const parseYarnClassic = yarnLockfile.default?.parse || yarnLockfile.parse;
+
 /**
  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  * !! WARNING: DO NOT MODIFY THIS FUNCTION                                   !!
@@ -27,14 +30,68 @@ const { parse } = yarnLockfile;
  *
  * Extract package name from yarn classic key.
  *
- * Examples:
- *   "lodash@^4.17.21" → "lodash"
- *   "@babel/core@^7.0.0" → "@babel/core"
- *   "lodash@^4.17.21, lodash@^4.0.0" → "lodash" (multiple version ranges)
- *   "@babel/traverse--for-generate-function-map@npm:@babel/traverse@^7.25.3" → "@babel/traverse--for-generate-function-map"
- *
  * @param {string} key - Lockfile entry key
  * @returns {string} Package name
+ *
+ * @example
+ * // Simple unscoped package with semver range
+ * parseLockfileKey('lodash@^4.17.21')
+ * // => 'lodash'
+ *
+ * @example
+ * // Scoped package
+ * parseLockfileKey('@babel/core@^7.0.0')
+ * // => '@babel/core'
+ *
+ * @example
+ * // Multiple version ranges (comma-separated) - takes first entry
+ * parseLockfileKey('lodash@^4.17.21, lodash@^4.0.0')
+ * // => 'lodash'
+ *
+ * @example
+ * // Multiple ranges for scoped package
+ * parseLockfileKey('@types/node@^18.0.0, @types/node@^20.0.0')
+ * // => '@types/node'
+ *
+ * @example
+ * // npm: alias protocol - returns the ALIAS name
+ * parseLockfileKey('@babel/traverse--for-generate-function-map@npm:@babel/traverse@^7.25.3')
+ * // => '@babel/traverse--for-generate-function-map'
+ *
+ * @example
+ * // Unscoped alias
+ * parseLockfileKey('string-width-cjs@npm:string-width@^4.2.0')
+ * // => 'string-width-cjs'
+ *
+ * @example
+ * // Exact version
+ * parseLockfileKey('typescript@5.3.3')
+ * // => 'typescript'
+ *
+ * @example
+ * // Git URL specifier
+ * parseLockfileKey('my-lib@github:user/repo#v1.0.0')
+ * // => 'my-lib'
+ *
+ * @example
+ * // Tarball URL
+ * parseLockfileKey('custom-pkg@https://example.com/pkg.tgz')
+ * // => 'custom-pkg'
+ *
+ * @example
+ * // Package with prerelease version
+ * parseLockfileKey('@next/env@^14.0.0-canary.0')
+ * // => '@next/env'
+ *
+ * @example
+ * // Package without @ (bare name, edge case)
+ * parseLockfileKey('lodash')
+ * // => 'lodash'
+ *
+ * @example
+ * // Deeply scoped alias pointing to scoped package
+ * parseLockfileKey('@myorg/my-alias@npm:@original/package@^1.0.0')
+ * // => '@myorg/my-alias'
  */
 export function parseLockfileKey(key) {
   // Keys can have multiple version ranges: "pkg@^1.0.0, pkg@^2.0.0"
@@ -72,19 +129,22 @@ export function parseLockfileKey(key) {
 
 /**
  * Parse yarn.lock v1 (classic)
- * @param {string} content - Lockfile content
+ * @param {string | object} input - Lockfile content string or pre-parsed object
  * @param {Object} [_options] - Parser options (unused, reserved for future use)
  * @returns {Generator<Dependency>}
  */
-export function* fromYarnClassicLock(content, _options = {}) {
-  const parsed = parse(content);
-
-  if (parsed.type !== 'success') {
-    throw new Error(`Failed to parse yarn.lock: ${parsed.type}`);
+export function* fromYarnClassicLock(input, _options = {}) {
+  let lockfile;
+  if (typeof input === 'string') {
+    const result = parseYarnClassic(input);
+    if (result.type !== 'success' && result.type !== 'merge') {
+      throw new Error('Failed to parse yarn.lock');
+    }
+    lockfile = result.object;
+  } else {
+    lockfile = input;
   }
 
-  const lockfile = parsed.object;
-
   for (const [key, pkg] of Object.entries(lockfile)) {
     const name = parseLockfileKey(key);
     const { version, integrity, resolved } = pkg;