Gulp-dust-compile-render NPM

gulp-dust-compile-render

A gulp task to compile and render dust templates based on a provided context object.

Usage

This gulp task expects a dust template as input, a context object provided as an option, and outputs the rendered dust template.

As a gulp task

Require this package and use as part of your gulp task.

var GulpDustCompileRender = require('gulp-dust-compile-render');
gulp.src('local.dust')
.pipe(new GulpDustCompileRender())
.pipe(fs.createWriteStream('output.js'));

API

gulp-dust-compile-render ⇒ through2

A gulp task to compile and render dust templates based on a provided context object. Returns: through2 - readable-stream/transform

Param	Type	Default	Description
context	Object		Context object containing properties referenced in dust templates. NOTE: the context object will be set upon instantiating the function. Pass an object as the context and add properties to the object post instantiating the function but prior to executing the gulp pipe.
opts	Object		Task configuration options
opts.partialsGlob	string	"''"	A glob pattern for the dust templates to be loaded as partials that can be referenced in dust templates
opts.preserveWhitespace	boolean	true	Preserve whitespace in output
opts.ignoreUndefinedTags	boolean	false	Ignore dust tags undefined in the context object. Does not work with paths e.g. obj.subobj
opts.helper	String	''	A dustjs helper package to load. To load the dustjs helpers pass 'dustjs-helpers'. Note only 'dustjs-helpers' is loaded as a dependency of this package.

Example
Given the dust file:

//jshint ignore:start
var author = "{author}";
var name = "{name}";
var description = "{description}";
var version = "{version}";

When you pass the dust file to a new GulpDustCompileRender() using 'package.json' as context, and pipe it to a given destination. NOTE: the context object will be set upon instantiating the function. In the example below new GulpDustCompileRender(context) is compiled before the gulp pipe executes. If you change the context itself during the gulp pipe it will not be seen by GulpDustCompileRender. To workaround this behaviour you can pass an object as the context and add/change properties of the object post instantiating the function but prior to executing the gulp pipe.

var GulpDustCompileRender = require('gulp-dust-compile-render');
var context = JSON.parse(fs.readFileSync('package.json'));
gulp.src('local.dust')
.pipe(new GulpDustCompileRender(context))
.pipe(fs.createWriteStream('output.js'));

Then you'll get a compiled and rendered dust file:

//jshint ignore:start
var author = "John Barry";
var name = "gulp-dust-compile-render";
var description = "A gulp task to compile and render dust templates based on a provided context object.";
var version = "0.2.9";

documented by jsdoc-to-markdown.