buba/README.md

Buble + little bit of babel for your esnext tests

# buba
> Bublé transform + a little bit of Babel

[![Build Status](https://travis-ci.org/davidchase/buba.svg?branch=master)](https://travis-ci.org/davidchase/buba) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
[![npm version](https://img.shields.io/npm/v/buba.svg)](https://www.npmjs.com/package/buba)
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/b3b512a5e0854a98bea75538647e84c4)](https://www.codacy.com/app/davidchase/buba?utm_source=github.com&utm_medium=referral&utm_content=davidchase/buba&utm_campaign=Badge_Coverage)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

## Why?
Because a wise man once said your source code should be transpiled with same tool as your tests to avoid any hidden bugs.

The usecase would be transpiling es* source code with Bublé and have tests match as well. An alternative to using `babel-register`

The primary transformer here is [Bublé](https://buble.surge.sh/#) we only use [Babel](https://babeljs.io) for support with module import/exports.


## Install

```sh
npm install buba --save-dev
```

## Usage

### Source code

**CLI**
```sh
buba -i input.js -o output.js
# or with a directory
buba -i src/ -o lib/
# to enable sourceMaps
buba -i input.js -o output.js -s
```

**API Usage**
```js
import { transformFile } from 'buba'

const { code, map } = transformFile('input.js', {
  buble: {} // buble options
  babel: {} // babel options
})
```

### Tests
```sh
mocha --require buba/register tests/**/*.js
# or
tape --require buba/register tests/**/*.js
```

With `mocha` you can also provide buba within the `mocha.opts` config file:

```sh
 --require buba/register
 --reporter spec
 --ui bdd
```

Currently we only plan to use Babel for modules but you can add support for something like generators by adding a `.babelrc` file.

**API Usage**

Just make sure that `buba` is the 1st thing you require

```js
require('buba/register')
const prelude = require('./prelude') // prelude has import/export, arrow functions, etc
```


## Todo
- [x] Add Tests
- [x] Add Bublé options
- [x] Add CLI supoort - thanks [@TylorS](https://github.com/TylorS)