Tasks generator for LiveReload

Installation

npm install @runner/generator-livereload

Usage

Add to the scope:

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

Generate tasks according to the given config:

var tasks = generator({
    watch: [
        'build/develop/**/*',
        '!build/develop/**/*.map'
    ]
});

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 ---------------------|------------- livereload:config | prints the current configuration used for generated tasks livereload:start | starts file changes monitoring, sends reload command on modifications livereload:stop | stops watcher and server

Generator accepts two arguments: base configuration and additional options.

Base configuration

It's an object with the following properties:

Name | Description --------------|------------- port | livereload server port (default: 35729) watch | file, dir, glob, or array passed to watch in chokidar watchOptions | optional watcher options

Additional options

It's an object with the following properties:

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

It will add the following tasks:

• lr:config:develop
• lr:start:develop
• lr:stop:develop

Contribution

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

License

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