generator-new-node-module

GENERATOR-new-node-module

< Yeoman generator create scaffolding node modules />

#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 ☝️
• 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 to test/index.js.

• Lint, build and test a project with npm run build.

• Build and watch changes in src/ with npm run watch

• Run only tests with npm run test.

• Check coverage with npm run coverage.

• Generate a TOC for the CHANGELOG with npm run toc

• Deploy to a remote origin with npm run deploy.

• Bump version and publish a package with npm run major or minor/patch

#License

MIT ©