@runner/generator-notify

Tasks generator for notification

Installation

npm install @runner/generator-notify

Usage

Add to the scope:

var generator = require('@runner/generator-notify');

Generate tasks according to the given config:

var tasks = generator({
    warn: true,
    fail: true
});

Add generated tasks to the runner instance:

var runner = require('@runner/core');

Object.assign(runner.tasks, tasks);

The following tasks will become available:

Task name	Description
notify:config	prints the current configuration used for generated tasks
notify:start	starts showing system popup notification or warnings/errors
notify:stop	stops popup notifications

Generator accepts two arguments: base configuration and additional options.

Base configuration

It's an object with the following properties:

Name	Description
warn	notify on warnings (default: false)
fail	notify on errors (default: true)

Additional options

It's an object with the following properties:

Name	Description
prefix	an affix placed before a task name (default is notify:)
suffix	a string added at the end of a task name (empty by default)

So it's possible to change generated tasks names:

Object.assign(runner.tasks,
    generator(config, {
        prefix: 'popup:',
        suffix: ':develop'
    })
);

It will add the following tasks:

• popup:config:develop
• popup:start:develop
• popup:stop:develop

Contribution

If you have any problems or suggestions please open an issue according to the contribution rules.

License

@runner/generator-notify is released under the GPL-3.0 License.