@rollup/plugin-commonjs 13.0.1 → 15.1.0

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # @rollup/plugin-commonjs ChangeLog
 
+## v15.1.0
+
+_2020-09-21_
+
+### Features
+
+- feat: inject \_\_esModule marker into ES namespaces and add Object prototype (#552)
+- feat: add requireReturnsDefault to types (#579)
+
+## v15.0.0
+
+_2020-08-13_
+
+### Breaking Changes
+
+- feat!: return the namespace by default when requiring ESM (#507)
+- fix!: fix interop when importing CJS that is transpiled ESM from an actual ESM (#501)
+
+### Bugfixes
+
+- fix: add .cjs to default file extensions. (#524)
+
+### Updates
+
+- chore: update dependencies (fe399e2)
+
+## v14.0.0
+
+_2020-07-13_
+
+### Release Notes
+
+This restores the fixes from v13.0.1, but as a semver compliant major version.
+
+## v13.0.2
+
+_2020-07-13_
+
+### Rollback
+
+Rolls back breaking change in v13.0.1 whereby the exported `unwrapExports` method was removed.
+
 ## v13.0.1
 
 _2020-07-12_

package/README.md

@@ -46,7 +46,7 @@ Then call `rollup` either via the [CLI](https://www.rollupjs.org/guide/en/#comma
 
 ### `dynamicRequireTargets`
 
-Type: `String|Array[String]`<br>
+Type: `string | string[]`<br>
 Default: `[]`
 
 Some modules contain dynamic `require` calls, or require modules that contain circular dependencies, which are not handled well by static imports.
@@ -73,52 +73,205 @@ commonjs({
 
 ### `exclude`
 
-Type: `String` | `Array[...String]`<br>
+Type: `string | string[]`<br>
 Default: `null`
 
-A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should _ignore_. By default non-CommonJS modules are ignored.
+A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should _ignore_. By default, all files with extensions other than those in `extensions` or `".cjs"` are ignored, but you can exclude additional files. See also the `include` option.
 
 ### `include`
 
-Type: `String` | `Array[...String]`<br>
+Type: `string | string[]`<br>
 Default: `null`
 
-A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should operate on. By default CommonJS modules are targeted.
+A [minimatch pattern](https://github.com/isaacs/minimatch), or array of patterns, which specifies the files in the build the plugin should operate on. By default, all files with extension `".cjs"` or those in `extensions` are included, but you can narrow this list by only including specific files. These files will be analyzed and transpiled if either the analysis does not find ES module specific statements or `transformMixedEsModules` is `true`.
 
 ### `extensions`
 
-Type: `Array[...String]`<br>
+Type: `string[]`<br>
 Default: `['.js']`
 
-Search for extensions other than .js in the order specified.
+For extensionless imports, search for extensions other than .js in the order specified. Note that you need to make sure that non-JavaScript files are transpiled by another plugin first.
 
 ### `ignoreGlobal`
 
-Type: `Boolean`<br>
+Type: `boolean`<br>
 Default: `false`
 
 If true, uses of `global` won't be dealt with by this plugin.
 
 ### `sourceMap`
 
-Type: `Boolean`<br>
+Type: `boolean`<br>
 Default: `true`
 
-If false, skips source map generation for CommonJS modules.
+If false, skips source map generation for CommonJS modules. This will improve performance.
 
 ### `transformMixedEsModules`
 
-Type: `Boolean`<br>
+Type: `boolean`<br>
 Default: `false`
 
-Instructs the plugin whether or not to enable mixed module transformations. This is useful in scenarios with mixed ES and CommonJS modules. Set to `true` if it's known that `require` calls should be transformed, or `false` if the code contains env detection and the `require` should survive a transformation.
+Instructs the plugin whether to enable mixed module transformations. This is useful in scenarios with modules that contain a mix of ES `import` statements and CommonJS `require` expressions. Set to `true` if `require` calls should be transformed to imports in mixed modules, or `false` if the `require` expressions should survive the transformation. The latter can be important if the code contains environment detection, or you are coding for an environment with special treatment for `require` calls such as [ElectronJS](https://www.electronjs.org/). See also the "ignore" option.
 
 ### `ignore`
 
-Type: `Array[...String | (String) => Boolean]`<br>
+Type: `string[] | ((id: string) => boolean)`<br>
 Default: `[]`
 
-Sometimes you have to leave require statements unconverted. Pass an array containing the IDs or an `id => boolean` function. Only use this option if you know what you're doing!
+Sometimes you have to leave require statements unconverted. Pass an array containing the IDs or an `id => boolean` function.
+
+### `esmExternals`
+
+Type: `boolean | string[] | ((id: string) => boolean)`
+Default: `false`
+
+Controls how to render imports from external dependencies. By default, this plugin assumes that all external dependencies are CommonJS. This means they are rendered as default imports to be compatible with e.g. NodeJS where ES modules can only import a default export from a CommonJS dependency:
+
+```js
+// input
+const foo = require('foo');
+
+// output
+import foo from 'foo';
+```
+
+This is likely not desired for ES module dependencies: Here `require` should usually return the namespace to be compatible with how bundled modules are handled.
+
+If you set `esmExternals` to `true`, this plugins assumes that all external dependencies are ES modules and will adhere to the `requireReturnsDefault` option. If that option is not set, they will be rendered as namespace imports.
+
+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.
+
+### `requireReturnsDefault`
+
+Type: `boolean | "auto" | "preferred" | ((id: string) => boolean | "auto" | "preferred")`<br>
+Default: `false`
+
+Controls what is returned when requiring an ES module from a CommonJS file. When using the `esmExternals` option, this will also apply to external modules. By default, this plugin will render those imports as namespace imports, i.e.
+
+```js
+// input
+const foo = require('foo');
+
+// output
+import * as foo from 'foo';
+```
+
+This is in line with how other bundlers handle this situation and is also the most likely behaviour in case Node should ever support this. However there are some situations where this may not be desired:
+
+- There is code in an external dependency that cannot be changed where a `require` statement expects the default export to be returned from an ES module.
+- If the imported module is in the same bundle, Rollup will generate a namespace object for the imported module which can increase bundle size unnecessarily:
+
+  ```js
+  // input: main.js
+  const dep = require('./dep.js');
+  console.log(dep.default);
+
+  // input: dep.js
+  export default 'foo';
+
+  // output
+  var dep = 'foo';
+
+  var dep$1 = /*#__PURE__*/ Object.freeze({
+    __proto__: null,
+    default: dep
+  });
+
+  console.log(dep$1.default);
+  ```
+
+For these situations, you can change Rollup's behaviour either globally or per module. To change it globally, set the `requireReturnsDefault` option to one of the following values:
+
+- `false`: This is the default, requiring an ES module returns its namespace. This is the only option that will also add a marker `__esModule: true` to the namespace to support interop patterns in CommonJS modules that are transpiled ES modules.
+
+  ```js
+  // input
+  const dep = require('dep');
+  console.log(dep);
+
+  // output
+  import * as dep$1 from 'dep';
+
+  function getAugmentedNamespace(n) {
+    var a = Object.defineProperty({}, '__esModule', { value: true });
+    Object.keys(n).forEach(function (k) {
+      var d = Object.getOwnPropertyDescriptor(n, k);
+      Object.defineProperty(
+        a,
+        k,
+        d.get
+          ? d
+          : {
+              enumerable: true,
+              get: function () {
+                return n[k];
+              }
+            }
+      );
+    });
+    return a;
+  }
+
+  var dep = /*@__PURE__*/ getAugmentedNamespace(dep$1);
+
+  console.log(dep);
+  ```
+
+- `"namespace"`: Like `false`, requiring an ES module returns its namespace, but the plugin does not add the `__esModule` marker and thus creates more efficient code. For external dependencies when using `esmExternals: true`, no additional interop code is generated.
+
+  ```js
+  // output
+  import * as dep from 'dep';
+
+  console.log(dep);
+  ```
+
+- `"auto"`: This is complementary to how [`output.exports`](https://rollupjs.org/guide/en/#outputexports): `"auto"` works in Rollup: If a module has a default export and no named exports, requiring that module returns the default export. In all other cases, the namespace is returned. For external dependencies when using `esmExternals: true`, a corresponding interop helper is added:
+
+  ```js
+  // output
+  import * as dep$1 from 'dep';
+
+  function getDefaultExportFromNamespaceIfNotNamed(n) {
+    return n &&
+      Object.prototype.hasOwnProperty.call(n, 'default') &&
+      Object.keys(n).length === 1
+      ? n['default']
+      : n;
+  }
+
+  var dep = getDefaultExportFromNamespaceIfNotNamed(dep$1);
+
+  console.log(dep);
+  ```
+
+- `"preferred"`: If a module has a default export, requiring that module always returns the default export, no matter whether additional named exports exist. This is similar to how previous versions of this plugin worked. Again for external dependencies when using `esmExternals: true`, an interop helper is added:
+
+  ```js
+  // output
+  import * as dep$1 from 'dep';
+
+  function getDefaultExportFromNamespaceIfPresent(n) {
+    return n && Object.prototype.hasOwnProperty.call(n, 'default')
+      ? n['default']
+      : n;
+  }
+
+  var dep = getDefaultExportFromNamespaceIfPresent(dep$1);
+
+  console.log(dep);
+  ```
+
+- `true`: This will always try to return the default export on require without checking if it actually exists. This can throw at build time if there is no default export. This is how external dependencies are handled when `esmExternals` is not used. The advantage over the other options is that, like `false`, this does not add an interop helper for external dependencies, keeping the code lean:
+
+  ```js
+  // output
+  import dep from 'dep';
+
+  console.log(dep);
+  ```
+
+To change this for individual modules, you can supply a function for `requireReturnsDefault` instead. This function will then be called once for each required ES module or external dependency with the corresponding id and allows you to return different values for different modules.
 
 ## Using with @rollup/plugin-node-resolve