Scaffolder for backend code, covering testing, code coverage, doctests and linting
npm install 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
````
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:npm tasks
- eslint
- eslint-config-suddi
- husky (for pre-push hooks)
- istanbul
- jsdoctest
- mocha
- nsp (for security checks)
- ntl (for an interactive CLI for )
Additionally, the following npm tasks will also be setup and can be triggered as follows:npm run check-coverage
- .istanbul.yml
- Ensure code coverage meets code coverage standards mentioned in npm run coverage
- mocha
- Run tests with istanbul code coverage generatednpm run doctest
- jsdoctest
- Run tests with mocha, no code coverage will be generatednpm run lint
- eslint
- Run linter on projectnpm run prepush
- npm run security-check
- Run git pre-push hook, will be run automatically when pushing to remote repository
- Node Security (nsp)
- Run a security check using the modulenpm start
- Node Task List (ntl)
- Run module to create interactive menu for npm tasksnpm test`
-
- Run a compiled list of tests