My template for node modules with lint, tests, code coverage, type checking, CI, semantic release and interoperability between ES6 modules and CommonJs.
npm install node-module-boilerplate
![Codecov]()
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.
* clone the repo and remove the .git folder
``Shell`
$ git clone git@github.com:MauroJr/node-module-boilerplate.git my-new-module-name
$ cd my-new-module-name
$ rm -rf .git
* open the file with your editor and edit the following fields (name, description, repository, author, license and keywords).README.md
* Edit the file, it's allways good starting here ;)`
* initialize your git repositoryShell`
$ vim package.json
$ vim README.md
$ git init
* Install all
* Setup your credentials with semantic-release-cli. See setup documentation for semantic-release-cli.Shell`
$ yarn
$ semantic-release-cli setup
* Now you are ready to starting to code.Shell`
$ vim src/index.js
* And you must do your commits by the following command:Shell`
$ yarn run commit
`Shell``
$ yarn run info