Generator Node Module

A yeoman generator for creating stand-alone node modules. Converts ES2015 to UMD modules via Babel. Uses tape / faucet for testing and ESLint for linting.

All source code should live in src dir. Compiles to lib dir.

Usage

Make sure you have yo installed!

First install the module

npm install -g @mls-digital/generator-node-module

Then run yo

yo @mls-digital/node-module

Files Created

.
├── .babelrc
├── .codeclimate.yml
├── .eslintignore
├── .eslintrc
├── .gitignore
├── .npmignore
├── LICENSE.md
├── package.json
├── readme.md
└── src
    └── index.js

1 directory, 10 files

Modules Used

{
  "babel-cli": "^6.4.5",
  "babel-preset-es2015": "^6.3.13",
  "babel-plugin-transform-es2015-modules-umd": "^6.4.3",
  "babel-register": "^6.4.3",
  "eslint": "^1.10.3",
  "eslint-config-airbnb": "^3.1.0",
  "faucet": "0.0.1",
  "rimraf": "^2.5.0",
  "tape": "^4.4.0"
}

Available NPM scripts

{
  "lint": "eslint .",
  "test": "tape -r babel-register test/*.js | faucet",
  "compile": "rimraf lib && babel src --out-dir lib",
  "dev": "rimraf lib && babel src --out-dir lib -w",
  "release": "npm publish ?(--access public)"
}