Core: Fix the exports setup to make bundlers work with ESM & CommonJS

mgol · mgol · commit d3a28fae2e39 · 2024-03-02T23:49:53.000+01:00
We cannot pass a single file via the `module` condition as then `require( "jquery" )` will not return jQuery but instead the module object with `default`, `$` & `jQuery` as keys. Instead: 1. For Node.js, detected via the `node` condition: 1. Expose a regular CommonJS version to `require` 2. Expose a tiny wrapper over CommonJS to `import` 2. For bundlers, detected via the `module` condition: 1. Expose a regular ESM version to `import` 2. Expose a tiny wrapper over ESM to `require` 3. If neither Node.js nor bundlers are detected (no `node` or `module` conditions`): 1. Expose a regular CommonJS version to `require` 2. Expose a regular ESM version to `import` The reasons for such definitions are as follows: 1. In Node.js, one can synchronously import from a CommonJS file inside of an ESM one but not vice-versa. To use an ESM file in a CommonJS one, a dynamic import is required and that forces asynchronicity. 2. In some bundlers CommonJS is not necessarily enabled - e.g. in Rollup without the CommonJS plugin. Therefore, the ESM version needs to be pure ESM. However, bundlers allow synchronously calling `require` on an ESM file. This is possible since bundlers merge the files before they are passed to the browser to execute and the final bundles no longer contain async import code. 3. Bare ESM & CommonJS versions are provided to non-Node non-bundler environments where we cannot assume interoperability between ESM & CommonJS is supported. 4. Bare versions cannot be supplied to Node or bundlers as projects using both ESM & CommonJS to fetch jQuery would result in duplicate jQuery instances, leading to increased JS size and disjoint data storage. In addition to the above changes, the `script` condition has been dropped. Only Webpack documents this condition and it's not clear when exactly it's triggered. Adding support for a new condition can be added later without a breaking change; removing is not so easy. The `production` & `development` conditions have been removed as well. They were not really applied correctly; we'd need to provide both of them to each current leaf which would double the size of the definition for the `.` & `./slim` entry points. In jQuery, the only difference between development & production builds is minification; there are no logic changes so we can pass unminified versions to all the tooling, expecting minification down the line. Fixes gh-5416
diff --git a/.gitignore b/.gitignore
@@ -16,6 +16,8 @@ npm-debug.log*
 # the ESLint config & package.json files
 /dist/*
 !/dist/package.json
+!/dist/jquery.bundler-require-wrapper.js
+!/dist/jquery.bundler-require-wrapper.slim.js
 
 # Ignore everything in the `dist-module` folder except for the ESLint config,
 # package.json & Node module wrapper files
diff --git a/build/release/dist.js b/build/release/dist.js
@@ -17,6 +17,8 @@ module.exports = function( Release, files, complete ) {
 		"LICENSE.txt",
 		"AUTHORS.txt",
 		"dist/package.json",
+		"dist/jquery.bundler-require-wrapper.js",
+		"dist/jquery.bundler-require-wrapper.slim.js",
 		"dist-module/package.json",
 		"dist-module/jquery.node-module-wrapper.js",
 		"dist-module/jquery.node-module-wrapper.slim.js"
diff --git a/dist/jquery.bundler-require-wrapper.js b/dist/jquery.bundler-require-wrapper.js
@@ -0,0 +1,5 @@
+"use strict";
+
+// Bundlers are able to synchronously require an ESM module from a CommonJS one.
+const { jQuery } = require( "../dist-module/jquery.module.js" );
+module.exports = jQuery;
diff --git a/dist/jquery.bundler-require-wrapper.slim.js b/dist/jquery.bundler-require-wrapper.slim.js
@@ -0,0 +1,5 @@
+"use strict";
+
+// Bundlers are able to synchronously require an ESM module from a CommonJS one.
+const { jQuery } = require( "../dist-module/jquery.slim.module.js" );
+module.exports = jQuery;
diff --git a/eslint.config.js b/eslint.config.js
@@ -303,6 +303,8 @@ export default [
 
 	{
 		files: [
+			"dist/jquery.bundler-require-wrapper.js",
+			"dist/jquery.bundler-require-wrapper.slim.js",
 			"dist-module/jquery.node-module-wrapper.js",
 			"dist-module/jquery.node-module-wrapper.slim.js"
 		],
diff --git a/package.json b/package.json
@@ -7,25 +7,27 @@
   "exports": {
     ".": {
       "node": {
-        "module": "./dist-module/jquery.module.js",
         "import": "./dist-module/jquery.node-module-wrapper.js",
-        "require": "./dist/jquery.js"
+        "default": "./dist/jquery.js"
       },
-      "production": "./dist-module/jquery.module.min.js",
-      "development": "./dist-module/jquery.module.js",
-      "script": "./dist/jquery.min.js",
-      "default": "./dist-module/jquery.module.min.js"
+      "module": {
+        "import": "./dist-module/jquery.module.js",
+        "default": "./dist/jquery.bundler-require-wrapper.js"
+      },
+      "import": "./dist-module/jquery.module.js",
+      "default": "./dist/jquery.js"
     },
     "./slim": {
       "node": {
-        "module": "./dist-module/jquery.slim.module.js",
         "import": "./dist-module/jquery.node-module-wrapper.slim.js",
-        "require": "./dist/jquery.slim.js"
+        "default": "./dist/jquery.slim.js"
+      },
+      "module": {
+        "import": "./dist-module/jquery.slim.module.js",
+        "default": "./dist/jquery.bundler-require-wrapper.slim.js"
       },
-      "production": "./dist-module/jquery.slim.module.min.js",
-      "development": "./dist-module/jquery.slim.module.js",
-      "script": "./dist/jquery.slim.min.js",
-      "default": "./dist-module/jquery.slim.module.min.js"
+      "import": "./dist-module/jquery.slim.module.js",
+      "default": "./dist/jquery.slim.js"
     },
     "./factory": "./dist-module/jquery.factory.module.js",
     "./factory-slim": "./dist-module/jquery.factory.slim.module.js",

Original file line number	Diff line number	Diff line change
`@@ -303,6 +303,8 @@ export default [`
`303`	`303`
`304`	`304`	`{`
`305`	`305`	`files: [`
	`306`	`+ "dist/jquery.bundler-require-wrapper.js",`
	`307`	`+ "dist/jquery.bundler-require-wrapper.slim.js",`
`306`	`308`	`"dist-module/jquery.node-module-wrapper.js",`
`307`	`309`	`"dist-module/jquery.node-module-wrapper.slim.js"`
`308`	`310`	`],`