@rollup/plugin-commonjs 18.0.0-1 → 19.0.1

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @rollup/plugin-commonjs ChangeLog
 
+## v19.0.1
+
+_2021-07-15_
+
+### Bugfixes
+
+- fix: short-circuit to actual module entry point when using circular ref through a different entry (#888)
+
+## 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

@@ -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,
@@ -149,8 +151,18 @@ export function commonjsRegister (path, loader) {
 	DYNAMIC_REQUIRE_LOADERS[path] = loader;
 }
 
+export function commonjsRegisterOrShort (path, to) {
+	const resolvedPath = commonjsResolveImpl(path, null, true);
+	if (resolvedPath !== null && DYNAMIC_REQUIRE_CACHE[resolvedPath]) {
+	  DYNAMIC_REQUIRE_CACHE[path] = DYNAMIC_REQUIRE_CACHE[resolvedPath];
+	} else {
+	  DYNAMIC_REQUIRE_SHORTS[path] = to;
+	}
+}
+
 const DYNAMIC_REQUIRE_LOADERS = Object.create(null);
 const DYNAMIC_REQUIRE_CACHE = Object.create(null);
+const DYNAMIC_REQUIRE_SHORTS = Object.create(null);
 const DEFAULT_PARENT_MODULE = {
 	id: '<' + 'rollup>', exports: {}, parent: undefined, filename: null, loaded: false, children: [], paths: []
 };
@@ -255,10 +267,13 @@ export function commonjsResolveImpl (path, originalModuleDir, testCache) {
 			const resolvedPath = relPath + CHECKED_EXTENSIONS[extensionIndex];
 			if (DYNAMIC_REQUIRE_CACHE[resolvedPath]) {
 				return resolvedPath;
-			};
+			}
+			if (DYNAMIC_REQUIRE_SHORTS[resolvedPath]) {
+			  return resolvedPath;
+			}
 			if (DYNAMIC_REQUIRE_LOADERS[resolvedPath]) {
 				return resolvedPath;
-			};
+			}
 		}
 		if (!shouldTryNodeModules) break;
 		const nextDir = normalize(originalModuleDir + '/..');
