runner-generator-repl

Tasks generator for REPL

Installation

npm install runner-generator-repl

Usage

Add to the scope:

const generator = require('runner-generator-repl');

Generate tasks according to the given config:

const tasks = generator({
    runner: runnerInstance,
    readline: {
        historySize: 200
    }
});

Add generated tasks to the runner instance:

const runner = require('runner');

Object.assign(runner.tasks, tasks);

The following tasks will become available:

Task name	Description
repl:config	prints the current configuration used for generated tasks
repl:start	starts repl server
repl:stop	stops repl server

Generator accepts two arguments: base configuration and additional options.

Base configuration

It's an object with the following properties:

Name	Description
runner	existing runner instance
readline	options passed to the readline.createInterface method

Additional options

It's an object with the following properties:

Name	Description
prefix	an affix placed before a task name (default is repl:)
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: 'readline:',
        suffix: ':develop'
    })
);

It will add the following tasks:

• readline:config:develop
• readline:start:develop
• readline:stop:develop

Contribution

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

License

runner-generator-repl is released under the GPL-3.0 License.