rollup-plugin-commonjs

WebJar for rollup-plugin-commonjs

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

rollup-plugin-commonjs
Last Version

Last Version

10.1.0
Release Date

Release Date

Type

Type

jar
Description

Description

rollup-plugin-commonjs
WebJar for rollup-plugin-commonjs
Project URL

Project URL

https://www.webjars.org
Source Code Management

Source Code Management

https://github.com/rollup/rollup-plugin-commonjs

Download rollup-plugin-commonjs

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/rollup-plugin-commonjs/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>rollup-plugin-commonjs</artifactId>
    <version>10.1.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/rollup-plugin-commonjs/
implementation 'org.webjars.npm:rollup-plugin-commonjs:10.1.0'
// https://jarcasting.com/artifacts/org.webjars.npm/rollup-plugin-commonjs/
implementation ("org.webjars.npm:rollup-plugin-commonjs:10.1.0")
'org.webjars.npm:rollup-plugin-commonjs:jar:10.1.0'
<dependency org="org.webjars.npm" name="rollup-plugin-commonjs" rev="10.1.0">
  <artifact name="rollup-plugin-commonjs" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='rollup-plugin-commonjs', version='10.1.0')
)
libraryDependencies += "org.webjars.npm" % "rollup-plugin-commonjs" % "10.1.0"
[org.webjars.npm/rollup-plugin-commonjs "10.1.0"]

Dependencies

compile (5)

Group / Artifact Type Version
org.webjars.npm : resolve jar [1.11.0,2)
org.webjars.npm : rollup-pluginutils jar [2.8.1,3)
org.webjars.npm : estree-walker jar [0.6.1,0.7)
org.webjars.npm : magic-string jar [0.25.2,0.26)
org.webjars.npm : is-reference jar [1.1.2,2)

Project Modules

There are no modules declared in this project.

Moved

This module has moved and is now available at @rollup/plugin-commonjs. Please update your dependencies. This repository is no longer maintained.

rollup-plugin-commonjs Build Status

Convert CommonJS modules to ES6, so they can be included in a Rollup bundle

Installation

npm install --save-dev rollup-plugin-commonjs

Usage

Typically, you would use this plugin alongside rollup-plugin-node-resolve, so that you could bundle your CommonJS dependencies in node_modules.

// rollup.config.js
import commonjs from 'rollup-plugin-commonjs';
import nodeResolve from 'rollup-plugin-node-resolve';

export default {
  input: 'main.js',
  output: {
    file: 'bundle.js',
    format: 'iife'
  },
  plugins: [
    nodeResolve({
      jsnext: true,
      main: true
    }),

    commonjs({
      // non-CommonJS modules will be ignored, but you can also
      // specifically include/exclude files
      include: 'node_modules/**',  // Default: undefined
      exclude: [ 'node_modules/foo/**', 'node_modules/bar/**' ],  // Default: undefined
      // these values can also be regular expressions
      // include: /node_modules/

      // search for files other than .js files (must already
      // be transpiled by a previous plugin!)
      extensions: [ '.js', '.coffee' ],  // Default: [ '.js' ]

      // if true then uses of `global` won't be dealt with by this plugin
      ignoreGlobal: false,  // Default: false

      // if false then skip sourceMap generation for CommonJS modules
      sourceMap: false,  // Default: true

      // explicitly specify unresolvable named exports
      // (see below for more details)
      namedExports: { 'react': ['createElement', 'Component' ] },  // Default: undefined

      // sometimes you have to leave require statements
      // unconverted. Pass an array containing the IDs
      // or a `id => boolean` function. Only use this
      // option if you know what you're doing!
      ignore: [ 'conditional-runtime-dependency' ]
    })
  ]
};

Usage with symlinks

Symlinks are common in monorepos and are also created by the npm link command. Rollup with rollup-plugin-node-resolve resolves modules to their real paths by default. So include and exclude paths should handle real paths rather than symlinked paths (e.g. ../common/node_modules/** instead of node_modules/**). You may also use a regular expression for include that works regardless of base path. Try this:

commonjs({
  include: /node_modules/
})

Whether symlinked module paths are realpathed or preserved depends on Rollup's preserveSymlinks setting, which is false by default, matching Node.js' default behavior. Setting preserveSymlinks to true in your Rollup config will cause import and export to match based on symlinked paths instead.

Custom named exports

This plugin will attempt to create named exports, where appropriate, so you can do this...

// importer.js
import { named } from './exporter.js';

// exporter.js
module.exports = { named: 42 }; // or `exports.named = 42;`

...but that's not always possible:

// importer.js
import { named } from 'my-lib';

// my-lib.js
var myLib = exports;
myLib.named = 'you can\'t see me';

In those cases, you can specify custom named exports:

commonjs({
  namedExports: {
    // left-hand side can be an absolute path, a path
    // relative to the current directory, or the name
    // of a module in node_modules
    'my-lib': [ 'named' ]
  }
})

Strict mode

ES modules are always parsed in strict mode. That means that certain non-strict constructs (like octal literals) will be treated as syntax errors when Rollup parses modules that use them. Some older CommonJS modules depend on those constructs, and if you depend on them your bundle will blow up. There's basically nothing we can do about that.

Luckily, there is absolutely no good reason not to use strict mode for everything — so the solution to this problem is to lobby the authors of those modules to update them.

License

MIT

org.webjars.npm

Rollup

Rollup is a module bundler for JavaScript which compiles small pieces of code into something larger and more complex, such as a library or application.

Versions

Version
10.1.0
9.1.3
8.4.1
8.3.0