Runner-generator-pug NPM

Tasks generator for Pug

Installation

npm install runner-generator-pug

Usage

Add to the scope:

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

Generate tasks according to the given config:

const tasks = generator({
    source: 'src/pug/main.pug',
    target: 'build/develop/index.html',
    variables: {
        develop: true,
        package: require('../package')
    }
});

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
`pug:config`	prints the current configuration used for generated tasks
`pug:build`	performs pug compilation
`pug:clear`	removes compiled file

Generator accepts two arguments: base configuration and additional options.

Base configuration

It's an object with the following properties:

Name	Description
source	main entry point passed as `path` to pug.compileFile
target	generated HTML file name
options	pug compiler options
variables	vars available in pug templates

Additional options

It's an object with the following properties:

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

It will add the following tasks:

html:config:develop
html:build:develop
html:clear:develop

Contribution

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

License

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

task runner generator pug

pug runner-logger runner-tools

@everything-registry/sub-chunk-2692

2.0.0

5 years ago

1.0.1

6 years ago