Sign upLogin

tunnckoCore/start-rollup

View on GitHub
Star
README.md

Summary

Maintainability
Test Coverage
# start-rollup [![NPM version](https://img.shields.io/npm/v/start-rollup.svg?style=flat)](https://www.npmjs.com/package/start-rollup) [![NPM monthly downloads](https://img.shields.io/npm/dm/start-rollup.svg?style=flat)](https://npmjs.org/package/start-rollup) [![npm total downloads][downloads-img]][downloads-url]

> A [start][] runner task for [rollup][] through [rolldown][] api

[![code climate][codeclimate-img]][codeclimate-url] 
[![standard code style][standard-img]][standard-url] 
[![linux build status][travis-img]][travis-url] 
[![windows build status][appveyor-img]][appveyor-url] 
[![coverage status][coveralls-img]][coveralls-url] 
[![dependency status][david-img]][david-url]

You might also be interested in [always-done](https://github.com/hybridables/always-done#readme).

## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Related](#related)
- [Contributing](#contributing)
- [Building docs](#building-docs)
- [Running tests](#running-tests)
- [Author](#author)
- [License](#license)

_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_

## Install
Install with [npm](https://www.npmjs.com/)

```
$ npm install start-rollup --save-dev
```

or install using [yarn](https://yarnpkg.com)

```
$ yarn add --dev start-rollup
```

## Usage
> For more use-cases see the [tests](test.js)

```js
import start from 'start'
import reporter from 'start-pretty-reporter'
import rollup = from 'start-rollup'
import files from 'start-files'
import clean from 'start-clean'
import write from 'start-write'
import buble from 'rollup-plugin-buble'

export const build = () => start(reporter())(
  files('build/'),
  clean(),
  rollup({
    entry: './main.js',
    targets: [
      { dest: 'build/index.es6.js', format: 'es' },
      { dest: 'build/index.js', format: 'cjs' }
    ],
    sourceMap: 'inline',
    plugins: [buble()]
    // or
    // plugins: ['buble']
    // or
    // plugins: [
    //   'commonjs'
    //   ['node-resolve', { jsnext: true }]
    //   ['buble', { target: { node: '4' } }]
    //   
    //   // or pass plugin function
    //   // [buble, { target: { node: '4' } }]
    // ]
  })
)

```

This task uses Rollup but through [rolldown][] API, which gives some advantages to the original Rollup API. So checkout both docs or at least see [rollup wiki page](https://github.com/rollup/rollup/wiki/JavaScript-API).

**Rolldown gives you:**

- better plugins resolving (seems like browserify resolves its transforms from package.json)
- more configuration options - such as `options.source`, `options.ongenerate` and `options.onwrite`
- loading configs from `package.json` from your `process.cwd()`
- and even you can create presets of plugins and configs (shareable configs/presets)

## Related
- [always-done](https://www.npmjs.com/package/always-done): Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… [more](https://github.com/hybridables/always-done#readme) | [homepage](https://github.com/hybridables/always-done#readme "Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement for [async-done][] - pass 100% of its tests plus more")
- [minibase](https://www.npmjs.com/package/minibase): Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… [more](https://github.com/node-minibase/minibase#readme) | [homepage](https://github.com/node-minibase/minibase#readme "Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing [base][] plugins.")
- [start-babel](https://www.npmjs.com/package/start-babel): Babel task for Start | [homepage](https://github.com/start-runner/babel "Babel task for Start")
- [start-clean](https://www.npmjs.com/package/start-clean): Clean task for Start | [homepage](https://github.com/start-runner/clean "Clean task for Start")
- [start-files](https://www.npmjs.com/package/start-files): Files task for Start | [homepage](https://github.com/start-runner/files "Files task for Start")
- [start-pretty-reporter](https://www.npmjs.com/package/start-pretty-reporter): Pretty reporter for Start | [homepage](https://github.com/start-runner/pretty-reporter "Pretty reporter for Start")
- [start-write](https://www.npmjs.com/package/start-write): Write task for Start | [homepage](https://github.com/start-runner/write "Write task for Start")
- [start](https://www.npmjs.com/package/start): Highly composable and modular Nodejs tasks runner for the new functional JS era | [homepage](https://github.com/start-runner/start "Highly composable and modular Nodejs tasks runner for the new functional JS era")
- [try-catch-core](https://www.npmjs.com/package/try-catch-core): Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and… [more](https://github.com/hybridables/try-catch-core#readme) | [homepage](https://github.com/hybridables/try-catch-core#readme "Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and used in higher-level libs such as [always-done][] to handle completion of anything.")

## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/start-rollup/issues/new).  
Please read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards.  
If you need some help and can spent some cash, feel free to [contact me at CodeMentor.io](https://www.codementor.io/tunnckocore?utm_source=github&utm_medium=button&utm_term=tunnckocore&utm_campaign=github) too.

**In short:** If you want to contribute to that project, please follow these things

1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See ["Building docs"](#building-docs) section.
2. Ensure anything is okey by installing the dependencies and run the tests. See ["Running tests"](#running-tests) section.
3. Always use `npm run commit` to commit changes instead of `git commit`, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.
4. Do NOT bump the version in package.json. For that we use `npm run release`, which is [standard-version][] and follows Conventional Changelog idealogy.

Thanks a lot! :)

## Building docs
Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run `verb` command like that

```
$ npm install verbose/verb#dev verb-generate-readme --global && verb
```

_Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._

## Running tests
Clone repository and run the following in that cloned directory

```
$ npm install && npm test
```

## Author
**Charlike Mike Reagent**

+ [github/tunnckoCore](https://github.com/tunnckoCore)
+ [twitter/tunnckoCore](http://twitter.com/tunnckoCore)
+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)

## License
Copyright © 2016-2017, [Charlike Mike Reagent](http://i.am.charlike.online). Released under the [MIT license](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.3, on January 03, 2017._  
_Project scaffolded using [charlike][] cli._

[always-done]: https://github.com/hybridables/always-done
[async-done]: https://github.com/gulpjs/async-done
[base]: https://github.com/node-base/base
[charlike]: https://github.com/tunnckocore/charlike
[commitizen]: https://github.com/commitizen/cz-cli
[dezalgo]: https://github.com/npm/dezalgo
[once]: https://github.com/isaacs/once
[rollup]: https://github.com/rollup/rollup
[standard-version]: https://github.com/conventional-changelog/standard-version
[start]: https://github.com/start-runner/start
[verb-generate-readme]: https://github.com/verbose/verb-generate-readme
[verb]: https://github.com/verbose/verb

[downloads-url]: https://www.npmjs.com/package/start-rollup
[downloads-img]: https://img.shields.io/npm/dt/start-rollup.svg

[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/start-rollup
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/start-rollup.svg

[travis-url]: https://travis-ci.org/tunnckoCore/start-rollup
[travis-img]: https://img.shields.io/travis/tunnckoCore/start-rollup/master.svg?label=linux

[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/start-rollup
[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/start-rollup/master.svg?label=windows

[coveralls-url]: https://coveralls.io/r/tunnckoCore/start-rollup
[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/start-rollup.svg

[david-url]: https://david-dm.org/tunnckoCore/start-rollup
[david-img]: https://img.shields.io/david/tunnckoCore/start-rollup.svg

[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

[rolldown]: https://github.com/rolldown/rolldown