• This repository has been archived on 05/Aug/2021
  • Stars
    star
    501
  • Rank 88,002 (Top 2 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 9 years ago
  • Updated almost 5 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

This module has moved and is now available at @rollup/plugin-commonjs / https://github.com/rollup/plugins/blob/master/packages/commonjs

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

More Repositories

1

rollup

Next-generation ES module bundler
JavaScript
25,314
star
2

plugins

🍣 The one-stop shop for official Rollup plugins
JavaScript
3,626
star
3

awesome

⚡️ Delightful Rollup Plugins, Packages, and Resources
2,549
star
4

rollup-starter-lib

Bare-bones example of how to create a library using Rollup
JavaScript
966
star
5

rollup-plugin-babel

This package has moved and is now available at @rollup/plugin-babel / https://github.com/rollup/plugins/tree/master/packages/babel
JavaScript
702
star
6

rollup-plugin-node-resolve

This module has moved and is now available at @rollup/plugin-node-resolve / https://github.com/rollup/plugins/blob/master/packages/node-resolve
JavaScript
469
star
7

rollup-starter-app

Bare-bones example of how to create an application using Rollup
JavaScript
424
star
8

rollup-starter-project

Sample project for packages built using rollup.
JavaScript
325
star
9

rollup-plugin-typescript

This module has moved and is now available at @rollup/plugin-typescript / https://github.com/rollup/plugins/blob/master/packages/typescript
JavaScript
324
star
10

rollup-starter-code-splitting

Starter project with code-splitting and dynamic imports, for modern and legacy browsers
JavaScript
248
star
11

rollup-plugin-alias

This module has moved and is now available at @rollup/plugin-alias / https://github.com/rollup/plugins/tree/master/packages/alias
JavaScript
172
star
12

rollup-plugin-multi-entry

This module has moved and is now available at @rollup/plugin-multi-entry / https://github.com/rollup/plugins/blob/master/packages/multi-entry
JavaScript
171
star
13

rollup-plugin-replace

This module has moved and is now available at @rollup/plugin-replace / https://github.com/rollup/plugins/blob/master/packages/replace
JavaScript
162
star
14

rollup-plugin-json

This module has moved and is now available at @rollup/plugin-json / https://github.com/rollup/plugins/blob/master/packages/json
JavaScript
126
star
15

rollup-watch

Fast incremental rebuilds with Rollup CLI
JavaScript
91
star
16

three-jsnext

three.js, but futuristic
JavaScript
85
star
17

rollupjs.org

Rollup demo website
Svelte
77
star
18

rollup-plugin-inject

This module has moved and is now available at @rollup/plugin-inject / https://github.com/rollup/plugins/blob/master/packages/inject
JavaScript
77
star
19

rollup-plugin-wasm

This module has moved and is now available at @rollup/plugin-wasm / https://github.com/rollup/plugins/blob/master/packages/wasm
WebAssembly
75
star
20

rollup-plugin-url

This module has moved and is now available at @rollup/plugin-url / https://github.com/rollup/plugins/blob/master/packages/url
JavaScript
75
star
21

rollup-docs-cn

Rollup.js 中文文档 - Built with Vitepress
JavaScript
74
star
22

rollup-plugin-run

This module has moved and is now available at @rollup/plugin-run / https://github.com/rollup/plugins/blob/master/packages/run
JavaScript
64
star
23

rollup-plugin-strip

This module has moved and is now available at @rollup/plugin-strip / https://github.com/rollup/plugins/blob/master/packages/strip
JavaScript
50
star
24

babel-preset-es2015-rollup

babel-preset-es2015, minus modules, plus helpers
JavaScript
48
star
25

rollup-pluginutils

This package has moved and is now available at @rollup/pluginutils / https://github.com/rollup/plugins
TypeScript
45
star
26

rollup-plugin-buble

This module has moved and is now available at @rollup/plugin-buble / https://github.com/rollup/plugins/blob/master/packages/buble
JavaScript
43
star
27

rollup-plugin-image

This module has moved and is now available at @rollup/plugin-image / https://github.com/rollup/plugins/blob/master/packages/image
JavaScript
41
star
28

plugin-auto-install

This module has moved and is now available at @rollup/plugin-auto-install / https://github.com/rollup/plugins/blob/master/packages/auto-install
JavaScript
41
star
29

rollup-plugin-virtual

This module has moved and is now available at @rollup/plugin-virtual / https://github.com/rollup/plugins/blob/master/packages/virtual
JavaScript
41
star
30

d3-jsnext

d3, but futuristic
JavaScript
33
star
31

rollup-babel

[DEPRECATED] Experimental rollup/babel integration
JavaScript
28
star
32

rollup-plugin-sucrase

This package has moved and is now available at @rollup/plugin-sucrase / https://github.com/rollup/plugins/blob/master/packages/sucrase
JavaScript
23
star
33

stream

🍣 Stream Rollup build results
TypeScript
22
star
34

rollup-plugin-butternut

This module is no longer maintained. Please use https://www.npmjs.com/package/rollup-plugin-terser
JavaScript
20
star
35

rollup-plugin-ractive

Precompile Ractive components
JavaScript
11
star
36

rollup-plugin-yaml

This module has moved and is now available at @rollup/plugin-yaml / https://github.com/rollup/plugins/blob/master/packages/yaml
JavaScript
11
star
37

rollup-plugin-legacy

Add export statements to plain scripts. Moved to https://github.com/rollup/plugins/blob/master/packages/legacy
JavaScript
10
star
38

eslint-config-rollup

A shareable ESLint configuration for Rollup projects
JavaScript
9
star
39

rollup-init

Initialise Rollup configuration
JavaScript
7
star
40

rollup-plugin-dsv

This module has moved and is now available at @rollup/plugin-dsv / https://github.com/rollup/plugins/blob/master/packages/dsv
JavaScript
5
star
41

rollup-starter-plugin

Starter code for creating a Rollup plugin
JavaScript
5
star
42

containers

📤
Dockerfile
4
star
43

log

🌳
TypeScript
3
star
44

hull

🛳
JavaScript
2
star
45

org

Organizational issues and tasks for Rollup
1
star
46

rollup-docs-az

Rollup docs in Azerbaijani
JavaScript
1
star