grunt-handlebarsify

Precompile Handlebars templates for use with browserify.

npm install grunt-handlebarsify
3 downloads in the last week
25 downloads in the last month

grunt-handlebarsify

Precompile handlebars templates for Node.js and Browserify.

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-handlebarsify --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-handlebarsify');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.3.

Handlebarsify task

_Run this task with the grunt handlebarsify command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Options

makePartials

Type: Boolean Default: false

Determines whether or not each template is registered as a partial.

wrapped

Type: Boolean Default: true

Determine if preprocessed template functions will be wrapped in Handlebars.template function.

processName

Type: 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(filePath) {
    return filePath.toUpperCase();
  }
}

processPartialName

Type: 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}}.

compilerOptions

Type Object Default: {}

This option allows you to specify a hash of options which will be passed directly to the Handlebars compiler.

options: {
  compilerOptions: {
    knownHelpers: {
      "my-helper": true,
      "another-helper": true
    },
    knownHelpersOnly: true
  }
}

Usage Examples

handlebarsify: {
  compile: {
    options: {
      wrapped: false,
      compilerOptions: {
        knownHelpersOnly: false
      }
    },
    files: {
      "path/to/result.js": "path/to/source.hbs",
      "path/to/another.js": ["path/to/sources/*.hbs", "path/to/more/*.hbs"]
    }
  }
}
npm loves you