mirror of
https://github.com/nodejs/node.git
synced 2025-05-08 11:08:24 +00:00

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>
113 lines
3.1 KiB
JavaScript
113 lines
3.1 KiB
JavaScript
'use strict';
|
|
|
|
const internalFS = require('internal/fs/utils');
|
|
const { NativeModule } = require('internal/bootstrap/loaders');
|
|
const { extname } = require('path');
|
|
const { realpathSync } = require('fs');
|
|
const { getOptionValue } = require('internal/options');
|
|
|
|
const preserveSymlinks = getOptionValue('--preserve-symlinks');
|
|
const preserveSymlinksMain = getOptionValue('--preserve-symlinks-main');
|
|
const experimentalJsonModules = getOptionValue('--experimental-json-modules');
|
|
const typeFlag = getOptionValue('--entry-type');
|
|
|
|
const { resolve: moduleWrapResolve,
|
|
getPackageType } = internalBinding('module_wrap');
|
|
const { pathToFileURL, fileURLToPath } = require('internal/url');
|
|
const { ERR_ENTRY_TYPE_MISMATCH,
|
|
ERR_UNKNOWN_FILE_EXTENSION } = require('internal/errors').codes;
|
|
|
|
const realpathCache = new Map();
|
|
|
|
// const TYPE_NONE = 0;
|
|
const TYPE_COMMONJS = 1;
|
|
const TYPE_MODULE = 2;
|
|
|
|
const extensionFormatMap = {
|
|
'__proto__': null,
|
|
'.cjs': 'commonjs',
|
|
'.js': 'module',
|
|
'.mjs': 'module'
|
|
};
|
|
|
|
const legacyExtensionFormatMap = {
|
|
'__proto__': null,
|
|
'.cjs': 'commonjs',
|
|
'.js': 'commonjs',
|
|
'.json': 'commonjs',
|
|
'.mjs': 'module',
|
|
'.node': 'commonjs'
|
|
};
|
|
|
|
if (experimentalJsonModules) {
|
|
// This is a total hack
|
|
Object.assign(extensionFormatMap, {
|
|
'.json': 'json'
|
|
});
|
|
Object.assign(legacyExtensionFormatMap, {
|
|
'.json': 'json'
|
|
});
|
|
}
|
|
|
|
function resolve(specifier, parentURL) {
|
|
if (NativeModule.canBeRequiredByUsers(specifier)) {
|
|
return {
|
|
url: specifier,
|
|
format: 'builtin'
|
|
};
|
|
}
|
|
|
|
const isMain = parentURL === undefined;
|
|
if (isMain)
|
|
parentURL = pathToFileURL(`${process.cwd()}/`).href;
|
|
|
|
let url = moduleWrapResolve(specifier, parentURL);
|
|
|
|
if (isMain ? !preserveSymlinksMain : !preserveSymlinks) {
|
|
const real = realpathSync(fileURLToPath(url), {
|
|
[internalFS.realpathCacheKey]: realpathCache
|
|
});
|
|
const old = url;
|
|
url = pathToFileURL(real);
|
|
url.search = old.search;
|
|
url.hash = old.hash;
|
|
}
|
|
|
|
const type = getPackageType(url.href);
|
|
|
|
const ext = extname(url.pathname);
|
|
const extMap =
|
|
type !== TYPE_MODULE ? legacyExtensionFormatMap : extensionFormatMap;
|
|
let format = extMap[ext];
|
|
|
|
if (isMain && typeFlag) {
|
|
// Conflict between explicit extension (.mjs, .cjs) and --entry-type
|
|
if (ext === '.cjs' && typeFlag === 'module' ||
|
|
ext === '.mjs' && typeFlag === 'commonjs') {
|
|
throw new ERR_ENTRY_TYPE_MISMATCH(
|
|
fileURLToPath(url), ext, typeFlag, 'extension');
|
|
}
|
|
|
|
// Conflict between package scope type and --entry-type
|
|
if (ext === '.js') {
|
|
if (type === TYPE_MODULE && typeFlag === 'commonjs' ||
|
|
type === TYPE_COMMONJS && typeFlag === 'module') {
|
|
throw new ERR_ENTRY_TYPE_MISMATCH(
|
|
fileURLToPath(url), ext, typeFlag, 'scope');
|
|
}
|
|
}
|
|
}
|
|
if (!format) {
|
|
if (isMain && typeFlag)
|
|
format = typeFlag;
|
|
else if (isMain)
|
|
format = type === TYPE_MODULE ? 'module' : 'commonjs';
|
|
else
|
|
throw new ERR_UNKNOWN_FILE_EXTENSION(fileURLToPath(url),
|
|
fileURLToPath(parentURL));
|
|
}
|
|
return { url: `${url}`, format };
|
|
}
|
|
|
|
module.exports = resolve;
|