From 7e1dd1fff32f07cd8374fc4676ceda0d032e60ac Mon Sep 17 00:00:00 2001
From: rickh18 <7232509+rickh18@users.noreply.github.com>
Date: Wed, 21 Aug 2024 23:25:26 +0200
Subject: [PATCH] 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.
---
 index.js                     |  56 +++++++++-----
 tests/_helpers.js            |  35 +++++++++
 tests/deps.js                |   9 ++-
 tests/snapshots/deps.js.md   | 140 +++++++++++++++++++++++++++++++++++
 tests/snapshots/deps.js.snap | Bin 429 -> 685 bytes
 5 files changed, 222 insertions(+), 18 deletions(-)

diff --git a/index.js b/index.js
index 8c932512..60ecd43a 100755
--- 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
index 711e562d..7f2ba700 100644
--- 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(
+        [
+          '@z-package@1.2.3',
+          'c-package@1.2.3',
+          'b-package-package@1.2.3',
+          '@a-package@1.2.3',
+          'b-package@1.2.3',
+          '@b-package',
+        ],
+        depth,
+      ),
+      expect:
+        expect ||
+        keysToObject(
+          [
+            '@a-package@1.2.3',
+            '@b-package',
+            '@z-package@1.2.3',
+            'b-package@1.2.3',
+            'b-package-package@1.2.3',
+            'c-package@1.2.3',
+          ],
+          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
index c263554a..eaca27b3 100644
--- 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
index 4dc7c8b2..ce3b6806 100644
--- 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": {␊
+          "@z-package@1.2.3": "@z-package@1.2.3",␊
+          "c-package@1.2.3": "c-package@1.2.3",␊
+          "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+          "@a-package@1.2.3": "@a-package@1.2.3",␊
+          "b-package@1.2.3": "b-package@1.2.3",␊
+          "@b-package": "@b-package"␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "dependenciesMeta": {␊
+          "@a-package@1.2.3": "@a-package@1.2.3",␊
+          "@b-package": "@b-package",␊
+          "@z-package@1.2.3": "@z-package@1.2.3",␊
+          "b-package@1.2.3": "b-package@1.2.3",␊
+          "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+          "c-package@1.2.3": "c-package@1.2.3"␊
+        }␊
+      }`,
+      pretty: true,
+    }
+
+> Should sort `dependenciesMeta` as object.
+
+    {
+      input: `{␊
+        "dependenciesMeta": {␊
+          "@z-package@1.2.3": {␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "@b-package": "@b-package"␊
+          },␊
+          "c-package@1.2.3": {␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "@b-package": "@b-package"␊
+          },␊
+          "b-package-package@1.2.3": {␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "@b-package": "@b-package"␊
+          },␊
+          "@a-package@1.2.3": {␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "@b-package": "@b-package"␊
+          },␊
+          "b-package@1.2.3": {␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "@b-package": "@b-package"␊
+          },␊
+          "@b-package": {␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "@b-package": "@b-package"␊
+          }␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "dependenciesMeta": {␊
+          "@a-package@1.2.3": {␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "@b-package": "@b-package",␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3"␊
+          },␊
+          "@b-package": {␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "@b-package": "@b-package",␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3"␊
+          },␊
+          "@z-package@1.2.3": {␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "@b-package": "@b-package",␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3"␊
+          },␊
+          "b-package@1.2.3": {␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "@b-package": "@b-package",␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3"␊
+          },␊
+          "b-package-package@1.2.3": {␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "@b-package": "@b-package",␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3"␊
+          },␊
+          "c-package@1.2.3": {␊
+            "@a-package@1.2.3": "@a-package@1.2.3",␊
+            "@b-package": "@b-package",␊
+            "@z-package@1.2.3": "@z-package@1.2.3",␊
+            "b-package@1.2.3": "b-package@1.2.3",␊
+            "b-package-package@1.2.3": "b-package-package@1.2.3",␊
+            "c-package@1.2.3": "c-package@1.2.3"␊
+          }␊
+        }␊
+      }`,
+      pretty: true,
+    }
diff --git a/tests/snapshots/deps.js.snap b/tests/snapshots/deps.js.snap
index 4d621cf5dd1d162151f02d9f006f3942ec320a75..26fa3e13ca827f77953d322f49e5722dfe4da7f0 100644
GIT binary patch
literal 685
zcmV;e0#f}!RzV<BZeeh9Xm4~Nb~6eC01oXBG*0a1--bYg6}()595hI5(@S1We2HVy
z^?5B%2_K6H00000000B+mrsk+Kp4iKNo^yAC0$nVIs`95x8k2u57L7dK@s%iZKuh&
z8@D8(nSxdd;`$*x=wTNGKY@omdhly_5I=?>N&hC9CK-pq9@0a}%w*<$=l8r%GC6-W
z90ks4baugoCq`U^oR1&zkozw89gjy(xnN%8voJadMD*dpb(vr<$%6(=#6NPKH2VMs
z06qh_1aOl82c)%6TF-{Bxg!W!U3NMhkUfxVAQldYaf38Kn){^b`Qbz?TMys0DYa#(
z*nJw0QEE@^e*D*+x8ebt*=<T^?OA4RGYEwj_)*d}_cEicU?LPlFM@SbiAY1Y!Z8=(
zZPGL>K4L>YdUN>VB$$j`8U<rPk7S{aD2r&20P8J@|Bw;?9k&VaRg<{!5fzcoFSGnp
z3Q#)RP^H=gZQ-izAeB%`#*~oj9ZV}v*qQ!wV}@?IDZ8=~`2^rQ087`D{e*8ejh!2^
zEUcy(Z>Pk_hLIWZQbzd~fWH8~=o;}oDqy~{CM?bVN*GW<^SSvZ*?XQd|Cr|;*f3<Z
zaYlf10{k&FYvUFvp*xr!hRiu-$9!<NcdvIp#*^z?fOYb>X1f-54wv2e8QX>yGY3qP
zPqr@`MY4Kk)m4A8-nyk<zvYA#cC<CmuDV*)>HNQ16)Iwf&sFP*%sbyq;HL@Pu{6E&
z*i`q<>baw!l!~)-)KaTOl?p0x*!t0&-)9Z15ZLzIYjB0&B=Kuv)k>`fR<Xo3@2XkJ
zS?M3J%3s4pR#)10$?;2BT@{Wx>Q+03l~!)eO2(?_kXI9v5G#6-)WC{>)!@{?6@5<B
Tz&3&H;w$_goPtd$2^s(Z+q^|O

literal 429
zcmV;e0aE@!RzV<BZeeh9Xm4~Nb~6eC07X|UGWUCcdKKRb9LK$p8VP^ZfbMujYY$)f
zE&XhIdLN4j00000000A9n3j~2pPXIXv?#SCvm__Aq#!l5$R)KPH7_MKFF7-{*f+H#
zF|#-?v7k63zXYf(B_**WF_O`QnSq@F1Q<COS*?Jy0}#&v;$1*2&d9(Z%*ZCl$mXAv
zm6}|_$OvZ&2naAR@-i^8Ffj51)i8-LGBYr;3No^0<`tBdz<74mTnY+G*qowdr2vux
z%2olHKtcz?14#f0Ag7kA7R_w-{DP9q{Jdf?pPd&?mMy=ughZ>Mmg%541gq6-1x2YP
zC6!<<6Mt$>Vp3{Og>G<0erZmMLUDdki9!N4s}d9vixu+00j38F@k7``{4t0R4DF>9
zhB#9T1Cc=vVWNjWN(=x40x4FA(?D^=5$6LG2cbkGN<<=jP(`!`n#DgPV-}<k&XhXX
zlE@4o-Uh_{lx9jRaQLD-gXS5MkhK(MMopB+K(_{4M%;xhl<x!aUm%`KX+~^dAR?Ft
XZ6+k>`azKaiH~ytS)vZn9|r&c>~yNl