@rollup/plugin-commonjs 18.0.0 → 18.1.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @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_

package/README.md

@@ -174,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

@@ -451,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;
 
@@ -469,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) {
@@ -523,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) {
@@ -800,7 +799,8 @@ function rewriteExportsAndGetExportsBlock(
   isRestorableCompiledEsm,
   code,
   uses,
-  HELPERS_NAME
+  HELPERS_NAME,
+  defaultIsModuleExports
 ) {
   const namedExportDeclarations = [`export { ${moduleName} as __moduleExports };`];
   const moduleExportsPropertyAssignments = [];
@@ -855,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
@@ -1122,7 +1132,8 @@ function transformCommonjs(
   dynamicRequireModuleSet,
   disableWrap,
   commonDir,
-  astCache
+  astCache,
+  defaultIsModuleExports
 ) {
   const ast = astCache || tryParse(parse, code, id);
   const magicString = new MagicString(code);
@@ -1539,7 +1550,8 @@ function transformCommonjs(
         isRestorableCompiledEsm,
         code,
         uses,
-        HELPERS_NAME
+        HELPERS_NAME,
+        defaultIsModuleExports
       );
 
   const importBlock = rewriteRequireExpressionsAndGetImportBlock(
@@ -1588,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
@@ -1599,6 +1613,7 @@ function commonjs(options = {}) {
 
   const esModulesWithDefaultExport = new Set();
   const esModulesWithNamedExports = new Set();
+  const isCjsPromises = new Map();
 
   const ignoreRequire =
     typeof options.ignore === 'function'
@@ -1674,7 +1689,8 @@ function commonjs(options = {}) {
       dynamicRequireModuleSet,
       disableWrap,
       commonDir,
-      ast
+      ast,
+      defaultIsModuleExports
     );
   }
 
@@ -1734,7 +1750,8 @@ function commonjs(options = {}) {
           actualId,
           getRequireReturnsDefault(actualId),
           esModulesWithDefaultExport,
-          esModulesWithNamedExports
+          esModulesWithNamedExports,
+          isCjsPromises
         );
       }
 
@@ -1770,11 +1787,11 @@ function commonjs(options = {}) {
       if (commonjs) {
         const isCjs = commonjs.isCommonJS;
         if (isCjs != null) {
-          setIsCjsPromise(id, isCjs);
+          setIsCjsPromise(isCjsPromises, id, isCjs);
           return;
         }
       }
-      setIsCjsPromise(id, null);
+      setIsCjsPromise(isCjsPromises, id, null);
     }
   };
 }