esm: merge both 'type mismatch' errors into one

Author: GeoffreyBooth

doc/api/errors.md

@@ -2218,22 +2218,16 @@ while trying to read and parse it.
 
 The `--type=...` flag is not compatible with the Node.js REPL.
 
-<a id="ERR_INVALID_TYPE_EXTENSION"></a>
-### ERR_INVALID_TYPE_EXTENSION
+<a id="ERR_TYPE_MISMATCH"></a>
+### ERR_TYPE_MISMATCH
 
 > Stability: 1 - Experimental
 
-Attempted to execute a `.cjs` file with the `--type=module` flag,
-or an `.mjs` file with the `--type=commonjs` flag.
-
-<a id="ERR_INVALID_TYPE_IN_PACKAGE_SCOPE"></a>
-### ERR_INVALID_TYPE_IN_PACKAGE_SCOPE
-
-> Stability: 1 - Experimental
-
-Attempted to execute a `.js` file with the `--type=commonjs` flag where the
-nearest `package.json` contains `"type": "module"`; or a `.js` file with the
-`--type=module` flag where the nearest `package.json` either lacks a `"type"`
+The `--type=commonjs` flag was used to attempt to execute an `.mjs` file or
+a `.js` file where the nearest parent `package.json` contains
+`"type": "module"`; or
+the `--type=module` flag was used to attempt to execute a `.cjs` file or
+a `.js` file where the nearest parent `package.json` either lacks a `"type"`
 field or contains `"type": "commonjs"`.
 
 <a id="ERR_INVALID_TYPE_FLAG"></a>

lib/internal/errors.js

@@ -815,21 +815,9 @@ E('ERR_INVALID_SYNC_FORK_INPUT',
   TypeError);
 E('ERR_INVALID_THIS', 'Value of "this" must be of type %s', TypeError);
 E('ERR_INVALID_TUPLE', '%s must be an iterable %s tuple', TypeError);
-E('ERR_INVALID_TYPE_EXTENSION', (extension, flagValue) => {
-  if (flagValue === 'module')
-    flagValue = 'module or -m';
-  return `${extension} is not supported for --type=${flagValue}`;
-}, TypeError);
 E('ERR_INVALID_TYPE_FLAG',
   'Type flag must be one of "module", "commonjs". Received --type=%s',
   TypeError);
-E('ERR_INVALID_TYPE_IN_PACKAGE_SCOPE', (flagValue, scopeType) => {
-  if (flagValue === 'module')
-    flagValue = 'module or -m';
-  return `Cannot use --type=${flagValue} because nearest parent package.json` +
-  ` includes "type": "${scopeType}"${(scopeType === 'commonjs') ?
-    ' (or lacks the "type" field)' : ''}`;
-}, TypeError);
 E('ERR_INVALID_URI', 'URI malformed', URIError);
 E('ERR_INVALID_URL', 'Invalid URL: %s', TypeError);
 E('ERR_INVALID_URL_SCHEME',
@@ -968,6 +956,16 @@ E('ERR_TRANSFORM_ALREADY_TRANSFORMING',
 E('ERR_TRANSFORM_WITH_LENGTH_0',
   'Calling transform done when writableState.length != 0', Error);
 E('ERR_TTY_INIT_FAILED', 'TTY initialization failed', SystemError);
+E('ERR_TYPE_MISMATCH', (flagValue, extension, scopeType) => {
+  if (flagValue === 'module')
+    flagValue = 'module or -m';
+  if (extension) // Mismatch between --type and file extension
+    return `${extension} is not supported for --type=${flagValue}`;
+  else // Mismatch between --type and package.json "type" field
+    return `Cannot use --type=${flagValue} because nearest parent ` +
+  `package.json includes "type": "${scopeType}"${(scopeType === 'commonjs') ?
+    ' (or lacks the "type" field)' : ''}`;
+}, TypeError);
 E('ERR_UNCAUGHT_EXCEPTION_CAPTURE_ALREADY_SET',
   '`process.setupUncaughtExceptionCapture()` was called while a capture ' +
     'callback was already active',

lib/internal/modules/cjs/loader.js

@@ -51,9 +51,8 @@ const { compileFunction } = internalBinding('contextify');
 
 const {
   ERR_INVALID_ARG_VALUE,
-  ERR_INVALID_TYPE_EXTENSION,
-  ERR_INVALID_TYPE_IN_PACKAGE_SCOPE,
-  ERR_REQUIRE_ESM
+  ERR_REQUIRE_ESM,
+  ERR_TYPE_MISMATCH
 } = require('internal/errors').codes;
 const { validateString } = require('internal/validators');
 
@@ -874,10 +873,10 @@ Module.runMain = function() {
         (!isModule && asyncESM.typeFlag === 'module')) {
       if (ext === '.js') {
         // Conflict between package scope type and --type
-        throw new ERR_INVALID_TYPE_IN_PACKAGE_SCOPE(asyncESM.typeFlag, format);
+        throw new ERR_TYPE_MISMATCH(asyncESM.typeFlag, undefined, format);
       } else {
         // Conflict between explicit extension (.mjs, .cjs) and --type
-        throw new ERR_INVALID_TYPE_EXTENSION(ext, asyncESM.typeFlag);
+        throw new ERR_TYPE_MISMATCH(asyncESM.typeFlag, ext, undefined);
       }
     }
 

test/es-module/test-esm-type-flag-errors.js

@@ -20,19 +20,19 @@ expect('', packageTypeCommonJsMain, 'package-type-commonjs');
 expect('', packageWithoutTypeMain, 'package-without-type');
 
 // Check that running with conflicting --type flags throws errors
-expect('--type=commonjs', mjsFile, 'ERR_INVALID_TYPE_EXTENSION', true);
-expect('--type=module', cjsFile, 'ERR_INVALID_TYPE_EXTENSION', true);
-expect('-m', cjsFile, 'ERR_INVALID_TYPE_EXTENSION', true);
+expect('--type=commonjs', mjsFile, 'ERR_TYPE_MISMATCH', true);
+expect('--type=module', cjsFile, 'ERR_TYPE_MISMATCH', true);
+expect('-m', cjsFile, 'ERR_TYPE_MISMATCH', true);
 expect('--type=commonjs', packageTypeModuleMain,
-       'ERR_INVALID_TYPE_IN_PACKAGE_SCOPE', true);
+       'ERR_TYPE_MISMATCH', true);
 expect('--type=module', packageTypeCommonJsMain,
-       'ERR_INVALID_TYPE_IN_PACKAGE_SCOPE', true);
+       'ERR_TYPE_MISMATCH', true);
 expect('-m', packageTypeCommonJsMain,
-       'ERR_INVALID_TYPE_IN_PACKAGE_SCOPE', true);
+       'ERR_TYPE_MISMATCH', true);
 expect('--type=module', packageWithoutTypeMain,
-       'ERR_INVALID_TYPE_IN_PACKAGE_SCOPE', true);
+       'ERR_TYPE_MISMATCH', true);
 expect('-m', packageWithoutTypeMain,
-       'ERR_INVALID_TYPE_IN_PACKAGE_SCOPE', true);
+       'ERR_TYPE_MISMATCH', true);
 
 function expect(opt = '', inputFile, want, wantsError = false) {
   // TODO: Remove when --experimental-modules is unflagged