alexeychirkov / grunt-contrib-handlebars

Precompile Handlebars templates to JST file.

grunt-contrib-handlebars

Precompile Handlebars templates to JST file.

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-contrib-handlebars

Then add this line to your project's grunt.js gruntfile:

grunt.loadNpmTasks('grunt-contrib-handlebars');

Overview

Inside your grunt.js file, add a section named handlebars. This section specifies the files to compile and the options used with handlebars.

files object

This defines what files this task will process and should contain key:value pairs.

The key (destination) should be an unique filepath (supports grunt.template) and the value (source) should be a filepath or an array of filepaths (supports minimatch).

Note: Values are precompiled to the namespaced JST array in the order passed.

options object

This controls how this task operates and should contain key:value pairs, see options below.

Options

namespace string

The namespace in which the precompiled templates will be assigned (default is JST). Use dot notation (e.g. App.Templates) for nested namespaces.

Example:

options: {
  namespace: 'MyApp.Templates'
}

wrapped boolean

Determine if preprocessed template functions will be wrapped in Handlebars.template function (default is false).

processName function

This option accepts a function which takes one argument (the template filepath) and returns a string which will be used as the key for the precompiled template object. The example below stores all templates on the default JST namespace in capital letters.

options: {
  processName: function(filename) {
    return filename.toUpperCase();
  }
}

processPartialName function

This option accepts a function which takes one argument (the partial filepath) and returns a string which will be used as the key for the precompiled partial object when it is registered in Handlebars.partials. The example below stores all partials using only the actual filename instead of the full path.

options: {
  processPartialName: function(filePath) { // input:  templates/_header.hbs
    var pieces = filePath.split("/");
    return pieces[pieces.length - 1];      // output: _header.hbs
  }
}

Note: If processPartialName is not provided as an option the default assumes that partials will be stored by stripping trailing underscore characters and filename extensions. For example, the path templates/_header.hbs will become header and can be referenced in other templates as {{> header}}.

partialRegex regex

This option accepts a regex that defines the prefix character that is used to identify Handlebars partial files. (The default is _).

options: {
  partialRegex: /^par_/ // assumes partial files would be prefixed with "par_" ie: "par_header.hbs"
}

Config Example

handlebars: {
  compile: {
    options: {
      namespace: "JST"
    },
    files: {
      "path/to/result.js": "path/to/source.hbs",
      "path/to/another.js": ["path/to/sources/*.hbs", "path/to/more/*.hbs"]
    }
  }
}

--

Task submitted by Tim Branyen.