What is it?

A modern template for node modules with lint (ESlint), tests (Mocha and Chai), code coverage (NYC and codecov.io), type checking by JSDocs (TypeScript), CI (TravisCI), semver (semantic-release) and interoperability between ES6 modules and CommonJs and more.

How to use it?

• clone the repo and remove the .git folder

$ git clone git@github.com:MauroJr/node-module-boilerplate.git my-new-module-name
$ cd my-new-module-name
$ rm -rf .git

• open the package.json file with your editor and edit the following fields (name, description, repository, author, license and keywords).
• Edit the README.md file, it's allways good starting here ;)
• initialize your git repository

$ vim package.json
$ vim README.md
$ git init

• Install all dev dependecies
• Setup your credentials with semantic-release-cli. See setup documentation for semantic-release-cli.

$ yarn
$ semantic-release-cli setup

• Now you are ready to starting to code.

$ vim src/index.js

• And you must do your commits by the following command:

$ yarn run commit

Do you want more information?

$ yarn run info