module: clarify CJS global-like variables not defined error message

Fixes: #33741
PR-URL: #37852
Reviewed-By: Guy Bedford <guybedford@gmail.com>

Author: aduh95

lib/internal/modules/esm/module_job.js

@@ -4,17 +4,20 @@ const {
  ArrayPrototypeJoin,
  ArrayPrototypeMap,
  ArrayPrototypePush,
+ ArrayPrototypeSome,
  FunctionPrototype,
  ObjectSetPrototypeOf,
  PromiseAll,
  PromiseResolve,
  PromisePrototypeCatch,
  ReflectApply,
+ RegExpPrototypeTest,
  SafeSet,
  StringPrototypeIncludes,
  StringPrototypeMatch,
  StringPrototypeReplace,
  StringPrototypeSplit,
+ StringPrototypeStartsWith,
 }=primordials;
 
 const{ ModuleWrap }=internalBinding('module_wrap');
@@ -27,6 +30,19 @@ const noop = FunctionPrototype;
 
 lethasPausedEntry=false;
 
+constCJSGlobalLike=[
+'require',
+'module',
+'exports',
+'__filename',
+'__dirname',
+];
+constisCommonJSGlobalLikeNotDefinedError=(errorMessage)=>
+ArrayPrototypeSome(
+CJSGlobalLike,
+(globalLike)=>errorMessage===`${globalLike} is not defined`
+);
+
 /* A ModuleJob tracks the loading of a single Module, and the ModuleJobs of
  * its dependencies, over time. */
 classModuleJob{
@@ -149,7 +165,32 @@ class ModuleJob {
 awaitthis.instantiate();
 consttimeout=-1;
 constbreakOnSigint=false;
-awaitthis.module.evaluate(timeout,breakOnSigint);
+try{
+awaitthis.module.evaluate(timeout,breakOnSigint);
+}catch(e){
+if(e?.name==='ReferenceError'&&
+isCommonJSGlobalLikeNotDefinedError(e.message)){
+e.message+=' in ES module scope';
+
+if(StringPrototypeStartsWith(e.message,'require ')){
+e.message+=', you can use import instead';
+}
+
+constpackageConfig=
+StringPrototypeStartsWith(this.module.url,'file://')&&
+RegExpPrototypeTest(/\.js(\?[^#]*)?(#.*)?$/,this.module.url)&&
+require('internal/modules/esm/resolve')
+.getPackageScopeConfig(this.module.url);
+if(packageConfig.type==='module'){
+e.message+=
+'\nThis file is being treated as an ES module because it has a '+
+`'.js' file extension and '${packageConfig.pjsonPath}' contains `+
+'"type": "module". To treat it as a CommonJS script, rename it '+
+'to use the \'.cjs\' file extension.';
+}
+}
+throwe;
+}
 return{module: this.module};
 }
 }

lib/internal/modules/esm/resolve.js

@@ -845,6 +845,7 @@ module.exports = {
 DEFAULT_CONDITIONS,
  defaultResolve,
  encodedSepRegEx,
+ getPackageScopeConfig,
  getPackageType,
  packageExportsResolve,
  packageImportsResolve

test/es-module/test-esm-undefined-cjs-global-like-variables.js

@@ -0,0 +1,42 @@
+'use strict';
+constcommon=require('../common');
+constfixtures=require('../common/fixtures');
+constassert=require('assert');
+const{ pathToFileURL }=require('url');
+
+assert.rejects(
+import('data:text/javascript,require;'),
+/requireisnotdefinedinESmodulescope,youcanuseimportinstead$/
+).then(common.mustCall());
+assert.rejects(
+import('data:text/javascript,exports={};'),
+/exportsisnotdefinedinESmodulescope$/
+).then(common.mustCall());
+
+assert.rejects(
+import('data:text/javascript,require_custom;'),
+/^(?!inESmodulescope)(?!useimportinstead).*$/
+).then(common.mustCall());
+
+constpkgUrl=pathToFileURL(fixtures.path('/es-modules/package-type-module/'));
+assert.rejects(
+import(newURL('./cjs.js',pkgUrl)),
+/usethe'\.cjs'fileextension/
+).then(common.mustCall());
+assert.rejects(
+import(newURL('./cjs.js#target',pkgUrl)),
+/usethe'\.cjs'fileextension/
+).then(common.mustCall());
+assert.rejects(
+import(newURL('./cjs.js?foo=bar',pkgUrl)),
+/usethe'\.cjs'fileextension/
+).then(common.mustCall());
+assert.rejects(
+import(newURL('./cjs.js?foo=bar#target',pkgUrl)),
+/usethe'\.cjs'fileextension/
+).then(common.mustCall());
+
+assert.rejects(
+import('data:text/javascript,require;//.js'),
+/^(?!usethe'\.cjs'fileextension).*$/
+).then(common.mustCall());