dazzling-task
Customizable task manager toolkit
Install
$ npm install --save dazzling-task
Usage
; //Define a list of supported commands.const commands = readData: description: 'Reads the configuration' { //... /* params.task: the task name (readData), command: the command name (readData), tags: an array of tags which could be used by function, keys: an array of paths which are used to read the data, data: an array of data based on the keys, general: the general configuration. */ } beautify: description: 'Beautify json' { //... } ; /*Define a script. In practice, the script will be loaded from an external file. In other words, you should be able to have many scripts using a same list of commands.*/const script = tasks: metadata: c: 'readData' t: 'tag1''tag2' k: 'metadata' c: 'beautify' license: c: 'readData' t: 'license-tag' k: 'metadata.license' author: c: 'readData' t: 'tag3' k: 'metadata.author' jobs: go: 'metadata' 'license' 'author' data: metadata: author: 'aradhna' license: 'MIT' ;const jobs = ; jobs;
Development 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 © Olivier Huin