feat: sort types and default in exports field

index.js

@@ -32,6 +32,22 @@ const sortObjectBy = (comparator, deep) => {
 
   return over
 }
+const objectGroupBy =
+  // eslint-disable-next-line n/no-unsupported-features/es-builtins, n/no-unsupported-features/es-syntax -- Safe
+  Object.groupBy ||
+  // Remove this when we drop support for Node.js 20
+  ((array, callback) => {
+    const result = Object.create(null)
+    for (const value of array) {
+      const key = callback(value)
+      if (result[key]) {
+        result[key].push(value)
+      } else {
+        result[key] = [value]
+      }
+    }
+    return result
+  })
 const sortObject = sortObjectBy()
 const sortURLObject = sortObjectBy(['type', 'url'])
 const sortPeopleObject = sortObjectBy(['name', 'email', 'url'])
@@ -245,6 +261,44 @@ const sortScripts = onObject((scripts, packageJson) => {
   return sortObjectKeys(scripts, order)
 })
 
+/*
+- Move `types` and versioned type condition to top
+- Move `default` condition to bottom
+*/
+const sortConditions = (conditions) => {
+  const {
+    typesConditions = [],
+    defaultConditions = [],
+    restConditions = [],
+  } = objectGroupBy(conditions, (condition) => {
+    if (condition === 'types' || condition.startsWith('types@')) {
+      return 'typesConditions'
+    }
+
+    if (condition === 'default') {
+      return 'defaultConditions'
+    }
+
+    return 'restConditions'
+  })
+
+  return [...typesConditions, ...restConditions, ...defaultConditions]
+}
+
+const sortExports = onObject((exports) => {
+  const { paths = [], conditions = [] } = objectGroupBy(
+    Object.keys(exports),
+    (key) => (key.startsWith('.') ? 'paths' : 'conditions'),
+  )
+
+  return Object.fromEntries(
+    [...paths, ...sortConditions(conditions)].map((key) => [
+      key,
+      sortExports(exports[key]),
+    ]),
+  )
+})
+
 // fields marked `vscode` are for `Visual Studio Code extension manifest` only
 // https://code.visualstudio.com/api/references/extension-manifest
 // Supported fields:
