npm-base

Boilerplate for creating npm packages with ES2015. Written with Meteor developers in mind but great for anyone. Based on Arunoda's original npm-base boilerplate, this was initially forked to add the babel watch command and use the AirBnB style guide for linting.

Writing in ES2015 is an amazing experience. Setting up babel and the development environment in a kind of a pain.

If you want to write a npm module in ES2015 and publish to npm with backward compatibility, this is the easiest way.

Basic Usage

Simply clone this project.
Change the package.json as you want.
lib/index.js in your entry point.
npm start will initiate the babel watch command and automatically transpile your code on save.
Then publish to npm via npm publish.

Linting

ESLINT support is added to the project.
It's configured for ES2015 and inherited configurations from graphql/graphql-js.
Use npm run lint to lint your code and npm run lintfix to fix common issues.

Testing

You can write test under __test__ directory anywhere inside lib including sub-directories.
Then run npm test to test your code. (It'll lint your code as well).
You can also run npm run testonly to run tests without linting.

ES2015 Setup

ES2015 support is added with babel6.
After you publish your project to npm, it can be run on older node versions and browsers without the support of Babel.
This project uses ES2015 and some of the upcoming features like async await.
You can change them with adding and removing presets.
All the polyfills you use are taken from the local babel-runtime package. So, this package won't add any global polyfills and pollute the global namespace.

Kudos