!License

Description

A modern task runner pipeline framework.
Allows your Tasks to be Modular, Extendable, Flexible, Manageable, and Fire Resistant!

Features

1. Tasks are based on Promises, support:
* Generator (Example)
* Using co wrapping
* Async/Await (Example)
* Streams (Example)
* Compatible with your existing gulp tasks
2. ES6 Class base class
* Extending from other Tasks (Example)
3. Sub Tasks
* Static - simply by adding another task class to a tasks sub class. (Example)
* Dynamic - create sub tasks based on configuration (Example)
4. Run other tasks in an task
* Parallel (Example)
* Sequence (Example)
5. Before and After (Simple Example, Adv Example)
* each task
* all tasks
6. Decorators
* Setting Default Task (Example)
* Help Docs (Example)
* Vars Definitions (for help and set defaults) (Example)
7. Auto Help Docs (ALI Example, CLI Example)
8. Passing Options (Vars) to a task or globally (ALI Example, CLI Example)
9. CLI (Examples) and full Javascript API (Examples)
10. Totally bad *ss logo!

-------

Install

API

``shell
$ npm install beelzebub
`

CLI

`shell
$ npm install beelzebub -g
`

-------

DOCS

$3

-------

API

$3

Simple Example

`javascript
const Beelzebub = require('beelzebub');

class MyTasks extends Beelzebub.Tasks {
task1() {
this.logger.log('MyTasks task1');
}
}

// Add Task to BZ, it will now be registered
Beelzebub.add( MyTasks );

// ------------------------------------
// Runs the task, returning a promise
Beelzebub.run('MyTasks.task1');
`

-------


CLI

$3

Reserved Global Flags

* --help or -h
* Prints Usage, List of Task Help Docs and Vars Definitions
* --version or -v
* Prints Beelzebub version
* --file= or -f=
* Uses this file instead of the beelzebub.js or beelzebub.json file

Passing Vars

The CLI uses yargs and thus the vars parsing is handled by yargs-parser.

`shell
$ bz TaskPath AnotherTaskPath
`

--------


Simple Example

$3

`javascript
const Beelzebub = require('beelzebub');

class MyTasks extends Beelzebub.Tasks {
task() {
this.logger.log('MyTasks task');
}
}

module.exports = MyTasks;
`

`shell
$ bz MyTasks.task
`


--------


Vars Example

$3


`javascript
const Beelzebub = require('beelzebub');

class MyTasks1 extends Beelzebub.Tasks {
default(aVars) {
const gVars = this.$getGlobalVars();
this.logger.log(MyTasks1 default ${gVars.myGlobalVar} ${aVars.v1});
}
}

class MyTasks2 extends Beelzebub.Tasks {
task(aVars) {
const gVars = this.$getGlobalVars();
this.logger.log(MyTasks1 task ${gVars.myGlobalVar} ${aVars.v1});
}
}

module.exports = [MyTasks1, MyTasks2];
`

`shell
$ bz --myGlobalVar=hello MyTasks1 --v1=1 MyTasks2.task --v1=2
`

--------


Load File Example

$3


`javascript
module.exports = [
require('bz-frontend-react'),
require('bz-frontend-babel'),
require('./mytask.js')
];
`

`shell
$ bz --file=./appTasks.js MyTasks.task1
``

--------

Special Thanks

To everyone supporting the development and cost to the project.
I would also like to thank the logo artist Irving Gerardo!!!

--------

License

It should be an obvious choice or you totally missed the badge at the top.

However for completeness;

"I Beelzebub, declare myself to be under the MIT licence"