fix: support for sorting dependenciesMeta in Yarn berry (#323)

* fix: support for sorting dependenciesMeta in Yarn berry * refactor: sortObjectByIdent - renamed getIdent to getPackageName - moved getPackageName and parseNameAndVersionRange functions to outer scope.
keithamus · Aug 21, 2024 · 7e1dd1f · 7e1dd1f
1 parent d4bd8e2
commit 7e1dd1f
Show file tree

Hide file tree

Showing 5 changed files with 222 additions and 18 deletions.
diff --git a/index.js b/index.js
@@ -55,23 +55,24 @@ const overProperty =
       : object
 const sortGitHooks = sortObjectBy(gitHooks)
 
-const sortObjectBySemver = sortObjectBy((a, b) => {
-  const parseNameAndVersionRange = (specifier) => {
-    // Ignore anything after > & rely on fallback alphanumeric sorting for that
-    const [nameAndVersion] = specifier.split('>')
-    const atMatches = [...nameAndVersion.matchAll('@')]
-    if (
-      !atMatches.length ||
-      (atMatches.length === 1 && atMatches[0].index === 0)
-    ) {
-      return { name: specifier }
-    }
-    const splitIndex = atMatches.pop().index
-    return {
-      name: nameAndVersion.substring(0, splitIndex),
-      range: nameAndVersion.substring(splitIndex + 1),
-    }
+const parseNameAndVersionRange = (specifier) => {
+  // Ignore anything after > & rely on fallback alphanumeric sorting for that
+  const [nameAndVersion] = specifier.split('>')
+  const atMatches = [...nameAndVersion.matchAll('@')]
+  if (
+    !atMatches.length ||
+    (atMatches.length === 1 && atMatches[0].index === 0)
+  ) {
+    return { name: specifier }
   }
+  const splitIndex = atMatches.pop().index
+  return {
+    name: nameAndVersion.substring(0, splitIndex),
+    range: nameAndVersion.substring(splitIndex + 1),
+  }
+}
+
+const sortObjectBySemver = sortObjectBy((a, b) => {
   const { name: aName, range: aRange } = parseNameAndVersionRange(a)
   const { name: bName, range: bRange } = parseNameAndVersionRange(b)
 
@@ -87,6 +88,27 @@ const sortObjectBySemver = sortObjectBy((a, b) => {
   return semver.compare(semver.minVersion(aRange), semver.minVersion(bRange))
 })
 
+const getPackageName = (ident) => {
+  const parts = ident.split('@')
+
+  if (ident.startsWith('@')) {
+    // Handle cases where package name starts with '@'
+    return parts.length > 2 ? parts.slice(0, -1).join('@') : ident
+  }
+
+  // Handle cases where package name doesn't start with '@'
+  return parts.length > 1 ? parts.slice(0, -1).join('@') : ident
+}
+
+const sortObjectByIdent = (a, b) => {
+  const PackageNameA = getPackageName(a)
+  const PackageNameB = getPackageName(b)
+
+  if (PackageNameA < PackageNameB) return -1
+  if (PackageNameA > PackageNameB) return 1
+  return 0
+}
+
 // https://github.com/eslint/eslint/blob/acc0e47572a9390292b4e313b4a4bf360d236358/conf/config-schema.js
 const eslintBaseConfigProperties = [
   // `files` and `excludedFiles` are only on `overrides[]`
@@ -341,7 +363,7 @@ const fields = [
   { key: 'resolutions', over: sortObject },
   { key: 'dependencies', over: sortObject },
   { key: 'devDependencies', over: sortObject },
-  { key: 'dependenciesMeta', over: sortObjectBy(undefined, true) },
+  { key: 'dependenciesMeta', over: sortObjectBy(sortObjectByIdent, true) },
   { key: 'peerDependencies', over: sortObject },
   // TODO: only sort depth = 2
   { key: 'peerDependenciesMeta', over: sortObjectBy(undefined, true) },

diff --git a/tests/_helpers.js b/tests/_helpers.js
@@ -59,6 +59,40 @@ function sortObjectAlphabetically(t, options = {}) {
   }
 }
 
+function sortObjectWithRangeAlphabetically(t, options = {}) {
+  const { maxDepth = 1, expect } = options
+
+  for (let depth = 1; depth < maxDepth + 1; depth++) {
+    sortObject(t, {
+      ...options,
+      value: keysToObject(
+        [
+          '@[email protected]',
+          '[email protected]',
+          '[email protected]',
+          '@[email protected]',
+          '[email protected]',
+          '@b-package',
+        ],
+        depth,
+      ),
+      expect:
+        expect ||
+        keysToObject(
+          [
+            '@[email protected]',
+            '@b-package',
+            '@[email protected]',
+            '[email protected]',
+            '[email protected]',
+            '[email protected]',
+          ],
+          depth,
+        ),
+    })
+  }
+}
+
 function sortObject(
   t,
   {
@@ -211,6 +245,7 @@ export const macro = {
   sortObject,
   asItIs,
   sortObjectAlphabetically,
+  sortObjectWithRangeAlphabetically,
   testCLI,
   uniqueArray,
   uniqueAndSort,

diff --git a/tests/deps.js b/tests/deps.js
@@ -30,10 +30,17 @@ test('peerDependenciesMeta', macro.sortObjectAlphabetically, {
   expect: 'snapshot',
 })
 
-// peerDependenciesMeta
+// dependenciesMeta
 test('dependenciesMeta', macro.sortObjectAlphabetically, {
   path: 'dependenciesMeta',
   maxDepth: 2,
   // TODO: don't use snapshot, find a esaier way for review
   expect: 'snapshot',
 })
+
+test('dependenciesMetaRange', macro.sortObjectWithRangeAlphabetically, {
+  path: 'dependenciesMeta',
+  maxDepth: 2,
+  // TODO: don't use snapshot, find a esaier way for review
+  expect: 'snapshot',
+})
diff --git a/tests/snapshots/deps.js.md b/tests/snapshots/deps.js.md
@@ -107,3 +107,143 @@ Generated by [AVA](https://avajs.dev).
       }`,
       pretty: true,
     }
+
+## dependenciesMetaRange
+
+> Should sort `dependenciesMeta` as object.
+
+    {
+      input: `{␊
+        "dependenciesMeta": {␊
+          "@[email protected]": "@[email protected]",␊
+          "[email protected]": "[email protected]",␊
+          "[email protected]": "[email protected]",␊
+          "@[email protected]": "@[email protected]",␊
+          "[email protected]": "[email protected]",␊
+          "@b-package": "@b-package"␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "dependenciesMeta": {␊
+          "@[email protected]": "@[email protected]",␊
+          "@b-package": "@b-package",␊
+          "@[email protected]": "@[email protected]",␊
+          "[email protected]": "[email protected]",␊
+          "[email protected]": "[email protected]",␊
+          "[email protected]": "[email protected]"␊
+        }␊
+      }`,
+      pretty: true,
+    }
+
+> Should sort `dependenciesMeta` as object.
+
+    {
+      input: `{␊
+        "dependenciesMeta": {␊
+          "@[email protected]": {␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@b-package": "@b-package"␊
+          },␊
+          "[email protected]": {␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@b-package": "@b-package"␊
+          },␊
+          "[email protected]": {␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@b-package": "@b-package"␊
+          },␊
+          "@[email protected]": {␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@b-package": "@b-package"␊
+          },␊
+          "[email protected]": {␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@b-package": "@b-package"␊
+          },␊
+          "@b-package": {␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "@b-package": "@b-package"␊
+          }␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "dependenciesMeta": {␊
+          "@[email protected]": {␊
+            "@[email protected]": "@[email protected]",␊
+            "@b-package": "@b-package",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]"␊
+          },␊
+          "@b-package": {␊
+            "@[email protected]": "@[email protected]",␊
+            "@b-package": "@b-package",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]"␊
+          },␊
+          "@[email protected]": {␊
+            "@[email protected]": "@[email protected]",␊
+            "@b-package": "@b-package",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]"␊
+          },␊
+          "[email protected]": {␊
+            "@[email protected]": "@[email protected]",␊
+            "@b-package": "@b-package",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]"␊
+          },␊
+          "[email protected]": {␊
+            "@[email protected]": "@[email protected]",␊
+            "@b-package": "@b-package",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]"␊
+          },␊
+          "[email protected]": {␊
+            "@[email protected]": "@[email protected]",␊
+            "@b-package": "@b-package",␊
+            "@[email protected]": "@[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]",␊
+            "[email protected]": "[email protected]"␊
+          }␊
+        }␊
+      }`,
+      pretty: true,
+    }
diff --git a/tests/snapshots/deps.js.snap b/tests/snapshots/deps.js.snap