feat: improve pnpm sorting (#314)

* feat: improve sorting of pnpm.overrides

* fix: replace .at with .pop

* feat: handle parent/child overrides ('pkgA>pkgB')

* chore: simplify

Author: westrik

index.js

@@ -3,6 +3,7 @@ import detectIndent from 'detect-indent'
 import { detectNewlineGraceful as detectNewline } from 'detect-newline'
 import gitHooks from 'git-hooks-list'
 import isPlainObject from 'is-plain-obj'
+import semver from 'semver'
 
 const hasOwn =
   Object.hasOwn ||
@@ -54,6 +55,38 @@ 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 { name: aName, range: aRange } = parseNameAndVersionRange(a)
+  const { name: bName, range: bRange } = parseNameAndVersionRange(b)
+
+  if (aName !== bName) {
+    return aName.localeCompare(bName)
+  }
+  if (!aRange) {
+    return -1
+  }
+  if (!bRange) {
+    return 1
+  }
+  return semver.compare(semver.minVersion(aRange), semver.minVersion(bRange))
+})
+
 // https://github.com/eslint/eslint/blob/acc0e47572a9390292b4e313b4a4bf360d236358/conf/config-schema.js
 const eslintBaseConfigProperties = [
   // `files` and `excludedFiles` are only on `overrides[]`
@@ -128,6 +161,29 @@ const sortPrettierConfig = onObject(
 
 const sortVolta = sortObjectBy(['node', 'npm', 'yarn'])
 
+const pnpmBaseConfigProperties = [
+  'peerDependencyRules',
+  'neverBuiltDependencies',
+  'onlyBuiltDependencies',
+  'onlyBuiltDependenciesFile',
+  'allowedDeprecatedVersions',
+  'allowNonAppliedPatches',
+  'updateConfig',
+  'auditConfig',
+  'requiredScripts',
+  'supportedArchitectures',
+  'overrides',
+  'patchedDependencies',
+  'packageExtensions',
+]
+
+const sortPnpmConfig = onObject(
+  pipe([
+    sortObjectBy(pnpmBaseConfigProperties, true),
+    overProperty('overrides', sortObjectBySemver),
+  ]),
+)
+
 // See https://docs.npmjs.com/misc/scripts
 const defaultNpmScripts = new Set([
   'install',
@@ -312,7 +368,7 @@ const fields = [
   /* vscode */ { key: 'galleryBanner', over: sortObject },
   /* vscode */ { key: 'preview' },
   /* vscode */ { key: 'markdown' },
-  { key: 'pnpm', over: sortObjectBy(undefined, true) },
+  { key: 'pnpm', over: sortPnpmConfig },
 ]
 
 const defaultSortOrder = fields.map(({ key }) => key)

package-lock.json

@@ -73,6 +73,7 @@
     "git-hooks-list": "^3.0.0",
     "globby": "^13.1.2",
     "is-plain-obj": "^4.1.0",
+    "semver": "^7.6.0",
     "sort-object-keys": "^1.1.3"
   },
   "devDependencies": {

package.json

@@ -263,9 +263,16 @@ test('pnpm', macro.sortObject, {
   path: 'pnpm',
   value: {
     overrides: {
+      '@react-stately/selection@~3.10.3': '3.10.3',
       'aws-sdk@1.2345.0': '1.123.0',
       'react-native-notifications@^3.4.5': '3.4.5',
       'antd@^2.23.4': '2.23.4',
+      '@react-stately/select@~3.1.3': '3.1.3',
+      '@react-stately/selection@~3.7.0': '3.7.0',
+      '@react-stately/select@3': '3.3.1',
+      '@react-aria/selection@3.10.1>@react-stately/selection': '3.10.3',
+      '@react-aria/selection@3.10.1>@react-aria/focus': '3.8.0',
+      '@react-aria/selection@3.5.1>@react-stately/selection': '3.10.3',
     },
     patchedDependencies: {
       'esbuild-sass-plugin@1.20.0': 'foo.patch',
@@ -289,10 +296,22 @@ test('pnpm', macro.sortObject, {
   expect: {
     allowNonAppliedPatches: true,
     overrides: {
+      '@react-aria/selection@3.5.1>@react-stately/selection': '3.10.3',
+      '@react-aria/selection@3.10.1>@react-aria/focus': '3.8.0',
+      '@react-aria/selection@3.10.1>@react-stately/selection': '3.10.3',
+      '@react-stately/select@3': '3.3.1',
+      '@react-stately/select@~3.1.3': '3.1.3',
+      '@react-stately/selection@~3.7.0': '3.7.0',
+      '@react-stately/selection@~3.10.3': '3.10.3',
       'antd@^2.23.4': '2.23.4',
       'aws-sdk@1.2345.0': '1.123.0',
       'react-native-notifications@^3.4.5': '3.4.5',
     },
+    patchedDependencies: {
+      'domino@4.5.6': 'bar.patch',
+      'es5-ext@0.12.3': 'baz.patch',
+      'esbuild-sass-plugin@1.20.0': 'foo.patch',
+    },
     packageExtensions: {
       '@rjsf/core': {
         dependencies: {
@@ -305,10 +324,5 @@ test('pnpm', macro.sortObject, {
         },
       },
     },
-    patchedDependencies: {
-      'domino@4.5.6': 'bar.patch',
-      'es5-ext@0.12.3': 'baz.patch',
-      'esbuild-sass-plugin@1.20.0': 'foo.patch',
-    },
   },
 })