📃 Boilerplate for npm/node module. Write with ES6 - have compatibility with all node versions.
This boilerplate is for people who want write code using all ES6 features ( and stage-2 ) but also want/need backwards compatibility with old node versions.
- Build with Babel. (ES6 -> ES5)
- Test with mocha.
- Cover with istanbul.
- Check with eslint.
- Deploy with Travis.
-
npm run clean
- Removelib/
directory -
npm test
- Run tests. Tests can be written with ES6 (WOW!) -
npm test:watch
- You can even re-run tests on file changes! -
npm run cover
- Yes. You can even cover ES6 code. -
npm run lint
- We recommend using airbnb-config. It's fantastic. -
npm run test:examples
- We recommend writing examples on pure JS for better understanding module usage. -
npm run build
- Do some magic with ES6 to create ES5 code. -
npm run prepublish
- Hook for npm. Do all the checks before publishing you module.
Just clone this repo and remove .git
folder.