generator-nm-boilerplate

Boilerplate for scaffold out a node module

Features

• Unit test using ava
• ESLint using prettier
• CI using Travis
• License using MIT
• Dependency update automation using renovate
• Optionally add coverage report
• Optionally add CLI

Installation

Install Yeoman and generator-nm-boilerplate using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-nm-boilerplate

Usage

Generate your new project:

yo nm-boilerplate

Note that this template will generate files in the current directory, so be sure to change to a new directory first if you don't want to overwrite existing files.

That'll generate a project with all the common tools setup. This includes:

• Filled package.json file
• ava unit test and code coverage (optionally tracked on codecov)
• eslint linting and code style checking prettier
• nsp known vulnerability check
• Travis CI continuous integration
• License using MIT
• Renovate dependency update automation

Getting To Know Yeoman

• Yeoman has a heart of gold.
• Yeoman is a person with feelings and opinions, but is very easy to work with.
• Yeoman can be too opinionated at times but is easily convinced not to be.
• Feel free to learn more about Yeoman.

License

MIT © ZYSzys