Github url

rollup

by rollup

rollup /rollup

Next-generation ES module bundler

18.5K Stars 888 Forks Last release: 3 days ago (v2.21.0) Other 4.3K Commits 443 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Rollup

npm versioninstall sizecode coveragebackerssponsorslicensedependency statusJoin 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
</pre>
<p>For Node.js:</p>
<pre class="bash"># compile to a CommonJS module
rollup main.js --format cjs --file bundle.js
</pre>
<p>For both browsers and Node.js:</p>
<pre class="bash"># UMD format requires a bundle name
rollup main.js --format umd --name "myBundle" --file bundle.js
</pre>
<h2>Why</h2>

<p>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&#39;ll need to solve, and simply writing smaller projects in the first place <a href="https://medium.com/@Rich_Harris/small-modules-it-s-not-quite-that-simple-3ca532d65de4">isn&#39;t necessarily the answer</a>. Unfortunately, JavaScript has not historically included this capability as a core feature in the language.</p>

<p>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 &quot;.mjs&quot; 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 <em>write future-proof code</em>, and you also get the tremendous benefits of...</p>

<h2>Tree Shaking</h2>

<p>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&#39;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.</p>

<p>For example, with CommonJS, the <em>entire tool or library must be imported</em>.</p>
<pre class="js">// 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 );
</pre>
<p>But with ES modules, instead of importing the whole <pre class="">utils</pre> object, we can just import the one <pre class="">ajax</pre> function we need:</p>
<pre class="js">// 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 );
</pre>
<p>Because Rollup includes the bare minimum, it results in lighter, faster, and less complicated libraries and applications. Since this approach is based on explicit <pre class="">import</pre> and <pre class="">export</pre> statements, it is vastly more effective than simply running an automated minifier to detect unused variables in the compiled output code.</p>

<h2>Compatibility</h2>

<h3>Importing CommonJS</h3>

<p>Rollup can import existing CommonJS modules <a href="https://github.com/rollup/plugins/tree/master/packages/commonjs">through a plugin</a>.</p>

<h3>Publishing ES Modules</h3>

<p>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 <pre class="">main</pre> property in your <pre class="">package.json</pre> file. If your <pre class="">package.json</pre> file also has a <pre class="">module</pre> field, ES-module-aware tools like Rollup and <a href="https://webpack.js.org/">webpack 2</a> will <a href="https://github.com/rollup/rollup/wiki/pkg.module">import the ES module version</a> directly.</p>

<h2>Contributors</h2>

<p>This project exists thanks to all the people who contribute. [<a href="CONTRIBUTING.md">Contribute</a>].
<a href="https://github.com/rollup/rollup/graphs/contributors"><img src="https://opencollective.com/rollup/contributors.svg?width=890" /></a></p>

<h2>Backers</h2>

<p>Thank you to all our backers! ๐Ÿ™ [<a href="https://opencollective.com/rollup#backer">Become a backer</a>]</p>

<p><a href="https://opencollective.com/rollup#backers" target="_blank"><img src="https://opencollective.com/rollup/backers.svg?width=890"></a></p>

<h2>Sponsors</h2>

<p>Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [<a href="https://opencollective.com/rollup#sponsor">Become a sponsor</a>]</p>

<p><a href="https://opencollective.com/rollup/sponsor/0/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/rollup/sponsor/1/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/rollup/sponsor/2/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/rollup/sponsor/3/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/rollup/sponsor/4/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/rollup/sponsor/5/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/rollup/sponsor/6/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/rollup/sponsor/7/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/rollup/sponsor/8/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/rollup/sponsor/9/website" target="_blank"><img src="https://opencollective.com/rollup/sponsor/9/avatar.svg"></a></p>

<h2>License</h2>

<p><a href="https://github.com/rollup/rollup/blob/master/LICENSE.md">MIT</a></p>
</script>

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.