@@ -283,7 +337,7 @@ const fields = [
   { key: 'sideEffects' },
   { key: 'type' },
   { key: 'imports' },
-  { key: 'exports' },
+  { key: 'exports', over: sortExports },
   { key: 'main' },
   { key: 'svelte' },
   { key: 'umd:main' },

tests/exports.js

@@ -0,0 +1,79 @@
+import test from 'ava'
+import { macro } from './_helpers.js'
+
+for (const deep of [false, true]) {
+  const titleSuffix = deep ? `(deep)` : ''
+
+  {
+    const exports = {
+      unknown: './unknown.unknown',
+      './path-not-really-makes-no-sense': {},
+      types: './types.d.ts',
+      'types@<=1': './v1/types.d.ts',
+    }
+
+    test(`'types' condition should be first${titleSuffix}`, macro.sortObject, {
+      path: 'exports',
+      expect: 'snapshot',
+      value: deep ? { './deep': exports } : exports,
+    })
+  }
+
+  {
+    const exports = {
+      unknown: './unknown.unknown',
+      './path-not-really-makes-no-sense': {},
+      'types@<=1': './v1/types.d.ts',
+      types: './types.d.ts',
+    }
+
+    test(
+      `'types' condition should be first${titleSuffix} 2`,
+      macro.sortObject,
+      {
+        path: 'exports',
+        expect: 'snapshot',
+        value: deep ? { './deep': exports } : exports,
+      },
+    )
+  }
+
+  {
+    const exports = {
+      unknown: './unknown.unknown',
+      './path-not-really-makes-no-sense': {},
+      default: './default.js',
+    }
+
+    test(`'default' condition should be last${titleSuffix}`, macro.sortObject, {
+      path: 'exports',
+      expect: 'snapshot',
+      value: deep ? { './deep': exports } : exports,
+    })
+  }
+}
+
+test(`Only 'types'`, macro.sortObject, {
+  path: 'exports',
+  expect: 'snapshot',
+  value: {
+    types: './types.d.ts',
+  },
+})
+
+test(`Only 'default'`, macro.sortObject, {
+  path: 'exports',
+  expect: 'snapshot',
+  value: {
+    default: './default.js',
+  },
+})
+
+test(`Well formed`, macro.sortObject, {
+  path: 'exports',
+  expect: 'snapshot',
+  value: {
+    types: './types.d.ts',
+    default: './default.js',
+  },
+})

tests/snapshots/exports.js.md

@@ -0,0 +1,222 @@
+# Snapshot report for `tests/exports.js`
+
+The actual snapshot is saved in `exports.js.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## 'types' condition should be first
+
+> Should sort `exports` as object.
+
+    {
+      input: `{␊
+        "exports": {␊
+          "unknown": "./unknown.unknown",␊
+          "./path-not-really-makes-no-sense": {},␊
+          "types": "./types.d.ts",␊
+          "types@<=1": "./v1/types.d.ts"␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "exports": {␊
+          "./path-not-really-makes-no-sense": {},␊
+          "types": "./types.d.ts",␊
+          "types@<=1": "./v1/types.d.ts",␊
+          "unknown": "./unknown.unknown"␊
+        }␊
+      }`,
+      pretty: true,
+    }
+
+## 'types' condition should be first 2
+
+> Should sort `exports` as object.
+
+    {
+      input: `{␊
+        "exports": {␊
+          "unknown": "./unknown.unknown",␊
+          "./path-not-really-makes-no-sense": {},␊
+          "types@<=1": "./v1/types.d.ts",␊
+          "types": "./types.d.ts"␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "exports": {␊
+          "./path-not-really-makes-no-sense": {},␊
+          "types@<=1": "./v1/types.d.ts",␊
+          "types": "./types.d.ts",␊
+          "unknown": "./unknown.unknown"␊
+        }␊
+      }`,
+      pretty: true,
+    }
+
+## 'default' condition should be last
+
+> Should sort `exports` as object.
+
+    {
+      input: `{␊
+        "exports": {␊
+          "unknown": "./unknown.unknown",␊
+          "./path-not-really-makes-no-sense": {},␊
+          "default": "./default.js"␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "exports": {␊
+          "./path-not-really-makes-no-sense": {},␊
+          "unknown": "./unknown.unknown",␊
+          "default": "./default.js"␊
+        }␊
+      }`,
+      pretty: true,
+    }
+
+## 'types' condition should be first(deep)
+
+> Should sort `exports` as object.
+
+    {
+      input: `{␊
+        "exports": {␊
+          "./deep": {␊
+            "unknown": "./unknown.unknown",␊
+            "./path-not-really-makes-no-sense": {},␊
+            "types": "./types.d.ts",␊
+            "types@<=1": "./v1/types.d.ts"␊
+          }␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "exports": {␊
+          "./deep": {␊
+            "./path-not-really-makes-no-sense": {},␊
+            "types": "./types.d.ts",␊
+            "types@<=1": "./v1/types.d.ts",␊
+            "unknown": "./unknown.unknown"␊
+          }␊
+        }␊
+      }`,
+      pretty: true,
+    }
+
+## 'types' condition should be first(deep) 2
+
+> Should sort `exports` as object.
+
+    {
+      input: `{␊
+        "exports": {␊
+          "./deep": {␊
+            "unknown": "./unknown.unknown",␊
+            "./path-not-really-makes-no-sense": {},␊
+            "types@<=1": "./v1/types.d.ts",␊
+            "types": "./types.d.ts"␊
+          }␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "exports": {␊
+          "./deep": {␊
+            "./path-not-really-makes-no-sense": {},␊
+            "types@<=1": "./v1/types.d.ts",␊
+            "types": "./types.d.ts",␊
+            "unknown": "./unknown.unknown"␊
+          }␊
+        }␊
+      }`,
+      pretty: true,
+    }
+
+## 'default' condition should be last(deep)
+
+> Should sort `exports` as object.
+
+    {
+      input: `{␊
+        "exports": {␊
+          "./deep": {␊
+            "unknown": "./unknown.unknown",␊
+            "./path-not-really-makes-no-sense": {},␊
+            "default": "./default.js"␊
+          }␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "exports": {␊
+          "./deep": {␊
+            "./path-not-really-makes-no-sense": {},␊
+            "unknown": "./unknown.unknown",␊
+            "default": "./default.js"␊
+          }␊
+        }␊
+      }`,
+      pretty: true,
+    }
+
+## Only 'types'
+
+> Should sort `exports` as object.
+
+    {
+      input: `{␊
+        "exports": {␊
+          "types": "./types.d.ts"␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "exports": {␊
+          "types": "./types.d.ts"␊
+        }␊
+      }`,
+      pretty: true,
+    }
+
+## Only 'default'
+
+> Should sort `exports` as object.
+
+    {
+      input: `{␊
+        "exports": {␊
+          "default": "./default.js"␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "exports": {␊
+          "default": "./default.js"␊
+        }␊
+      }`,
+      pretty: true,
+    }
+
+## Well formed
+
+> Should sort `exports` as object.
+
+    {
+      input: `{␊
+        "exports": {␊
+          "types": "./types.d.ts",␊
+          "default": "./default.js"␊
+        }␊
+      }`,
+      options: undefined,
+      output: `{␊
+        "exports": {␊
+          "types": "./types.d.ts",␊
+          "default": "./default.js"␊
+        }␊
+      }`,
+      pretty: true,
+    }