module-template

A template for Node.js modules

Stability: 1 - Experimental

basics

• .eslintrc & .eslintignore - style rules closely follow google's javascript style guide
• .gitignore & .npmignore
• MIT LICENSE
• a index.js pointing to lib/
• plus a .travis.yml

package.json scripts

• npm test - eslint, istanbul + nyc and mocha
• npm install - will add a pre-commit hook which runs npm test (existing hooks will be overwritten)
• npm run lint - eslint
• npm run log - generate a markdown formatted changelog
• npm run clean - rm coverage/, node_modules, npm-debug.log, .nyc_output

Download

Tests

npm test
firefox coverage/lcov-report/index.html

Coverage

Statements   : XX.XX% ( YY/ZZ )
Branches     : XX.XX% ( YY/ZZ )
Functions    : XX.XX% ( YY/ZZ )
Lines        : XX.XX% ( YY/ZZ )