Babel Starter Kit

The starter kit for writing next generation JavaScript Libraries.

Features

Babel (for transpiling ES6)
Mocha & Chai (for test suites and assertions)
Eslint w/ Airbnb config (for cleaner code)
TravisCI, Coveralls, and CodeClimate configs
Initial files and unit tests
Npm scripts for linting, testing, and building

Installation

Git

$ git clone https://github.com/nathanchapman/babel-starter-kit.git

Rename the directory, update project info in package.json, and run npm install.

Bower

$ bower install babel-starter-kit

Move the directory from bower_components/babel-starter-kit to your workspace, update project info in package.json, and run npm install.

Npm

$ npm install babel-starter-kit

Move the directory from node_modules/babel-starter-kit/babel-starter-kit to your workspace, update project info in package.json, and run npm install.

Scripts

npm start runs src/example.js in the babel-node environment

npm run build compiles your library to lib/ for publishing

npm run lint runs your code in src/ through eslint with the Airbnb preset

npm run test runs your unit tests in test/ with Mocha

npm run test:watch same as npm run test script but watches for changes to your files and waits in a REPL

npm run test:cover runs your unit tests with code coverage and outputs to coverage/

npm run coveralls is only used by Travis CI to publish coverage reports to coveralls

Additional Features

All of the features listed below are free for open source projects.

Travis CI

Travis CI is a continuous integration build system. You push changes to your repo, it makes sure those changes didn't break anything. To further improve this feedback, you want to strive for the highest amount of code coverage possible, which just means writing quality unit tests. Travis runs builds on all branches, which is great for pull requests and feature branches. Included is a .travis.yml file which instructs Travis to lint your code, run unit tests in several different Node.js environments, and report the coverage back to Coveralls. We've provided the configs, just head over to travis-ci.org to add your repo.

Coveralls

Coveralls is just a web service to help you track your code coverage over time. This integrates nicely with Greenkeeper, which we'll talk about next.

Greenkeeper

Greenkeeper is an automated dependency management service. It keeps your dependencies up to date by automatically creating pull requests. Because you have Travis CI and Coveralls set up, you'll now see information about the builds and code coverage on your pull requests. This will prevent dependency updates from breaking your builds and Greenkeeper will provide suggestions on how to fix these issues. Manually updating your dependencies or using explicit dependency versions are no longer necessary. See PR #1 for a good example. To setup Greenkeeper, run the following from the project folder:

$ npm install -g greenkeeper
$ greenkeeper login
$ greenkeeper enable

CodeClimate

CodeClimate provides analytics about your code and grades each file along with suggestions for improving. We've provided the configs, just head over to codeclimate.com to add your repo.

License

MIT. See LICENSE