mirror of
https://github.com/jquery/jquery.git
synced 2024-12-09 08:04:24 +00:00
60f11b58bf
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.
As for the factory entry points:
1. Node.js always gets the CommonJS version
2. Bundlers always get the ESM version
3. Other tools take the ESM version when using `import` and the CommonJS when
using `require`.
The complexity is lower than for the `.` & `./slim` entry points because there's
no default export to handle so Node/bundler wrapper files are not necessary.
Other changes:
* Tests: Change "node:assert" to "node:assert/strict"; the former is deprecated
* Docs: Mention that the CommonJS module doesn't expose named exports
* Tests: Run Node & bundler tests for all the above cases
Fixes gh-5416
Closes gh-5429
43 lines
1.4 KiB
JavaScript
43 lines
1.4 KiB
JavaScript
import { rollup } from "rollup";
|
|
|
|
import { loadConfigFile } from "rollup/loadConfigFile";
|
|
import path from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
|
|
const dirname = path.dirname( fileURLToPath( import.meta.url ) );
|
|
const pureEsmConfigPath = path.resolve(
|
|
dirname, "..", "rollup-pure-esm.config.js" );
|
|
const commonJSConfigPath = path.resolve(
|
|
dirname, "..", "rollup-commonjs.config.js" );
|
|
|
|
// See https://rollupjs.org/javascript-api/#programmatically-loading-a-config-file
|
|
async function runRollup( name, configPath ) {
|
|
|
|
console.log( `Running Rollup, version: ${ name }` );
|
|
|
|
// options is an array of "inputOptions" objects with an additional
|
|
// "output" property that contains an array of "outputOptions".
|
|
// We generate a single output so the array only has one element.
|
|
const {
|
|
options: [ optionsObj ],
|
|
warnings
|
|
} = await loadConfigFile( configPath, {} );
|
|
|
|
// "warnings" wraps the default `onwarn` handler passed by the CLI.
|
|
// This prints all warnings up to this point:
|
|
warnings.flush();
|
|
|
|
const bundle = await rollup( optionsObj );
|
|
await Promise.all( optionsObj.output.map( bundle.write ) );
|
|
|
|
console.log( `Build completed: Rollup, version: ${ name }` );
|
|
}
|
|
|
|
export async function runRollupPureEsm() {
|
|
await runRollup( "pure ESM", pureEsmConfigPath );
|
|
}
|
|
|
|
export async function runRollupEsmAndCommonJs() {
|
|
await runRollup( "ESM + CommonJS", commonJSConfigPath );
|
|
}
|