refactor: Breaking changes to outputs & pkg.json (#4652)

rschristian · marvinhagemeister · JoviDeCroock · commit f88e874eaa1a · 2025-02-18T07:23:23.000+01:00
* refactor: Switch to `package.json#exports.module`, drop `.min` builds, &amp;  use `.mjs` exclusively

* chore: Remove leftover CJS shell

* test: Fix export for karma

* fix: coverage not generated in minify tests

---------

Co-authored-by: Marvin Hagemeister &lt;hello@marvinh.dev&gt;
diff --git a/compat/package.json b/compat/package.json
@@ -5,7 +5,7 @@
   "private": true,
   "description": "A React compatibility layer for Preact",
   "main": "dist/compat.js",
-  "module": "dist/compat.module.js",
+  "module": "dist/compat.mjs",
   "umd:main": "dist/compat.umd.js",
   "source": "src/index.js",
   "types": "src/index.d.ts",
@@ -19,7 +19,7 @@
   "exports": {
     ".": {
       "types": "./src/index.d.ts",
-      "browser": "./dist/compat.module.js",
+      "module": "./dist/compat.mjs",
       "umd": "./dist/compat.umd.js",
       "import": "./dist/compat.mjs",
       "require": "./dist/compat.js"
diff --git a/config/node-13-exports.js b/config/node-13-exports.js
diff --git a/debug/package.json b/debug/package.json
@@ -5,7 +5,7 @@
   "private": true,
   "description": "Preact extensions for development",
   "main": "dist/debug.js",
-  "module": "dist/debug.module.js",
+  "module": "dist/debug.mjs",
   "umd:main": "dist/debug.umd.js",
   "source": "src/index.js",
   "license": "MIT",
@@ -18,7 +18,7 @@
   "exports": {
     ".": {
       "types": "./src/index.d.ts",
-      "browser": "./dist/debug.module.js",
+      "module": "./dist/debug.mjs",
       "umd": "./dist/debug.umd.js",
       "import": "./dist/debug.mjs",
       "require": "./dist/debug.js"
diff --git a/devtools/package.json b/devtools/package.json
@@ -5,7 +5,7 @@
   "private": true,
   "description": "Preact bridge for Preact devtools",
   "main": "dist/devtools.js",
-  "module": "dist/devtools.module.js",
+  "module": "dist/devtools.mjs",
   "umd:main": "dist/devtools.umd.js",
   "source": "src/index.js",
   "license": "MIT",
@@ -16,7 +16,7 @@
   "exports": {
     ".": {
       "types": "./src/index.d.ts",
-      "browser": "./dist/devtools.module.js",
+      "module": "./dist/devtools.mjs",
       "umd": "./dist/devtools.umd.js",
       "import": "./dist/devtools.mjs",
       "require": "./dist/devtools.js"
diff --git a/hooks/package.json b/hooks/package.json
@@ -5,7 +5,7 @@
   "private": true,
   "description": "Hook addon for Preact",
   "main": "dist/hooks.js",
-  "module": "dist/hooks.module.js",
+  "module": "dist/hooks.mjs",
   "umd:main": "dist/hooks.umd.js",
   "source": "src/index.js",
   "license": "MIT",
@@ -26,7 +26,7 @@
   "exports": {
     ".": {
       "types": "./src/index.d.ts",
-      "browser": "./dist/hooks.module.js",
+      "module": "./dist/hooks.mjs",
       "umd": "./dist/hooks.umd.js",
       "import": "./dist/hooks.mjs",
       "require": "./dist/hooks.js"
diff --git a/jsx-runtime/package.json b/jsx-runtime/package.json
@@ -5,7 +5,7 @@
   "private": true,
   "description": "Preact JSX runtime",
   "main": "dist/jsxRuntime.js",
-  "module": "dist/jsxRuntime.module.js",
+  "module": "dist/jsxRuntime.mjs",
   "umd:main": "dist/jsxRuntime.umd.js",
   "source": "src/index.js",
   "types": "src/index.d.ts",
@@ -19,7 +19,7 @@
   "exports": {
     ".": {
       "types": "./src/index.d.ts",
-      "browser": "./dist/jsxRuntime.module.js",
+      "module": "./dist/jsxRuntime.mjs",
       "umd": "./dist/jsxRuntime.umd.js",
       "import": "./dist/jsxRuntime.mjs",
       "require": "./dist/jsxRuntime.js"
diff --git a/karma.conf.js b/karma.conf.js
@@ -62,7 +62,7 @@ const subPkgPath = pkgName => {
 	const stripped = pkgName.replace(/[/\\./]/g, '');
 	const pkgJson = path.join(__dirname, 'package.json');
 	const pkgExports = require(pkgJson).exports;
-	const file = pkgExports[stripped ? `./${stripped}` : '.'].browser;
+	const file = pkgExports[stripped ? `./${stripped}` : '.'].module;
 	return path.join(__dirname, file);
 };
 
@@ -181,7 +181,7 @@ function createEsbuildPlugin() {
 							coverage && [
 								'istanbul',
 								{
-									include: minify ? '**/dist/**/*.js' : '**/src/**/*.js'
+									include: minify ? '**/dist/**/*.{js,mjs}' : '**/src/**/*.js'
 								}
 							]
 						].filter(Boolean)
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
   "description": "Fast 3kb React-compatible Virtual DOM library.",
   "type": "commonjs",
   "main": "dist/preact.js",
-  "module": "dist/preact.module.js",
+  "module": "dist/preact.mjs",
   "umd:main": "dist/preact.umd.js",
   "unpkg": "dist/preact.min.js",
   "source": "src/index.js",
@@ -21,56 +21,56 @@
         "types": "./src/index-5.d.ts"
       },
       "types": "./src/index.d.ts",
-      "browser": "./dist/preact.module.js",
+      "module": "./dist/preact.mjs",
       "umd": "./dist/preact.umd.js",
       "import": "./dist/preact.mjs",
       "require": "./dist/preact.js"
     },
     "./compat": {
       "types": "./compat/src/index.d.ts",
-      "browser": "./compat/dist/compat.module.js",
+      "module": "./compat/dist/compat.mjs",
       "umd": "./compat/dist/compat.umd.js",
       "import": "./compat/dist/compat.mjs",
       "require": "./compat/dist/compat.js"
     },
     "./debug": {
       "types": "./debug/src/index.d.ts",
-      "browser": "./debug/dist/debug.module.js",
+      "module": "./debug/dist/debug.mjs",
       "umd": "./debug/dist/debug.umd.js",
       "import": "./debug/dist/debug.mjs",
       "require": "./debug/dist/debug.js"
     },
     "./devtools": {
       "types": "./devtools/src/index.d.ts",
-      "browser": "./devtools/dist/devtools.module.js",
+      "module": "./devtools/dist/devtools.mjs",
       "umd": "./devtools/dist/devtools.umd.js",
       "import": "./devtools/dist/devtools.mjs",
       "require": "./devtools/dist/devtools.js"
     },
     "./hooks": {
       "types": "./hooks/src/index.d.ts",
-      "browser": "./hooks/dist/hooks.module.js",
+      "module": "./hooks/dist/hooks.mjs",
       "umd": "./hooks/dist/hooks.umd.js",
       "import": "./hooks/dist/hooks.mjs",
       "require": "./hooks/dist/hooks.js"
     },
     "./test-utils": {
       "types": "./test-utils/src/index.d.ts",
-      "browser": "./test-utils/dist/testUtils.module.js",
+      "module": "./test-utils/dist/testUtils.mjs",
       "umd": "./test-utils/dist/testUtils.umd.js",
       "import": "./test-utils/dist/testUtils.mjs",
       "require": "./test-utils/dist/testUtils.js"
     },
     "./jsx-runtime": {
       "types": "./jsx-runtime/src/index.d.ts",
-      "browser": "./jsx-runtime/dist/jsxRuntime.module.js",
+      "module": "./jsx-runtime/dist/jsxRuntime.mjs",
       "umd": "./jsx-runtime/dist/jsxRuntime.umd.js",
       "import": "./jsx-runtime/dist/jsxRuntime.mjs",
       "require": "./jsx-runtime/dist/jsxRuntime.js"
     },
     "./jsx-dev-runtime": {
       "types": "./jsx-runtime/src/index.d.ts",
-      "browser": "./jsx-runtime/dist/jsxRuntime.module.js",
+      "module": "./jsx-runtime/dist/jsxRuntime.mjs",
       "umd": "./jsx-runtime/dist/jsxRuntime.umd.js",
       "import": "./jsx-runtime/dist/jsxRuntime.mjs",
       "require": "./jsx-runtime/dist/jsxRuntime.js"
@@ -117,14 +117,13 @@
     "prepare": "husky && run-s build && npm-merge-driver-install",
     "build": "npm-run-all --parallel build:*",
     "build:core": "microbundle build --raw --no-generateTypes -f cjs,esm,umd",
-    "build:core-min": "microbundle build --raw --no-generateTypes -f cjs,esm,umd,iife src/cjs.js -o dist/preact.min.js",
     "build:debug": "microbundle build --raw --no-generateTypes -f cjs,esm,umd --cwd debug",
     "build:devtools": "microbundle build --raw --no-generateTypes -f cjs,esm,umd --cwd devtools",
     "build:hooks": "microbundle build --raw --no-generateTypes -f cjs,esm,umd --cwd hooks",
     "build:test-utils": "microbundle build --raw --no-generateTypes -f cjs,esm,umd --cwd test-utils",
     "build:compat": "microbundle build --raw --no-generateTypes -f cjs,esm,umd --cwd compat --globals 'preact/hooks=preactHooks'",
     "build:jsx": "microbundle build --raw --no-generateTypes -f cjs,esm,umd --cwd jsx-runtime",
-    "postbuild": "node ./config/node-13-exports.js && node ./config/compat-entries.js",
+    "postbuild": "node ./config/compat-entries.js",
     "dev": "microbundle watch --raw --no-generateTypes --format cjs",
     "dev:hooks": "microbundle watch --raw --no-generateTypes --format cjs --cwd hooks",
     "dev:compat": "microbundle watch --raw --no-generateTypes --format cjs --cwd compat --globals 'preact/hooks=preactHooks'",
diff --git a/src/cjs.js b/src/cjs.js
diff --git a/test-utils/package.json b/test-utils/package.json
@@ -5,7 +5,7 @@
   "private": true,
   "description": "Test-utils for Preact",
   "main": "dist/testUtils.js",
-  "module": "dist/testUtils.module.js",
+  "module": "dist/testUtils.mjs",
   "umd:main": "dist/testUtils.umd.js",
   "source": "src/index.js",
   "license": "MIT",
@@ -19,7 +19,7 @@
   "exports": {
     ".": {
       "types": "./src/index.d.ts",
-      "browser": "./dist/testUtils.module.js",
+      "module": "./dist/testUtils.mjs",
       "umd": "./dist/testUtils.umd.js",
       "import": "./dist/testUtils.mjs",
       "require": "./dist/testUtils.js"

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ const subPkgPath = pkgName => {`
`62`	`62`	`const stripped = pkgName.replace(/[/\\./]/g, '');`
`63`	`63`	`const pkgJson = path.join(__dirname, 'package.json');`
`64`	`64`	`const pkgExports = require(pkgJson).exports;`
`65`		- const file = pkgExports[stripped ? `./${stripped}` : '.'].browser;
	`65`	+ const file = pkgExports[stripped ? `./${stripped}` : '.'].module;
`66`	`66`	`return path.join(__dirname, file);`
`67`	`67`	`};`
`68`	`68`
`@@ -181,7 +181,7 @@ function createEsbuildPlugin() {`
`181`	`181`	`coverage && [`
`182`	`182`	`'istanbul',`
`183`	`183`	`{`
`184`		`- include: minify ? '/dist//.js' : '/src//.js'`
	`184`	`+ include: minify ? '/dist//.{js,mjs}' : '/src//.js'`
`185`	`185`	`}`
`186`	`186`	`]`
`187`	`187`	`].filter(Boolean)`