npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

beelzebub

v1.0.4

Published

One Hell of a Task Master!

Downloads

432

Readme

Build Status Coverage Status License Dependency Status devDependency Status

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:
  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
  5. Before and After (Simple Example, Adv Example)
    • each task
    • all tasks
  6. Decorators
  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

$ npm install beelzebub

CLI

$ npm install beelzebub -g

DOCS

Task Class


API

Examples

Simple Example

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

Examples

Reserved Global Flags

  • --help or -h
    • Prints Usage, List of Task Help Docs and Vars Definitions
  • --version or -v
    • Prints Beelzebub version
  • --file=<file path> or -f=<file path>
    • 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.

$ bz <global vars> TaskPath <vars to pass to this Task> AnotherTaskPath <vars will only pass to the preceding Task> 

Simple Example

beelzebub.js file

const Beelzebub = require('beelzebub');

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

module.exports = MyTasks;
$ bz MyTasks.task

Vars Example

beelzebub.js file

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];
$ bz --myGlobalVar=hello MyTasks1 --v1=1 MyTasks2.task --v1=2

Load File Example

appTasks.js file

module.exports = [
  require('bz-frontend-react'),
  require('bz-frontend-babel'),
  require('./mytask.js')
];
$ 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"