generator-new-node-module
v1.0.3
Published
Node module scaffolding template [ES6+, Babel, Tape, Istanbul, Coveralls, Travis, Husky, Airbnb codestyle]
Downloads
5
Maintainers
Readme
#Install
Install generator-nodeModule from npm, run:
$ npm install -g yo
$ npm install -g generator-new-node-module
Finally initiate the generator:
$ yo new-node-module
#Features
- Babel :point_up:
- Lint with ESLint
- Tests with tape in ES6
- Travis CI and Coveralls
- Airbnb CodeStyle
- Husky before commit/push
- Productivity scripts and source watcher
- Check
package
dependencies - Automatic TOC with tocdoc
#Usage
You need Yeoman to run this command.
yo new-node-module
→ create package.json
→ create README.md
→ create LICENSE
→ create CHANGELOG.md
→ create src/index.js
→ create test/index.js
→ create .editorconfig
→ create .gitignore
→ create .travis.yml
→ create .eslintrc
#Workflow
Add code to
src/index.js
and tests totest/index.js
.Lint, build and test a project with
npm run build
.Build and watch changes in
src/
withnpm run watch
Run only tests with
npm run test
.Check coverage with
npm run coverage
.Generate a TOC for the
CHANGELOG
withnpm run toc
Deploy to a remote origin with
npm run deploy
.Bump version and publish a package with
npm run major
orminor/patch
#License
MIT ©