rollup
    Overview
    Insights & Analysis
    Code
    Versions
    Find an Expert
    Documentation
    Playground
    Issues
    Career Opportunities
    Alternatives
    Dependencies

rollup

Next-generation ES module bundler

1.19.4  •  Published 17 days ago  •  by Rich Harris  •  MIT License

npm version install size code coverage backers sponsors license dependency status Join the chat at https://gitter.im/rollup/rollup

Overview

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. It uses the standardized ES module format for code, instead of previous idiosyncratic solutions such as CommonJS and AMD. ES modules let you freely and seamlessly combine the most useful individual functions from your favorite libraries. Rollup can optimize ES modules for faster native loading in modern browsers, or output a legacy module format allowing ES module workflows today.

Quick Start Guide

Install with npm install --global rollup. Rollup can be used either through a command line interface with an optional configuration file, or else through its JavaScript API. Run rollup --help to see the available options and parameters. The starter project templates, rollup-starter-lib and rollup-starter-app, demonstrate common configuration options, and more detailed instructions are available throughout the user guide.

Commands

These commands assume the entry point to your application is named main.js, and that you’d like all imports compiled into a single file named bundle.js.

For browsers:

# compile to a <script> containing a self-executing function
$ rollup main.js --format iife --name "myBundle" --file bundle.js

For Node.js:

# compile to a CommonJS module
$ rollup main.js --format cjs --file bundle.js

For both browsers and Node.js:

# UMD format requires a bundle name
$ rollup main.js --format umd --name "myBundle" --file bundle.js

Why

Developing software is usually easier if you break your project into smaller separate pieces, since that often removes unexpected interactions and dramatically reduces the complexity of the problems you’ll need to solve, and simply writing smaller projects in the first place isn’t necessarily the answer. Unfortunately, JavaScript has not historically included this capability as a core feature in the language.

This finally changed with ES modules support in JavaScript, which provides a syntax for importing and exporting functions and data so they can be shared between separate scripts. The specification is now implemented in all major browsers and in Node.js behind the --experimental-modules flag for “.mjs” files. Rollup allows you to write your code using this module system, either outputting optimized ES modules for use in these native environments, or compiling it back down to existing supported formats such as CommonJS modules, AMD modules, and IIFE-style scripts. This means that you get to write future-proof code, and you also get the tremendous benefits of…

Tree Shaking

In addition to enabling the use of ES modules, Rollup also statically analyzes and optimizes the code you are importing, and will exclude anything that isn’t actually used. This allows you to build on top of existing tools and modules without adding extra dependencies or bloating the size of your project.

For example, with CommonJS, the entire tool or library must be imported.

// import the entire utils object with CommonJS
var utils = require( 'utils' );
var query = 'Rollup';
// use the ajax method of the utils object
utils.ajax( 'https://api.example.com?search=' + query ).then( handleResponse );

But with ES modules, instead of importing the whole utils object, we can just import the one ajax function we need:

// import the ajax function with an ES import statement
import { ajax } from 'utils';
var query = 'Rollup';
// call the ajax function
ajax( 'https://api.example.com?search=' + query ).then( handleResponse );

Because Rollup includes the bare minimum, it results in lighter, faster, and less complicated libraries and applications. Since this approach is based on explicit import and export statements, it is vastly more effective than simply running an automated minifier to detect unused variables in the compiled output code.

Compatibility

Importing CommonJS

Rollup can import existing CommonJS modules through a plugin.

Publishing ES Modules

To make sure your ES modules are immediately usable by tools that work with CommonJS such as Node.js and webpack, you can use Rollup to compile to UMD or CommonJS format, and then point to that compiled version with the main property in your package.json file. If your package.json file also has a module field, ES-module-aware tools like Rollup and webpack 2 will import the ES module version directly.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

MIT

Dependencies

@types/estree  ·  @types/node  ·  acorn  ·  @types/chokidar  ·  @types/micromatch  ·  @types/minimist  ·  acorn-bigint  ·  acorn-dynamic-import  ·  acorn-import-meta  ·  acorn-jsx  ·  acorn-walk  ·  buble  ·  chokidar  ·  codecov  ·  console-group  ·  core-js  ·  date-time  ·  es5-shim  ·  es6-shim  ·  eslint  ·  eslint-plugin-import  ·  execa  ·  fixturify  ·  hash.js  ·  husky  ·  immutable  ·  is-reference  ·  lint-staged  ·  locate-character  ·  magic-string  ·  markdownlint-cli  ·  micromatch  ·  minimist  ·  mocha  ·  nyc  ·  prettier  ·  pretty-bytes  ·  pretty-ms  ·  require-relative  ·  requirejs  ·  rollup  ·  rollup-plugin-alias  ·  rollup-plugin-buble  ·  rollup-plugin-commonjs  ·  rollup-plugin-json  ·  rollup-plugin-node-resolve  ·  rollup-plugin-replace  ·  rollup-plugin-string  ·  rollup-plugin-terser  ·  rollup-plugin-typescript  ·  rollup-pluginutils  ·  sander  ·  shx  ·  signal-exit  ·  source-map  ·  source-map-support  ·  sourcemap-codec  ·  systemjs  ·  terser  ·  tslib  ·  tslint  ·  turbocolor  ·  typescript  ·  url-parse

Tags

modules
bundler
bundling
es6
optimizer
Avoid unsafe or low quality packages
Warn or block the installation of vulnerable, badly licensed, deprecated, outdated, unmaintained, or unpopular packages. Integrates with your npm and pre-commit/build scripts
Just $9/month per developer

Popularity

Weekly Downloads
803.9K
Stars
16.1K

Issues and PRs

Activity

Last ver 17 days ago
Created 4 years ago
Last commit 1 month ago
12 hours between commits

Sustainability

71 contributors

Technology

Node version: 10.16.0
2525.6K unpacked

Legal and Compliance

MIT License
OSI Approved
0 vulnerabilities

Top Experts

Lukas Taegert
Maintainer, 704 commits, 354 merges, 141 PRs
Works at TNG Technology Consulting GmbH
Rich-Harris
Maintainer, 8 commits, 413 merges, 229 PRs
Guy Bedford
Maintainer, 193 commits, 19 merges, 101 PRs
Bogdan Chadkin
Maintainer, 9 commits, 12 merges, 29 PRs
Works at realadvisor
Oskar Segersvärd
Maintainer, 17 merges, 51 PRs
Works at google
Andrew Powell
Maintainer, 5 commits, 7 merges, 5 PRs