gulp-hogan-compile

A gulp plugin to compile mustache HTML templates to JavaScript functions using hogan.

Usage

In templates/test.html:

<p>Hello {{place}}</p>

In your gulpfile:

var compiler = require('gulp-hogan-compile');

gulp.task('templates', function() {
    gulp.src('templates/**/*.html')
        .pipe(compiler('templates.js'));
        .pipe(gulp.dest('js/'));
});

In your code:

    var templates = require('js/templates.js');
    var html = templates.test.render({
        place: 'world';
    })
    console.log(html); // <p>Hello world</p>

This will compile the templates into a JavaScript AMD module using hogan.compile.

It uses the hogan-updated module. This works with the latest version of hogan for bower (currently the npm version of hogan is ~2.0.0, but bower is around ~3.0.0).

It will require('hogan') so that module needs to be available, for example by installing it with bower. You can change the name/path of the hogan module at compile time with options.hoganModule.

Parameters

• file string
  • The name of the file to use for the compiled templates
• options object
  • Options passed to the hogan task

Options

newLine string

The line delimiter, defaults to your operating system's newline.

wrapper string

Either amd, commonjs or false for no wrapper, defaults to amd. If wrapper is false a local var templates will be defined containing the templates.

templateOptions object

Options passed through to hogan.compile. It will always set asString to true, so you can't override that.

templateName function(file)

A function that will be passed the file and should return a name for the template. By default uses the basename of the file without an extension.

hoganModule string

The name of the hogan module in your app, defaults to hogan. If you're not using a wrapper then the global Hogan must be available.