diff options
author | Guy Bedford <guybedford@gmail.com> | 2019-10-09 17:21:31 -0400 |
---|---|---|
committer | Guy Bedford <guybedford@gmail.com> | 2019-10-11 17:37:46 -0400 |
commit | aca1c283bd8c6778b477286b8516f7c38dc9cefb (patch) | |
tree | 8b63435cde4623163602b9872d1d1acd9e62e071 | |
parent | 7812a615ab3cf992e1f4c5b63a2e5cddcf1fedf6 (diff) | |
download | android-node-v8-aca1c283bd8c6778b477286b8516f7c38dc9cefb.tar.gz android-node-v8-aca1c283bd8c6778b477286b8516f7c38dc9cefb.tar.bz2 android-node-v8-aca1c283bd8c6778b477286b8516f7c38dc9cefb.zip |
module: warn on require of .js inside type: module
PR-URL: https://github.com/nodejs/node/pull/29909
Reviewed-By: Jan Krems <jan.krems@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
-rw-r--r-- | lib/internal/modules/cjs/loader.js | 32 | ||||
-rw-r--r-- | test/es-module/test-cjs-esm-warn.js | 38 | ||||
-rw-r--r-- | test/fixtures/es-modules/cjs-esm.js | 1 | ||||
-rw-r--r-- | test/fixtures/es-modules/package-type-module/cjs.js | 1 |
4 files changed, 67 insertions, 5 deletions
diff --git a/lib/internal/modules/cjs/loader.js b/lib/internal/modules/cjs/loader.js index 3580614481..d7e240fbea 100644 --- a/lib/internal/modules/cjs/loader.js +++ b/lib/internal/modules/cjs/loader.js @@ -259,7 +259,10 @@ function readPackageScope(checkPath) { if (checkPath.endsWith(path.sep + 'node_modules')) return false; const pjson = readPackage(checkPath); - if (pjson) return pjson; + if (pjson) return { + path: checkPath, + data: pjson + }; } return false; } @@ -959,13 +962,32 @@ Module.prototype._compile = function(content, filename) { return result; }; - // Native extension for .js +let warnRequireESM = true; Module._extensions['.js'] = function(module, filename) { - if (experimentalModules && filename.endsWith('.js')) { + if (filename.endsWith('.js')) { const pkg = readPackageScope(filename); - if (pkg && pkg.type === 'module') { - throw new ERR_REQUIRE_ESM(filename); + if (pkg && pkg.data && pkg.data.type === 'module') { + if (warnRequireESM) { + const parentPath = module.parent && module.parent.filename; + const basename = parentPath && + path.basename(filename) === path.basename(parentPath) ? + filename : path.basename(filename); + process.emitWarning( + 'require() of ES modules is not supported.\nrequire() of ' + + `${filename} ${parentPath ? `from ${module.parent.filename} ` : ''}` + + 'is an ES module file as it is a .js file whose nearest parent ' + + 'package.json contains "type": "module" which defines all .js ' + + 'files in that package scope as ES modules.\nInstead rename ' + + `${basename} to end in .cjs, change the requiring code to use ` + + 'import(), or remove "type": "module" from ' + + `${path.resolve(pkg.path, 'package.json')}.` + ); + warnRequireESM = false; + } + if (experimentalModules) { + throw new ERR_REQUIRE_ESM(filename); + } } } const content = fs.readFileSync(filename, 'utf8'); diff --git a/test/es-module/test-cjs-esm-warn.js b/test/es-module/test-cjs-esm-warn.js new file mode 100644 index 0000000000..ec368c73e2 --- /dev/null +++ b/test/es-module/test-cjs-esm-warn.js @@ -0,0 +1,38 @@ +'use strict'; + +const common = require('../common'); +const fixtures = require('../common/fixtures'); +const { spawn } = require('child_process'); +const assert = require('assert'); +const path = require('path'); + +const requiring = path.resolve(fixtures.path('/es-modules/cjs-esm.js')); +const required = path.resolve( + fixtures.path('/es-modules/package-type-module/cjs.js') +); +const pjson = path.resolve( + fixtures.path('/es-modules/package-type-module/package.json') +); + +const basename = 'cjs.js'; + +const child = spawn(process.execPath, [requiring]); +let stderr = ''; +child.stderr.setEncoding('utf8'); +child.stderr.on('data', (data) => { + stderr += data; +}); +child.on('close', common.mustCall((code, signal) => { + assert.strictEqual(code, 0); + assert.strictEqual(signal, null); + + assert.strictEqual(stderr, `(node:${child.pid}) Warning: ` + + 'require() of ES modules is not supported.\nrequire() of ' + + `${required} from ${requiring} ` + + 'is an ES module file as it is a .js file whose nearest parent ' + + 'package.json contains "type": "module" which defines all .js ' + + 'files in that package scope as ES modules.\nInstead rename ' + + `${basename} to end in .cjs, change the requiring code to use ` + + 'import(), or remove "type": "module" from ' + + `${pjson}.\n`); +})); diff --git a/test/fixtures/es-modules/cjs-esm.js b/test/fixtures/es-modules/cjs-esm.js new file mode 100644 index 0000000000..3599178996 --- /dev/null +++ b/test/fixtures/es-modules/cjs-esm.js @@ -0,0 +1 @@ +require('./package-type-module/cjs.js'); diff --git a/test/fixtures/es-modules/package-type-module/cjs.js b/test/fixtures/es-modules/package-type-module/cjs.js new file mode 100644 index 0000000000..683f2d8ba6 --- /dev/null +++ b/test/fixtures/es-modules/package-type-module/cjs.js @@ -0,0 +1 @@ +module.exports = 'asdf'; |