node package manager


compiles any and all templates into ready to use includes


Compile any and all templates into a ready to use script include.

Install this grunt plugin next to your project's Gruntfile.js with: npm install grunt-template-client

Note: as of version 0.3.0 this plugin requires grunt 0.4. Install version 0.2.1 for grunt 0.3 support.

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


given the following config and template

  templateclient: {
    dist: {
        options: {
            variable: 'window.tmpl',
            prefix: 'Hogan.compile(',
            suffix: ')'
        src: ['templates/**/*.hogan'],
        dest: 'dist/tmpl.js' 
<ul id="a-list">

will output the following script file

(function compileTemplates() {
  tmpl.list=Hogan.compile('<ul id="a-list">{{#items}}{{>item}}{{/items}}</ul>');

ready to use/include/concat etc in your app like this.

tmpl.list.render({ items: [] });

Type: String Default value: tmpl

The var attached to window that'll contain the compiled templates.

Type: String Default value: Hogan.compile(

Code to output before each template content.

Type: String Default value: )

Code to output after each template content.

Type: Function Default value: Template file name without extension

Function returning String to use as the key for accessing the compiled template in options.variable. Passed the template file path as first param. Default is as follows:

function(filepath) {
  return path.basename(filepath, path.extname(filepath));

Type: Function Default value: Function returning the template contents

Function that generates a String that is used as the template value. By default this simply returns the template contents, but it could be used to return a compiled template. For example:

    templateclient: {
      dist: {
        options: {
          prefix: 'new Hogan.Template(',
          suffix: ')',
          val: function (tpl) {
            return Hogan.compile(tpl, {asString: true});
        src: ['templates/*.hogan'],
        dest: 'dist/tpl.js'

I guess there will be need to tweek the regex that cleans the template.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Copyright (c) 2012 Markus Ullmark
Licensed under the MIT license.