Skip to content

Commit cf52a8b

Browse files
committed
module: do not warn for typeless package.json when there isn't one
It was intended that warnings should only be emitted for an existing package.json without a type. This fixes a confusing warning telling users to update /package.json when there are no package.json on the lookup path at all, like this: [MODULE_TYPELESS_PACKAGE_JSON] Warning: ... parsed as an ES module because module syntax was detected; to avoid the performance penalty of syntax detection, add "type": "module" to /package.json Drive-by: update the warning message to be clear about reparsing and make it clear what's actionable.
1 parent 36e44f1 commit cf52a8b

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

lib/internal/modules/esm/get_format.js

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,9 @@ let typelessPackageJsonFilesWarnedAbout;
9898
function warnTypelessPackageJsonFile(pjsonPath, url) {
9999
typelessPackageJsonFilesWarnedAbout ??= new SafeSet();
100100
if (!typelessPackageJsonFilesWarnedAbout.has(pjsonPath)) {
101-
const warning = `${url} parsed as an ES module because module syntax was detected;` +
102-
` to avoid the performance penalty of syntax detection, add "type": "module" to ${pjsonPath}`;
101+
const warning = `Module type of ${url} is not specified and it doesn't parse as CommonJS.\n` +
102+
'Reparsing as ES module because module syntax was detected. This incurs a performance overhead.\n' +
103+
`To eliminate this warning, add "type": "module" to ${pjsonPath}.`;
103104
process.emitWarning(warning, {
104105
code: 'MODULE_TYPELESS_PACKAGE_JSON',
105106
});
@@ -118,7 +119,7 @@ function getFileProtocolModuleFormat(url, context = { __proto__: null }, ignoreE
118119
const ext = extname(url);
119120

120121
if (ext === '.js') {
121-
const { type: packageType, pjsonPath } = getPackageScopeConfig(url);
122+
const { type: packageType, pjsonPath, exists: foundPackageJson } = getPackageScopeConfig(url);
122123
if (packageType !== 'none') {
123124
return packageType;
124125
}
@@ -139,7 +140,7 @@ function getFileProtocolModuleFormat(url, context = { __proto__: null }, ignoreE
139140
// For ambiguous files (no type field, .js extension) we return
140141
// undefined from `resolve` and re-run the check in `load`.
141142
const format = detectModuleFormat(source, url);
142-
if (format === 'module') {
143+
if (format === 'module' && foundPackageJson) {
143144
// This module has a .js extension, a package.json with no `type` field, and ESM syntax.
144145
// Warn about the missing `type` field so that the user can avoid the performance penalty of detection.
145146
warnTypelessPackageJsonFile(pjsonPath, url);
@@ -149,7 +150,7 @@ function getFileProtocolModuleFormat(url, context = { __proto__: null }, ignoreE
149150
}
150151
}
151152
if (ext === '.ts' && getOptionValue('--experimental-strip-types')) {
152-
const { type: packageType, pjsonPath } = getPackageScopeConfig(url);
153+
const { type: packageType, pjsonPath, exists: foundPackageJson } = getPackageScopeConfig(url);
153154
if (packageType !== 'none') {
154155
return `${packageType}-typescript`;
155156
}
@@ -170,7 +171,7 @@ function getFileProtocolModuleFormat(url, context = { __proto__: null }, ignoreE
170171
const parsedSource = tsParse(source);
171172
const detectedFormat = detectModuleFormat(parsedSource, url);
172173
const format = detectedFormat ? `${detectedFormat}-typescript` : 'commonjs-typescript';
173-
if (format === 'module-typescript') {
174+
if (format === 'module-typescript' && foundPackageJson) {
174175
// This module has a .js extension, a package.json with no `type` field, and ESM syntax.
175176
// Warn about the missing `type` field so that the user can avoid the performance penalty of detection.
176177
warnTypelessPackageJsonFile(pjsonPath, url);

test/es-module/test-esm-detect-ambiguous.mjs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -352,6 +352,18 @@ describe('Module syntax detection', { concurrency: !process.env.TEST_PARALLEL },
352352
});
353353
}
354354

355+
it('does not warn when there are no package.json', async () => {
356+
const { stdout, stderr, code, signal } = await spawnPromisified(process.execPath, [
357+
fixtures.path('es-modules/loose.js'),
358+
]);
359+
360+
strictEqual(stderr, '');
361+
strictEqual(stdout, 'executed\n');
362+
strictEqual(code, 0);
363+
strictEqual(signal, null);
364+
});
365+
366+
355367
it('warns only once for a package.json that affects multiple files', async () => {
356368
const { stdout, stderr, code, signal } = await spawnPromisified(process.execPath, [
357369
fixtures.path('es-modules/package-without-type/detected-as-esm.js'),

0 commit comments

Comments
 (0)