fix(commonjs): Improve error message for unsupported dynamic requires

rollup · Nov 24, 2020 · 627f801 · 627f801
1 parent 800667b
commit 627f801
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 6 deletions.
diff --git a/packages/commonjs/src/helpers.js b/packages/commonjs/src/helpers.js
@@ -54,8 +54,8 @@ export function createCommonjsModule(fn) {
 	return fn(module, module.exports), module.exports;
 }
 
-export function commonjsRequire () {
-	throw new Error('Dynamic requires are not currently supported by @rollup/plugin-commonjs');
+export function commonjsRequire (target) {
+	throw new Error('Could not dynamically require "' + target + '". Please configure the dynamicRequireTargets option of @rollup/plugin-commonjs appropriately for this require call to behave properly.');
 }
 `;
 

diff --git a/packages/commonjs/test/fixtures/function/unsupported-dynamic-require/_config.js b/packages/commonjs/test/fixtures/function/unsupported-dynamic-require/_config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  description: 'throws for unsupported dynamic require calls'
+};
diff --git a/packages/commonjs/test/fixtures/function/unsupported-dynamic-require/main.js b/packages/commonjs/test/fixtures/function/unsupported-dynamic-require/main.js
@@ -0,0 +1,8 @@
+t.throws(() => require(getRequireTarget()), {
+  message:
+    'Could not dynamically require "foo-bar". Please configure the dynamicRequireTargets option of @rollup/plugin-commonjs appropriately for this require call to behave properly.'
+});
+
+function getRequireTarget() {
+  return 'foo-bar';
+}
diff --git a/packages/commonjs/test/snapshots/function.js.md b/packages/commonjs/test/snapshots/function.js.md
@@ -5477,8 +5477,8 @@ Generated by [AVA](https://avajs.dev).
       	return fn(module, module.exports), module.exports;␊
       }␊
       ␊
-      function commonjsRequire () {␊
-      	throw new Error('Dynamic requires are not currently supported by @rollup/plugin-commonjs');␊
+      function commonjsRequire (target) {␊
+      	throw new Error('Could not dynamically require "' + target + '". Please configure the dynamicRequireTargets option of @rollup/plugin-commonjs appropriately for this require call to behave properly.');␊
       }␊
       ␊
       var foo = createCommonjsModule(function (module) {␊
@@ -5505,8 +5505,8 @@ Generated by [AVA](https://avajs.dev).
       	return fn(module, module.exports), module.exports;␊
       }␊
       ␊
-      function commonjsRequire () {␊
-      	throw new Error('Dynamic requires are not currently supported by @rollup/plugin-commonjs');␊
+      function commonjsRequire (target) {␊
+      	throw new Error('Could not dynamically require "' + target + '". Please configure the dynamicRequireTargets option of @rollup/plugin-commonjs appropriately for this require call to behave properly.');␊
       }␊
       ␊
       var foo = createCommonjsModule(function (module) {␊
@@ -5543,3 +5543,31 @@ Generated by [AVA](https://avajs.dev).
       module.exports = main;␊
       `,
     }
+
+## unsupported-dynamic-require
+
+> Snapshot 1
+
+    {
+      'main.js': `'use strict';␊
+      ␊
+      function commonjsRequire (target) {␊
+      	throw new Error('Could not dynamically require "' + target + '". Please configure the dynamicRequireTargets option of @rollup/plugin-commonjs appropriately for this require call to behave properly.');␊
+      }␊
+      ␊
+      t.throws(() => commonjsRequire(getRequireTarget()), {␊
+        message:␊
+          'Could not dynamically require "foo-bar". Please configure the dynamicRequireTargets option of @rollup/plugin-commonjs appropriately for this require call to behave properly.'␊
+      });␊
+      ␊
+      function getRequireTarget() {␊
+        return 'foo-bar';␊
+      }␊
+      ␊
+      var main = {␊
+      ␊
+      };␊
+      ␊
+      module.exports = main;␊
+      `,
+    }
diff --git a/packages/commonjs/test/snapshots/function.js.snap b/packages/commonjs/test/snapshots/function.js.snap