generator-backend-scaffolder



Yeoman backend scaffolder for Node.js modules.

generator-backend-scaffolder will establish the following:
- editor configuration (with editorconfig)
- git (with gitignore)
- linting (with eslint and eslint-config-suddi)
- testing (with mocha)
- doctest (with jsdoctest)
- code coverage (with istanbul and codecov)
- CI (either TravisCI, CircleCI or none)
- dependency management (with David-DM)
- licensing (with generator-license)
- Supported licenses:
- Apache 2 License
- MIT License
- FreeBSD License
- NewBSD License
- ISC License
- No License
- Unlicense

```
npm install -g generator-backend-scaffolder
``

Usage

``
yo backend-scaffolder
``

Once run, generator-backend-scaffolder will generate the following file structure:

``
.
├── test
│ └── options
│ ├── default.opts
│ └── doctest.opts
├── .editorconfig
├── .eslintignore
├── .gitignore
├── .istanbul.yml
├── .travis.yml (if "TravisCI" option is chosen)
├── circle.yml (if "CircleCI" option is chosen)
├── README.md
└── package.json
``

No dependencies will be installed, the following devDependencies will be installed:
- eslint
- eslint-config-suddi
- husky (for pre-push hooks)
- istanbul
- jsdoctest
- mocha
- nsp (for security checks)
- ntl (for an interactive CLI for npm tasks)

Additionally, the following npm tasks will also be setup and can be triggered as follows:
- npm run check-coverage
- Ensure code coverage meets code coverage standards mentioned in .istanbul.yml
- npm run coverage
- Run mocha tests with istanbul code coverage generated
- npm run doctest
- Run jsdoctest tests with mocha, no code coverage will be generated
- npm run lint
- Run eslint linter on project
- npm run prepush
- Run git pre-push hook, will be run automatically when pushing to remote repository
- npm run security-check
- Run a security check using the Node Security (nsp) module
- npm start
- Run Node Task List (ntl) module to create interactive menu for npm tasks
- npm test`
- Run a compiled list of tests