mirror of
https://github.com/nodejs/node.git
synced 2025-05-07 17:20:18 +00:00
b1094dbe19
This PR updates the current `--experimental-modules` implementation
based on the work of the modules team and reflects Phase 2 of our
new modules plan.
The largest differences from the current implementation include
* `packge.type` which can be either `module` or `commonjs`
- `type: "commonjs"`:
- `.js` is parsed as commonjs
- default for entry point without an extension is commonjs
- `type: "module"`:
- `.js` is parsed as esm
- does not support loading JSON or Native Module by default
- default for entry point without an extension is esm
* `--entry-type=[mode]`
- allows you set the type on entry point.
* A new file extension `.cjs`.
- this is specifically to support importing commonjs in the
`module` mode.
- this is only in the esm loader, the commonjs loader remains
untouched, but the extension will work in the old loader if you use
the full file path.
* `--es-module-specifier-resolution=[type]`
- options are `explicit` (default) and `node`
- by default our loader will not allow for optional extensions in
the import, the path for a module must include the extension if
there is one
- by default our loader will not allow for importing directories that
have an index file
- developers can use `--es-module-specifier-resolution=node` to
enable the commonjs specifier resolution algorithm
- This is not a “feature” but rather an implementation for
experimentation. It is expected to change before the flag is
removed
* `--experimental-json-loader`
- the only way to import json when `"type": "module"`
- when enable all `import 'thing.json'` will go through the
experimental loader independent of mode
- based on https://github.com/whatwg/html/issues/4315
* You can use `package.main` to set an entry point for a module
- the file extensions used in main will be resolved based on the
`type` of the module
Refs: https://github.com/nodejs/modules/blob/master/doc/plan-for-new-modules-implementation.md
Refs: https://github.com/GeoffreyBooth/node-import-file-specifier-resolution-proposal
Refs: https://github.com/nodejs/modules/pull/180
Refs: https://github.com/nodejs/ecmascript-modules/pull/6
Refs: https://github.com/nodejs/ecmascript-modules/pull/12
Refs: https://github.com/nodejs/ecmascript-modules/pull/28
Refs: https://github.com/nodejs/modules/issues/255
Refs: https://github.com/whatwg/html/issues/4315
Refs: https://github.com/w3c/webcomponents/issues/770
Co-authored-by: Myles Borins <MylesBorins@google.com>
Co-authored-by: John-David Dalton <john.david.dalton@gmail.com>
Co-authored-by: Evan Plaice <evanplaice@gmail.com>
Co-authored-by: Geoffrey Booth <webmaster@geoffreybooth.com>
Co-authored-by: Michaël Zasso <targos@protonmail.com>
PR-URL: https://github.com/nodejs/node/pull/26745
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
78 lines
2.8 KiB
JavaScript
78 lines
2.8 KiB
JavaScript
'use strict';
|
|
const common = require('../common');
|
|
const fixtures = require('../common/fixtures');
|
|
const path = require('path');
|
|
const assert = require('assert');
|
|
const exec = require('child_process').execFile;
|
|
const fs = require('fs');
|
|
|
|
const tmpdir = require('../common/tmpdir');
|
|
tmpdir.refresh();
|
|
const tmpDir = tmpdir.path;
|
|
|
|
// Check that running the symlink executes the target as the correct type
|
|
const symlinks = [
|
|
{
|
|
source: 'extensionless-symlink-to-mjs-file',
|
|
target: fixtures.path('es-modules/mjs-file.mjs'),
|
|
prints: '.mjs file',
|
|
errorsWithPreserveSymlinksMain: false
|
|
}, {
|
|
source: 'extensionless-symlink-to-cjs-file',
|
|
target: fixtures.path('es-modules/cjs-file.cjs'),
|
|
prints: '.cjs file',
|
|
errorsWithPreserveSymlinksMain: false
|
|
}, {
|
|
source: 'extensionless-symlink-to-file-in-module-scope',
|
|
target: fixtures.path('es-modules/package-type-module/index.js'),
|
|
prints: 'package-type-module',
|
|
// The package scope of the symlinks' sources is commonjs, and this
|
|
// symlink's target is a .js file in a module scope, so when the scope
|
|
// is evaluated based on the source (commonjs) this esm file should error
|
|
errorsWithPreserveSymlinksMain: true
|
|
}, {
|
|
source: 'extensionless-symlink-to-file-in-explicit-commonjs-scope',
|
|
target: fixtures.path('es-modules/package-type-commonjs/index.js'),
|
|
prints: 'package-type-commonjs',
|
|
errorsWithPreserveSymlinksMain: false
|
|
}, {
|
|
source: 'extensionless-symlink-to-file-in-implicit-commonjs-scope',
|
|
target: fixtures.path('es-modules/package-without-type/index.js'),
|
|
prints: 'package-without-type',
|
|
errorsWithPreserveSymlinksMain: false
|
|
}
|
|
];
|
|
|
|
symlinks.forEach((symlink) => {
|
|
const mainPath = path.join(tmpDir, symlink.source);
|
|
fs.symlinkSync(symlink.target, mainPath);
|
|
|
|
const flags = [
|
|
'--experimental-modules',
|
|
'--experimental-modules --preserve-symlinks-main'
|
|
];
|
|
flags.forEach((nodeOptions) => {
|
|
const opts = {
|
|
env: Object.assign({}, process.env, { NODE_OPTIONS: nodeOptions })
|
|
};
|
|
exec(process.execPath, [mainPath], opts, common.mustCall(
|
|
(err, stdout) => {
|
|
if (nodeOptions.includes('--preserve-symlinks-main')) {
|
|
if (symlink.errorsWithPreserveSymlinksMain &&
|
|
err.toString().includes('Error')) return;
|
|
else if (!symlink.errorsWithPreserveSymlinksMain &&
|
|
stdout.includes(symlink.prints)) return;
|
|
assert.fail(`For ${JSON.stringify(symlink)}, ${
|
|
(symlink.errorsWithPreserveSymlinksMain) ?
|
|
'failed to error' : 'errored unexpectedly'
|
|
} with --preserve-symlinks-main`);
|
|
} else {
|
|
if (stdout.includes(symlink.prints)) return;
|
|
assert.fail(`For ${JSON.stringify(symlink)}, failed to find ` +
|
|
`${symlink.prints} in: <\n${stdout}\n>`);
|
|
}
|
|
}
|
|
));
|
|
});
|
|
});
|