https://github.com/egoist/rolling

A preset Rollup workflow.
https://github.com/egoist/rolling

Last synced: 4 months ago
JSON representation

A preset Rollup workflow.

• Host: GitHub
• URL: https://github.com/egoist/rolling
• Owner: egoist
• License: mit
• Created: 2016-04-12T14:37:44.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2021-12-25T13:54:39.000Z (about 3 years ago)
• Last Synced: 2024-10-21T09:14:57.058Z (4 months ago)
• Language: JavaScript
• Size: 16.6 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rolling [![NPM version](https://img.shields.io/npm/v/rolling.svg)](https://npmjs.com/package/rolling) [![NPM downloads](https://img.shields.io/npm/dm/rolling.svg)](https://npmjs.com/package/rolling) [![Build Status](https://img.shields.io/circleci/project/egoist/rolling/master.svg)](https://circleci.com/gh/egoist/rolling)

[Rollup](https://github.com/rollup/rollup) and [Webpack](https://github.com/webpack/webpack) are bundlers for different purposes, I mainly use `Webpack` to bundle web apps, and use `Rollup` to bundle JavaScript libraries. Using `Rollup` to bundle libraries ends up with clean, smaller, readable code, so just try it out!

## Install

```bash

$ npm install -g rolling

```

## Usage

**Build:**

```bash

# it looks for `./src/index.js` by default

# and outputs bundled file to `./dist/bundle.js`

$ rolling src.js --out bundle.js

# Include required modules from node_modules directory

# into the bundled file

$ rolling --include

```

**Watch input:**

Currently Rollup does not support incremental builds, so use any `watch utility` to do this for now, such as `onchange`:

```bash

$ npm install -g onchange

$ onchange ./src -- rolling

```

**Help:**

```bash

$ rolling --help

```

**Babel:**

If you use some ES2015+ features that require `babel-runtime`, install it in your project:

```bash

$ cd my-project

$ npm install babel-runtime --save

```

## Recipes

### Alias

In `package.json`:

```json

{

  "rolling": {

    "alias": {

      "models": "{cwd}/src/models"

    }

  }

}

```

Then just use this short-hand:

```js

import UserModel from 'models/user'

```

## API

```javascript

import {build, watch} from 'rolling'

const options = {

  input: ...,

  output: ...

  // more configs go here

}

build(options).catch(e => console.log(e.stack))

// or

watch(options).catch(e => console.log(e.stack))

```

## License

MIT © [EGOIST](https://github.com/egoist)