NodeJS module generator/boilerplate.
- ESLint - Make sure you are writing a quality code;
- Travis CI - Automate tests and linting for every push or pull request;
- Documentation - A documentation system so good, you'll actually write documentation.
The easiest way to use nod is through the Yeoman Generator.
$ npm install -g yo generator-nod $ yo nod
If you don't want to use the generator, you can also download or
git clone this repo
$ git clone https://github.com/diegohaz/nod my-module $ cd my-module $ rm -rf .git $ npm install # or yarn
Just make sure to edit
LICENSE files accordingly with your module's info.
$ npm test # run tests with Jest $ npm run coverage # run tests with coverage and open on browser $ npm run lint # lint code $ npm run docs # generate docs $ npm run build # transpile code to ES5 $ npm run patch # bump patch version and publish to npm e.g. 0.0.1 $ npm run minor # bump minor version and publish to npm e.g. 0.1.0 $ npm run major # bump major version and publish to npm e.g. 1.0.0
MIT © Diego Haz