@rollup/plugin-commonjs 18.0.0-0 → 19.0.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @rollup/plugin-commonjs ChangeLog
 
+## v19.0.0
+
+_2021-05-07_
+
+### Breaking Changes
+
+- feat!: Add support for circular dependencies (#658)
+
+## 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/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 RollupJS Plugin Contributors (https://github.com/rollup/plugins/graphs/contributors)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

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

@@ -9,7 +9,7 @@ import isReference from 'is-reference';
 import { sync } from 'resolve';
 
 var peerDependencies = {
-	rollup: "^2.38.0"
+	rollup: "^2.38.3"
 };
 
 function tryParse(parse, code, id) {
@@ -128,13 +128,15 @@ 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 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 createModule(modulePath) {
 	return {
 		path: modulePath,
@@ -306,34 +308,22 @@ 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 */
 
-function deconflict(scope, globals, identifier) {
-  let i = 1;
-  let deconflicted = makeLegalIdentifier(identifier);
-
-  while (scope.contains(deconflicted) || globals.has(deconflicted)) {
-    deconflicted = makeLegalIdentifier(`${identifier}_${i}`);
-    i += 1;
-  }
-  // eslint-disable-next-line no-param-reassign
-  scope.declarations[deconflicted] = true;
-
-  return deconflicted;
-}
-
-function deconflictScopes(scopes, globals, identifier) {
+function deconflict(scopes, globals, identifier) {
   let i = 1;
   let deconflicted = makeLegalIdentifier(identifier);
   const hasConflicts = () =>
@@ -452,9 +442,7 @@ function getDynamicRequirePaths(patterns) {
   return { dynamicRequireModuleSet, dynamicRequireModuleDirPaths };
 }
 
-const commonJSMetaPromises = new Map();
-
-function getCommonJSMetaPromise(id) {
+function getCommonJSMetaPromise(commonJSMetaPromises, id) {
   let commonJSMetaPromise = commonJSMetaPromises.get(id);
   if (commonJSMetaPromise) return commonJSMetaPromise.promise;
 
@@ -470,7 +458,7 @@ function getCommonJSMetaPromise(id) {
   return promise;
 }
 
-function setCommonJSMetaPromise(id, commonjsMeta) {
+function setCommonJSMetaPromise(commonJSMetaPromises, id, commonjsMeta) {
   const commonJSMetaPromise = commonJSMetaPromises.get(id);
   if (commonJSMetaPromise) {
     if (commonJSMetaPromise.resolve) {
@@ -524,10 +512,11 @@ async function getStaticRequireProxy(
   id,
   requireReturnsDefault,
   esModulesWithDefaultExport,
-  esModulesWithNamedExports
+  esModulesWithNamedExports,
+  commonJsMetaPromises
 ) {
   const name = getName(id);
-  const commonjsMeta = await getCommonJSMetaPromise(id);
+  const commonjsMeta = await getCommonJSMetaPromise(commonJsMetaPromises, id);
   if (commonjsMeta && commonjsMeta.isCommonJS) {
     return `export { __moduleExports as default } from ${JSON.stringify(id)};`;
   } else if (commonjsMeta === null) {
@@ -768,17 +757,6 @@ function getDefinePropertyCallName(node, targetName) {
   return { key: key.value, value: valueProperty.value };
 }
 
-function isLocallyShadowed(name, scope) {
-  while (scope.parent) {
-    if (scope.declarations[name]) {
-      return true;
-    }
-    // eslint-disable-next-line no-param-reassign
-    scope = scope.parent;
-  }
-  return false;
-}
-
 function isShorthandProperty(parent) {
   return parent && parent.type === 'Property' && parent.shorthand;
 }
@@ -814,7 +792,8 @@ function rewriteExportsAndGetExportsBlock(
   code,
   HELPERS_NAME,
   exportMode,
-  detectWrappedDefault
+  detectWrappedDefault,
+  defaultIsModuleExports
 ) {
   const exports = [];
   const exportDeclarations = [];
@@ -823,6 +802,7 @@ function rewriteExportsAndGetExportsBlock(
     getExportsForReplacedModuleExports(
       magicString,
       exports,
+      exportDeclarations,
       moduleExportsAssignments,
       firstTopLevelModuleExportsAssignment,
       exportsName
@@ -831,11 +811,11 @@ function rewriteExportsAndGetExportsBlock(
     exports.push(`${exportsName} as __moduleExports`);
     if (wrapped) {
       getExportsWhenWrapping(
-        exports,
         exportDeclarations,
         exportsName,
         detectWrappedDefault,
-        HELPERS_NAME
+        HELPERS_NAME,
+        defaultIsModuleExports
       );
     } else {
       getExports(
@@ -849,7 +829,8 @@ function rewriteExportsAndGetExportsBlock(
         moduleName,
         exportsName,
         defineCompiledEsmExpressions,
-        HELPERS_NAME
+        HELPERS_NAME,
+        defaultIsModuleExports
       );
     }
   }
@@ -863,6 +844,7 @@ function rewriteExportsAndGetExportsBlock(
 function getExportsForReplacedModuleExports(
   magicString,
   exports,
+  exportDeclarations,
   moduleExportsAssignments,
   firstTopLevelModuleExportsAssignment,
   exportsName
@@ -871,23 +853,26 @@ function getExportsForReplacedModuleExports(
     magicString.overwrite(left.start, left.end, exportsName);
   }
   magicString.prependRight(firstTopLevelModuleExportsAssignment.left.start, 'var ');
-  exports.push(`${exportsName} as __moduleExports`, `${exportsName} as default`);
+  exports.push(`${exportsName} as __moduleExports`);
+  exportDeclarations.push(`export default ${exportsName};`);
 }
 
 function getExportsWhenWrapping(
-  exports,
   exportDeclarations,
   exportsName,
   detectWrappedDefault,
-  HELPERS_NAME
+  HELPERS_NAME,
+  defaultIsModuleExports
 ) {
-  if (detectWrappedDefault) {
-    exportDeclarations.push(
-      `export default /*@__PURE__*/${HELPERS_NAME}.getDefaultExportFromCjs(${exportsName});`
-    );
-  } else {
-    exports.push(`${exportsName} as default`);
-  }
+  exportDeclarations.push(
+    `export default ${
+      detectWrappedDefault && defaultIsModuleExports === 'auto'
+        ? `/*@__PURE__*/${HELPERS_NAME}.getDefaultExportFromCjs(${exportsName})`
+        : defaultIsModuleExports === false
+        ? `${exportsName}.default`
+        : exportsName
+    };`
+  );
 }
 
 function getExports(
@@ -901,7 +886,8 @@ function getExports(
   moduleName,
   exportsName,
   defineCompiledEsmExpressions,
-  HELPERS_NAME
+  HELPERS_NAME,
+  defaultIsModuleExports
 ) {
   let deconflictedDefaultExportName;
   // Collect and rewrite module.exports assignments
@@ -941,16 +927,14 @@ function getExports(
     magicString.overwrite(moduleExportsExpression.start, moduleExportsExpression.end, exportsName);
   }
 
-  if (isRestorableCompiledEsm) {
-    if (moduleExportsAssignments.length === 0) {
-      exports.push(`${deconflictedDefaultExportName || exportsName} as default`);
-    } else {
-      exportDeclarations.push(
-        `export default /*@__PURE__*/${HELPERS_NAME}.getDefaultExportFromCjs(${exportsName});`
-      );
-    }
+  if (!isRestorableCompiledEsm || defaultIsModuleExports === true) {
+    exportDeclarations.push(`export default ${exportsName};`);
+  } else if (moduleExportsAssignments.length === 0 || defaultIsModuleExports === false) {
+    exports.push(`${deconflictedDefaultExportName || exportsName} as default`);
   } else {
-    exports.push(`${exportsName} as default`);
+    exportDeclarations.push(
+      `export default /*@__PURE__*/${HELPERS_NAME}.getDefaultExportFromCjs(${exportsName});`
+    );
   }
 }
 
@@ -1076,17 +1060,11 @@ function getRequireHandlers() {
     id,
     exportMode
   ) {
-    const removedDeclarators = getDeclaratorsReplacedByImportsAndSetImportNames(
-      topLevelRequireDeclarators,
-      requiredByNode,
-      reassignedNames
-    );
     setRemainingImportNamesAndRewriteRequires(
       requireExpressionsWithUsedReturnValue,
       requiredByNode,
       magicString
     );
-    removeDeclaratorsFromDeclarations(topLevelDeclarations, removedDeclarators, magicString);
     const imports = [];
     imports.push(`import * as ${helpersName} from "${HELPERS_ID}";`);
     if (exportMode === 'module') {
@@ -1124,30 +1102,6 @@ function getRequireHandlers() {
   };
 }
 
-function getDeclaratorsReplacedByImportsAndSetImportNames(
-  topLevelRequireDeclarators,
-  requiredByNode,
-  reassignedNames
-) {
-  const removedDeclarators = new Set();
-  for (const declarator of topLevelRequireDeclarators) {
-    const { required } = requiredByNode.get(declarator.init);
-    if (!required.name) {
-      const potentialName = declarator.id.name;
-      if (
-        !reassignedNames.has(potentialName) &&
-        !required.nodesUsingRequired.some((node) =>
-          isLocallyShadowed(potentialName, requiredByNode.get(node).scope)
-        )
-      ) {
-        required.name = potentialName;
-        removedDeclarators.add(declarator);
-      }
-    }
-  }
-  return removedDeclarators;
-}
-
 function setRemainingImportNamesAndRewriteRequires(
   requireExpressionsWithUsedReturnValue,
   requiredByNode,
@@ -1169,25 +1123,6 @@ function setRemainingImportNamesAndRewriteRequires(
   }
 }
 
-function removeDeclaratorsFromDeclarations(topLevelDeclarations, removedDeclarators, magicString) {
-  for (const declaration of topLevelDeclarations) {
-    let keepDeclaration = false;
-    let [{ start }] = declaration.declarations;
-    for (const declarator of declaration.declarations) {
-      if (removedDeclarators.has(declarator)) {
-        magicString.remove(start, declarator.end);
-      } else if (!keepDeclaration) {
-        magicString.remove(start, declarator.start);
-        keepDeclaration = true;
-      }
-      start = declarator.end;
-    }
-    if (!keepDeclaration) {
-      magicString.remove(declaration.start, declaration.end);
-    }
-  }
-}
-
 /* eslint-disable no-param-reassign, no-shadow, no-underscore-dangle, no-continue */
 
 const exportsPattern = /^(?:module\.)?exports(?:\.([a-zA-Z_$][a-zA-Z_$0-9]*))?$/;
@@ -1201,13 +1136,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);
@@ -1229,7 +1166,7 @@ function transformCommonjs(
   const globals = new Set();
 
   // TODO technically wrong since globals isn't populated yet, but ¯\_(ツ)_/¯
-  const HELPERS_NAME = deconflict(scope, globals, 'commonjsHelpers');
+  const HELPERS_NAME = deconflict([scope], globals, 'commonjsHelpers');
   const dynamicRegisterSources = new Set();
   let hasRemovedRequire = false;
 
@@ -1480,12 +1417,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
+                  });
+                }
               }
               usesDynamicRequire = true;
               return;
@@ -1572,11 +1511,11 @@ function transformCommonjs(
   });
 
   const nameBase = getName(id);
-  const exportsName = deconflictScopes([...exportsAccessScopes], globals, nameBase);
-  const moduleName = deconflictScopes([...moduleAccessScopes], globals, `${nameBase}Module`);
+  const exportsName = deconflict([...exportsAccessScopes], globals, nameBase);
+  const moduleName = deconflict([...moduleAccessScopes], globals, `${nameBase}Module`);
   const deconflictedExportNames = Object.create(null);
   for (const [exportName, { scopes }] of exportsAssignmentsByName) {
-    deconflictedExportNames[exportName] = deconflictScopes([...scopes], globals, exportName);
+    deconflictedExportNames[exportName] = deconflict([...scopes], globals, exportName);
   }
 
   // We cannot wrap ES/mixed modules
@@ -1596,7 +1535,8 @@ function transformCommonjs(
       uses.exports ||
       uses.require ||
       usesDynamicRequire ||
-      hasRemovedRequire
+      hasRemovedRequire ||
+      topLevelDefineCompiledEsmExpressions.length > 0
     ) &&
     (ignoreGlobal || !uses.global)
   ) {
@@ -1651,7 +1591,8 @@ function transformCommonjs(
         code,
         HELPERS_NAME,
         exportMode,
-        detectWrappedDefault
+        detectWrappedDefault,
+        defaultIsModuleExports
       );
 
   if (shouldWrap) {
@@ -1676,6 +1617,7 @@ function commonjs(options = {}) {
   const filter = createFilter(options.include, options.exclude);
   const {
     ignoreGlobal,
+    ignoreDynamicRequires,
     requireReturnsDefault: requireReturnsDefaultOption,
     esmExternals
   } = options;
@@ -1690,6 +1632,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
@@ -1701,6 +1645,7 @@ function commonjs(options = {}) {
 
   const esModulesWithDefaultExport = new Set();
   const esModulesWithNamedExports = new Set();
+  const commonJsMetaPromises = new Map();
 
   const ignoreRequire =
     typeof options.ignore === 'function'
@@ -1767,13 +1712,15 @@ function commonjs(options = {}) {
       isEsModule,
       ignoreGlobal || isEsModule,
       ignoreRequire,
+      ignoreDynamicRequires && !isDynamicRequireModulesEnabled,
       getIgnoreTryCatchRequireStatementMode,
       sourceMap,
       isDynamicRequireModulesEnabled,
       dynamicRequireModuleSet,
       disableWrap,
       commonDir,
-      ast
+      ast,
+      defaultIsModuleExports
     );
   }
 
@@ -1793,7 +1740,7 @@ function commonjs(options = {}) {
 
     load(id) {
       if (id === HELPERS_ID) {
-        return getHelpersModule(isDynamicRequireModulesEnabled);
+        return getHelpersModule(isDynamicRequireModulesEnabled, ignoreDynamicRequires);
       }
 
       if (id.startsWith(HELPERS_ID)) {
@@ -1866,7 +1813,8 @@ function commonjs(options = {}) {
           actualId,
           getRequireReturnsDefault(actualId),
           esModulesWithDefaultExport,
-          esModulesWithNamedExports
+          esModulesWithNamedExports,
+          commonJsMetaPromises
         );
       }
 
@@ -1899,10 +1847,10 @@ function commonjs(options = {}) {
 
     moduleParsed({ id, meta: { commonjs: commonjsMeta } }) {
       if (commonjsMeta && commonjsMeta.isCommonJS != null) {
-        setCommonJSMetaPromise(id, commonjsMeta);
+        setCommonJSMetaPromise(commonJsMetaPromises, id, commonjsMeta);
         return;
       }
-      setCommonJSMetaPromise(id, null);
+      setCommonJSMetaPromise(commonJsMetaPromises, id, null);
     }
   };
 }