Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nolanlawson/rollupify

Browserify transform to apply Rollup (UNMAINTAINED)
https://github.com/nolanlawson/rollupify

Last synced: 13 days ago
JSON representation

Browserify transform to apply Rollup (UNMAINTAINED)

Awesome Lists containing this project

README

        

rollupify [![Build Status](https://travis-ci.org/nolanlawson/rollupify.svg?branch=master)](https://travis-ci.org/nolanlawson/rollupify) [![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
====

Browserify transform to apply [Rollup](http://rollupjs.org/), converting ES6/ES2015 modules
into one big CommonJS module.

This tends to result in smaller bundle sizes, due to Rollup's [tree-shaking](http://www.2ality.com/2015/12/webpack-tree-shaking.html) and
[scope-hoisting](https://github.com/substack/node-browserify/issues/1379#issuecomment-183383199) capabilities.

⚠️ _**Maintenance notice:** This repo is unmaintained. I consider it largely a hack for migrating existing Browserify/CommonJS projects to Rollup/ESM. Probably you should just use Rollup instead, with plugins like `rollup-plugin-commonjs` and `rollup-plugin-node-resolve`, or manually run `rollup` before `browserify`._

Usage
---

npm install rollupify

Then:

browserify -t rollupify index.js > output.js

Or in your `package.json`:

```js
"browserify": {
"transform": ["rollupify"]
}
```

Example
---

**Input:**

```js
// index.js
import hello from './hello';
console.log(hello);
export default hello;
```

```js
// hello.js
export default "hello world";
```

**Output:**

```js
(function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o output.js

Or when configuring:

```js
"browserify": {
"transform": ["rollupify", "babelify"]
}
```

Details
----

`rollupify` only works on ES6/ES2015 modules. Any `require()` statements will
be left untouched, and passed on to Browserify like normal.

Sourcemaps are supported, assuming you pass `--debug` or `{debug: true}`
into Browserify.

Need more evidence that Rollup and ES6 modules are awesome? See [rollup-comparison](https://github.com/nolanlawson/rollup-comparison)
and [A better build system with Rollup](http://pouchdb.com/2016/01/13/pouchdb-5.2.0-a-better-build-system-with-rollup.html).

Need to get started converting your CommonJS codebase into ES6? Try [cjs-to-es6](https://github.com/nolanlawson/cjs-to-es6).

Customising rollup
----

Given a `rollup.config.js` like:

```js
module.exports = {
plugins: [
require('rollup-plugin-babel')({
exclude: 'node_modules/**'
})
]
}
```

Use it through the command line:

browserify -t [ rollupify --config rollup.config.js ] index.js > output.js

Or in your `package.json`:

```js
"browserify": {
"transform": ["rollupify", {"config": "rollup.config.js"}]
}
```

If you are using Browserify in JavaScript, you can also pass in the `config` object directly:

```js
var b = browserify('./')
.transform('rollupify', {
config: { /* your rollup config goes here */ }
}).bundle();
```