@@ -277,10 +292,17 @@ export function commonjsResolve (path, originalModuleDir) {
 }
 
 export function commonjsRequire (path, originalModuleDir) {
-	const resolvedPath = commonjsResolveImpl(path, originalModuleDir, true);
+	let resolvedPath = commonjsResolveImpl(path, originalModuleDir, true);
 	if (resolvedPath !== null) {
     let cachedModule = DYNAMIC_REQUIRE_CACHE[resolvedPath];
     if (cachedModule) return cachedModule.exports;
+    let shortTo = DYNAMIC_REQUIRE_SHORTS[resolvedPath];
+    if (shortTo) {
+      cachedModule = DYNAMIC_REQUIRE_CACHE[shortTo];
+      if (cachedModule)
+        return cachedModule.exports;
+      resolvedPath = commonjsResolveImpl(shortTo, null, true);
+    }
     const loader = DYNAMIC_REQUIRE_LOADERS[resolvedPath];
     if (loader) {
       DYNAMIC_REQUIRE_CACHE[resolvedPath] = cachedModule = {
@@ -306,15 +328,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 */
@@ -375,15 +399,13 @@ function getPackageEntryPoint(dirPath) {
 }
 
 function getDynamicPackagesModule(dynamicRequireModuleDirPaths, commonDir) {
-  let code = `const commonjsRegister = require('${HELPERS_ID}?commonjsRegister');`;
+  let code = `const commonjsRegisterOrShort = require('${HELPERS_ID}?commonjsRegisterOrShort');`;
   for (const dir of dynamicRequireModuleDirPaths) {
     const entryPoint = getPackageEntryPoint(dir);
 
-    code += `\ncommonjsRegister(${JSON.stringify(
+    code += `\ncommonjsRegisterOrShort(${JSON.stringify(
       getVirtualPathForDynamicRequirePath(dir, commonDir)
-    )}, function (module, exports) {
-  module.exports = require(${JSON.stringify(normalizePathSlashes(join(dir, entryPoint)))});
-});`;
+    )}, ${JSON.stringify(getVirtualPathForDynamicRequirePath(join(dir, entryPoint), commonDir))});`;
   }
   return code;
 }
@@ -438,9 +460,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;
 
@@ -456,7 +476,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) {
@@ -510,10 +530,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) {
@@ -789,7 +810,8 @@ function rewriteExportsAndGetExportsBlock(
   code,
   HELPERS_NAME,
   exportMode,
-  detectWrappedDefault
+  detectWrappedDefault,
+  defaultIsModuleExports
 ) {
   const exports = [];
   const exportDeclarations = [];
@@ -806,7 +828,13 @@ function rewriteExportsAndGetExportsBlock(
   } else {
     exports.push(`${exportsName} as __moduleExports`);
     if (wrapped) {
-      getExportsWhenWrapping(exportDeclarations, exportsName, detectWrappedDefault, HELPERS_NAME);
+      getExportsWhenWrapping(
+        exportDeclarations,
+        exportsName,
+        detectWrappedDefault,
+        HELPERS_NAME,
+        defaultIsModuleExports
+      );
     } else {
       getExports(
         magicString,
@@ -819,7 +847,8 @@ function rewriteExportsAndGetExportsBlock(
         moduleName,
         exportsName,
         defineCompiledEsmExpressions,
-        HELPERS_NAME
+        HELPERS_NAME,
+        defaultIsModuleExports
       );
     }
   }
@@ -850,12 +879,15 @@ function getExportsWhenWrapping(
   exportDeclarations,
   exportsName,
   detectWrappedDefault,
-  HELPERS_NAME
+  HELPERS_NAME,
+  defaultIsModuleExports
 ) {
   exportDeclarations.push(
     `export default ${
-      detectWrappedDefault
+      detectWrappedDefault && defaultIsModuleExports === 'auto'
         ? `/*@__PURE__*/${HELPERS_NAME}.getDefaultExportFromCjs(${exportsName})`
+        : defaultIsModuleExports === false
+        ? `${exportsName}.default`
         : exportsName
     };`
   );
@@ -872,7 +904,8 @@ function getExports(
   moduleName,
   exportsName,
   defineCompiledEsmExpressions,
-  HELPERS_NAME
+  HELPERS_NAME,
+  defaultIsModuleExports
 ) {
   let deconflictedDefaultExportName;
   // Collect and rewrite module.exports assignments
@@ -912,16 +945,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});`
-      );
-    }
-  } else {
+  if (!isRestorableCompiledEsm || defaultIsModuleExports === true) {
     exportDeclarations.push(`export default ${exportsName};`);
+  } else if (moduleExportsAssignments.length === 0 || defaultIsModuleExports === false) {
+    exports.push(`${deconflictedDefaultExportName || exportsName} as default`);
+  } else {
+    exportDeclarations.push(
+      `export default /*@__PURE__*/${HELPERS_NAME}.getDefaultExportFromCjs(${exportsName});`
+    );
   }
 }
 
@@ -1123,13 +1154,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);
@@ -1402,12 +1435,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;
@@ -1518,7 +1553,8 @@ function transformCommonjs(
       uses.exports ||
       uses.require ||
       usesDynamicRequire ||
-      hasRemovedRequire
+      hasRemovedRequire ||
+      topLevelDefineCompiledEsmExpressions.length > 0
     ) &&
     (ignoreGlobal || !uses.global)
   ) {
@@ -1573,7 +1609,8 @@ function transformCommonjs(
         code,
         HELPERS_NAME,
         exportMode,
-        detectWrappedDefault
+        detectWrappedDefault,
+        defaultIsModuleExports
       );
 
   if (shouldWrap) {
@@ -1598,6 +1635,7 @@ function commonjs(options = {}) {
   const filter = createFilter(options.include, options.exclude);
   const {
     ignoreGlobal,
+    ignoreDynamicRequires,
     requireReturnsDefault: requireReturnsDefaultOption,
     esmExternals
   } = options;
@@ -1612,6 +1650,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
@@ -1623,6 +1663,7 @@ function commonjs(options = {}) {
 
   const esModulesWithDefaultExport = new Set();
   const esModulesWithNamedExports = new Set();
+  const commonJsMetaPromises = new Map();
 
   const ignoreRequire =
     typeof options.ignore === 'function'
@@ -1689,13 +1730,15 @@ function commonjs(options = {}) {
       isEsModule,
       ignoreGlobal || isEsModule,
       ignoreRequire,
+      ignoreDynamicRequires && !isDynamicRequireModulesEnabled,
       getIgnoreTryCatchRequireStatementMode,
       sourceMap,
       isDynamicRequireModulesEnabled,
       dynamicRequireModuleSet,
       disableWrap,
       commonDir,
-      ast
+      ast,
+      defaultIsModuleExports
     );
   }
 
@@ -1715,7 +1758,7 @@ function commonjs(options = {}) {
 
     load(id) {
       if (id === HELPERS_ID) {
-        return getHelpersModule(isDynamicRequireModulesEnabled);
+        return getHelpersModule(isDynamicRequireModulesEnabled, ignoreDynamicRequires);
       }
 
       if (id.startsWith(HELPERS_ID)) {
@@ -1788,7 +1831,8 @@ function commonjs(options = {}) {
           actualId,
           getRequireReturnsDefault(actualId),
           esModulesWithDefaultExport,
-          esModulesWithNamedExports
+          esModulesWithNamedExports,
+          commonJsMetaPromises
         );
       }
 
@@ -1821,10 +1865,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);
     }
   };
 }