1.0.0 • Published 6 years ago

@runner/generator-repl v1.0.0

Weekly downloads
1
License
GPL-3.0
Repository
github
Last release
6 years ago

Tasks generator for REPL

build status npm version dependencies status devDependencies status Gitter RunKit

Installation

npm install @runner/generator-repl

Usage

Add to the scope:

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

Generate tasks according to the given config:

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

Add generated tasks to the runner instance:

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

Object.assign(runner.tasks, tasks);

The following tasks will become available:

Task nameDescription
repl:configprints the current configuration used for generated tasks
repl:startstarts repl server
repl:stopstops repl server

Generator accepts two arguments: base configuration and additional options.

Base configuration

It's an object with the following properties:

NameDescription
runnerexisting runner instance
readlineoptions passed to the readline.createInterface method

Additional options

It's an object with the following properties:

NameDescription
prefixan affix placed before a task name (default is repl:)
suffixa 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.