generator-node-module-boilerplate

NodeJS module boilerplate

Installation

First, install Yeoman and generator-node-module-boilerplate using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-node-module-boilerplate

Then generate your new project:

yo node-module-boilerplate

Features

Including

• .gitignore
• .eslintrc (airbnb)
• .npmignore
• .codeclimate.yml
• .travis.yml
• .editorconfig
• nodemon
• git-pre-push (run test)
• git-pre-commit (run lint)
• git-post-commit (run git status)

Usage

Scripts

• Development

    npm run dev
  
  

  run nodemon and tests (importing from src/)

• Coverage

    npm run coverage
  
  

  run istanbul coverage and put result in coverage/

• Code Climate

    npm run climate-coverage
  
  

  run coverage and send it to code-climate (you need to set CODECLIMATE_REPO_TOKEN as an enviroment variable)

• Code Climate dotenv

    npm run climate-coverage-dotenv
  
  

  run coverage and send it to code-climate (you need to set CODECLIMATE_REPO_TOKEN in .env file)

• Start

    npm start
  
  

  run node src/index.js

• Dependencies Vulnerabilities

    npm run check-dependencies
  
  

  check dependencies vulnerabilities using nsp

• Post install

    npm run postinstall
  
  

  call check-dependencies, this is will be called after every package installation

• Linter

    npm run lint
  
  

  run eslint src according .eslintrc file

• Tests

    npm test
  
  

  run mocha

License

MIT © Marcos Rava