Create a JS package with es6, testing, linting, and publication tools included. Generated projects include the following features:
- Unit testing with Jest, chai and sinon.
- Test watcher for continous testing.
- Test coverage checking.
- ES6 linting based on eslint and prettier.
- Release scripts and automatic changelog generation based on commit messages, following conventions defined in generate-changelog.
- Node version >= 6
Install the tool globally:
npm install -g create-js-package
Creation of a new package
Navigate to the directory where you want to scaffold the project and run the command:
mkdir my-packagecd my-package/create-js-package my-package
The generated project will have the following commands available:
Start the app:
Start the app in watch (dev) mode:
npm run start:watch
Run tests and calculate coverage:
Run tests in watch (dev) mode. This allows continuous testing while developing:
npm run test:watch
Run linter (coding standard):
npm run lint
Fix linting errors:
npm run lint:fix