@rollup/plugin-commonjs 17.1.0 → 18.1.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @rollup/plugin-commonjs ChangeLog
 
+## v18.1.0
+
+_2021-05-04_
+
+### Bugfixes
+
+- fix: idempotence issue (#871)
+
+### Features
+
+- feat: Add `defaultIsModuleExports` option to match Node.js behavior (#838)
+
+## v18.0.0
+
+_2021-03-26_
+
+### Breaking Changes
+
+- feat!: Add ignore-dynamic-requires option (#819)
+
+### Bugfixes
+
+- fix: `isRestorableCompiledEsm` should also trigger code transform (#816)
+
 ## v17.1.0
 
 _2021-01-29_

package/README.md

@@ -134,6 +134,25 @@ Due to the conversion of `require` to a static `import` - the call is hoisted to
 - `string[]`: Pass an array containing the IDs to left unconverted.
 - `((id: string) => boolean|'remove')`: Pass a function that control individual IDs.
 
+### `ignoreDynamicRequires`
+
+Type: `boolean`
+Default: false
+
+Some `require` calls cannot be resolved statically to be translated to imports, e.g.
+
+```js
+function wrappedRequire(target) {
+  return require(target);
+}
+wrappedRequire('foo');
+wrappedRequire('bar');
+```
+
+When this option is set to `false`, the generated code will either directly throw an error when such a call is encountered or, when `dynamicRequireTargets` is used, when such a call cannot be resolved with a configured dynamic require target.
+
+Setting this option to `true` will instead leave the `require` call in the code or use it as a fallback for `dynamicRequireTargets`.
+
 ### `esmExternals`
 
 Type: `boolean | string[] | ((id: string) => boolean)`
@@ -155,6 +174,49 @@ If you set `esmExternals` to `true`, this plugins assumes that all external depe
 
 You can also supply an array of ids to be treated as ES modules, or a function that will be passed each external id to determine if it is an ES module.
 
+### `defaultIsModuleExports`
+
+Type: `boolean | "auto"`<br>
+Default: `"auto"`
+
+Controls what is the default export when importing a CommonJS file from an ES module.
+
+- `true`: The value of the default export is `module.exports`. This currently matches the behavior of Node.js when importing a CommonJS file.
+  ```js
+  // mod.cjs
+  exports.default = 3;
+  ```
+  ```js
+  import foo from './mod.cjs';
+  console.log(foo); // { default: 3 }
+  ```
+- `false`: The value of the default export is `exports.default`.
+  ```js
+  // mod.cjs
+  exports.default = 3;
+  ```
+  ```js
+  import foo from './mod.cjs';
+  console.log(foo); // 3
+  ```
+- `"auto"`: The value of the default export is `exports.default` if the CommonJS file has an `exports.__esModule === true` property; otherwise it's `module.exports`. This makes it possible to import
+  the default export of ES modules compiled to CommonJS as if they were not compiled.
+  ```js
+  // mod.cjs
+  exports.default = 3;
+  ```
+  ```js
+  // mod-compiled.cjs
+  exports.__esModule = true;
+  exports.default = 3;
+  ```
+  ```js
+  import foo from './mod.cjs';
+  import bar from './mod-compiled.cjs';
+  console.log(foo); // { default: 3 }
+  console.log(bar); // 3
+  ```
+
 ### `requireReturnsDefault`
 
 Type: `boolean | "namespace" | "auto" | "preferred" | ((id: string) => boolean | "auto" | "preferred")`<br>

package/dist/index.es.js

@@ -126,18 +126,20 @@ export function getAugmentedNamespace(n) {
 }
 `;
 
+const FAILED_REQUIRE_ERROR = `throw new Error('Could not dynamically require "' + path + '". Please configure the dynamicRequireTargets or/and ignoreDynamicRequires option of @rollup/plugin-commonjs appropriately for this require call to work.');`;
+
 const HELPER_NON_DYNAMIC = `
 export function createCommonjsModule(fn) {
   var module = { exports: {} }
 	return fn(module, module.exports), module.exports;
 }
 
-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.');
+export function commonjsRequire (path) {
+	${FAILED_REQUIRE_ERROR}
 }
 `;
 
-const HELPERS_DYNAMIC = `
+const getDynamicHelpers = (ignoreDynamicRequires) => `
 export function createCommonjsModule(fn, basedir, module) {
 	return module = {
 		path: basedir,
@@ -309,15 +311,17 @@ export function commonjsRequire (path, originalModuleDir) {
       return cachedModule.exports;
     };
 	}
-	return require(path);
+	${ignoreDynamicRequires ? 'return require(path);' : FAILED_REQUIRE_ERROR}
 }
 
 commonjsRequire.cache = DYNAMIC_REQUIRE_CACHE;
 commonjsRequire.resolve = commonjsResolve;
 `;
 
-function getHelpersModule(isDynamicRequireModulesEnabled) {
-  return `${HELPERS}${isDynamicRequireModulesEnabled ? HELPERS_DYNAMIC : HELPER_NON_DYNAMIC}`;
+function getHelpersModule(isDynamicRequireModulesEnabled, ignoreDynamicRequires) {
+  return `${HELPERS}${
+    isDynamicRequireModulesEnabled ? getDynamicHelpers(ignoreDynamicRequires) : HELPER_NON_DYNAMIC
+  }`;
 }
 
 /* eslint-disable import/prefer-default-export */
@@ -447,9 +451,7 @@ function getDynamicRequirePaths(patterns) {
   return { dynamicRequireModuleSet, dynamicRequireModuleDirPaths };
 }
 
-const isCjsPromises = new Map();
-
-function getIsCjsPromise(id) {
+function getIsCjsPromise(isCjsPromises, id) {
   let isCjsPromise = isCjsPromises.get(id);
   if (isCjsPromise) return isCjsPromise.promise;
 
@@ -465,7 +467,7 @@ function getIsCjsPromise(id) {
   return promise;
 }
 
-function setIsCjsPromise(id, resolution) {
+function setIsCjsPromise(isCjsPromises, id, resolution) {
   const isCjsPromise = isCjsPromises.get(id);
   if (isCjsPromise) {
     if (isCjsPromise.resolve) {
@@ -519,10 +521,11 @@ async function getStaticRequireProxy(
   id,
   requireReturnsDefault,
   esModulesWithDefaultExport,
-  esModulesWithNamedExports
+  esModulesWithNamedExports,
+  isCjsPromises
 ) {
   const name = getName(id);
-  const isCjs = await getIsCjsPromise(id);
+  const isCjs = await getIsCjsPromise(isCjsPromises, id);
   if (isCjs) {
     return `import { __moduleExports } from ${JSON.stringify(id)}; export default __moduleExports;`;
   } else if (isCjs === null) {
@@ -796,7 +799,8 @@ function rewriteExportsAndGetExportsBlock(
   isRestorableCompiledEsm,
   code,
   uses,
-  HELPERS_NAME
+  HELPERS_NAME,
+  defaultIsModuleExports
 ) {
   const namedExportDeclarations = [`export { ${moduleName} as __moduleExports };`];
   const moduleExportsPropertyAssignments = [];
@@ -851,19 +855,29 @@ function rewriteExportsAndGetExportsBlock(
 
   // Generate default export
   const defaultExport = [];
-  if (isRestorableCompiledEsm) {
-    defaultExport.push(`export default ${deconflictedDefaultExportName || moduleName};`);
-  } else if (
-    (wrapped || deconflictedDefaultExportName) &&
-    (defineCompiledEsmExpressions.length > 0 || code.indexOf('__esModule') >= 0)
-  ) {
-    // eslint-disable-next-line no-param-reassign
-    uses.commonjsHelpers = true;
-    defaultExport.push(
-      `export default /*@__PURE__*/${HELPERS_NAME}.getDefaultExportFromCjs(${moduleName});`
-    );
-  } else {
+  if (defaultIsModuleExports === 'auto') {
+    if (isRestorableCompiledEsm) {
+      defaultExport.push(`export default ${deconflictedDefaultExportName || moduleName};`);
+    } else if (
+      (wrapped || deconflictedDefaultExportName) &&
+      (defineCompiledEsmExpressions.length > 0 || code.includes('__esModule'))
+    ) {
+      // eslint-disable-next-line no-param-reassign
+      uses.commonjsHelpers = true;
+      defaultExport.push(
+        `export default /*@__PURE__*/${HELPERS_NAME}.getDefaultExportFromCjs(${moduleName});`
+      );
+    } else {
+      defaultExport.push(`export default ${moduleName};`);
+    }
+  } else if (defaultIsModuleExports === true) {
     defaultExport.push(`export default ${moduleName};`);
+  } else if (defaultIsModuleExports === false) {
+    if (deconflictedDefaultExportName) {
+      defaultExport.push(`export default ${deconflictedDefaultExportName};`);
+    } else {
+      defaultExport.push(`export default ${moduleName}.default;`);
+    }
   }
 
   return `\n\n${defaultExport
@@ -1111,13 +1125,15 @@ function transformCommonjs(
   isEsModule,
   ignoreGlobal,
   ignoreRequire,
+  ignoreDynamicRequires,
   getIgnoreTryCatchRequireStatementMode,
   sourceMap,
   isDynamicRequireModulesEnabled,
   dynamicRequireModuleSet,
   disableWrap,
   commonDir,
-  astCache
+  astCache,
+  defaultIsModuleExports
 ) {
   const ast = astCache || tryParse(parse, code, id);
   const magicString = new MagicString(code);
@@ -1385,12 +1401,14 @@ function transformCommonjs(
                   )}`
                 );
               }
-              if (isShorthandProperty(parent)) {
-                magicString.appendRight(node.end, `: ${HELPERS_NAME}.commonjsRequire`);
-              } else {
-                magicString.overwrite(node.start, node.end, `${HELPERS_NAME}.commonjsRequire`, {
-                  storeName: true
-                });
+              if (!ignoreDynamicRequires) {
+                if (isShorthandProperty(parent)) {
+                  magicString.appendRight(node.end, `: ${HELPERS_NAME}.commonjsRequire`);
+                } else {
+                  magicString.overwrite(node.start, node.end, `${HELPERS_NAME}.commonjsRequire`, {
+                    storeName: true
+                  });
+                }
               }
 
               uses.commonjsHelpers = true;
@@ -1502,7 +1520,8 @@ function transformCommonjs(
       uses.exports ||
       uses.require ||
       uses.commonjsHelpers ||
-      hasRemovedRequire
+      hasRemovedRequire ||
+      isRestorableCompiledEsm
     ) &&
     (ignoreGlobal || !uses.global)
   ) {
@@ -1531,7 +1550,8 @@ function transformCommonjs(
         isRestorableCompiledEsm,
         code,
         uses,
-        HELPERS_NAME
+        HELPERS_NAME,
+        defaultIsModuleExports
       );
 
   const importBlock = rewriteRequireExpressionsAndGetImportBlock(
@@ -1565,6 +1585,7 @@ function commonjs(options = {}) {
   const filter = createFilter(options.include, options.exclude);
   const {
     ignoreGlobal,
+    ignoreDynamicRequires,
     requireReturnsDefault: requireReturnsDefaultOption,
     esmExternals
   } = options;
@@ -1579,6 +1600,8 @@ function commonjs(options = {}) {
       : Array.isArray(esmExternals)
       ? ((esmExternalIds = new Set(esmExternals)), (id) => esmExternalIds.has(id))
       : () => esmExternals;
+  const defaultIsModuleExports =
+    typeof options.defaultIsModuleExports === 'boolean' ? options.defaultIsModuleExports : 'auto';
 
   const { dynamicRequireModuleSet, dynamicRequireModuleDirPaths } = getDynamicRequirePaths(
     options.dynamicRequireTargets
@@ -1590,6 +1613,7 @@ function commonjs(options = {}) {
 
   const esModulesWithDefaultExport = new Set();
   const esModulesWithNamedExports = new Set();
+  const isCjsPromises = new Map();
 
   const ignoreRequire =
     typeof options.ignore === 'function'
@@ -1618,6 +1642,7 @@ function commonjs(options = {}) {
 
   function transformAndCheckExports(code, id) {
     if (isDynamicRequireModulesEnabled && this.getModuleInfo(id).isEntry) {
+      // eslint-disable-next-line no-param-reassign
       code =
         getDynamicPackagesEntryIntro(dynamicRequireModuleDirPaths, dynamicRequireModuleSet) + code;
     }
@@ -1646,6 +1671,7 @@ function commonjs(options = {}) {
     // avoid wrapping in createCommonjsModule, as this is a commonjsRegister call
     if (isModuleRegisterProxy(id)) {
       disableWrap = true;
+      // eslint-disable-next-line no-param-reassign
       id = unwrapModuleRegisterProxy(id);
     }
 
@@ -1656,13 +1682,15 @@ function commonjs(options = {}) {
       isEsModule,
       ignoreGlobal || isEsModule,
       ignoreRequire,
+      ignoreDynamicRequires && !isDynamicRequireModulesEnabled,
       getIgnoreTryCatchRequireStatementMode,
       sourceMap,
       isDynamicRequireModulesEnabled,
       dynamicRequireModuleSet,
       disableWrap,
       commonDir,
-      ast
+      ast,
+      defaultIsModuleExports
     );
   }
 
@@ -1682,7 +1710,7 @@ function commonjs(options = {}) {
 
     load(id) {
       if (id === HELPERS_ID) {
-        return getHelpersModule(isDynamicRequireModulesEnabled);
+        return getHelpersModule(isDynamicRequireModulesEnabled, ignoreDynamicRequires);
       }
 
       if (id.startsWith(HELPERS_ID)) {
@@ -1722,7 +1750,8 @@ function commonjs(options = {}) {
           actualId,
           getRequireReturnsDefault(actualId),
           esModulesWithDefaultExport,
-          esModulesWithNamedExports
+          esModulesWithNamedExports,
+          isCjsPromises
         );
       }
 
@@ -1753,15 +1782,16 @@ function commonjs(options = {}) {
       }
     },
 
+    // eslint-disable-next-line no-shadow
     moduleParsed({ id, meta: { commonjs } }) {
       if (commonjs) {
         const isCjs = commonjs.isCommonJS;
         if (isCjs != null) {
-          setIsCjsPromise(id, isCjs);
+          setIsCjsPromise(isCjsPromises, id, isCjs);
           return;
         }
       }
-      setIsCjsPromise(id, null);
+      setIsCjsPromise(isCjsPromises, id, null);
     }
   };
 }