runner-generator-static

Tasks generator for static server

Installation

npm install runner-generator-static

Usage

Add to the scope:

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

Generate tasks according to the given config:

const tasks = generator({
    open: 'build/develop/index.html',
    onReady: function ( config ) {
        console.log(config);
    }
});

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
static:config	prints the current configuration used for generated tasks
static:start	starts static server
static:stop	stops static server
static:open	open entry page in the default browser

Generator accepts two arguments: base configuration and additional options.

Base configuration

It's an object with the following properties:

Name	Description
path	root directory to serve (default: .)
open	entry page to open in the default browser
port	HTTP server listening port (default: 8080)
onReady	user callback on static server start
staticOptions	static server options

Additional options

It's an object with the following properties:

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

It will add the following tasks:

• http:config:develop
• http:start:develop
• http:stop:develop
• http:open:develop

Contribution

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

License

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