Go to file
2013-01-29 16:27:25 -04:00
docs Add separator option, warn on nonexistent src files and empty output. 2013-01-10 13:08:29 -08:00
tasks Fix regular expression when dealing with lodash touched source. 2013-01-29 16:27:25 -04:00
test Replace Underscore.js with Lo-Dash 2012-12-31 21:06:55 +01:00
.gitignore first commit 2012-09-10 13:12:23 -05:00
.jshintrc rough in .4 2012-10-18 18:02:45 -05:00
.travis.yml install grunt-cli globally with travis for testing 2012-12-12 16:40:13 -06:00
AUTHORS add contributor 2012-09-16 09:32:10 -05:00
CHANGELOG prep for rc7 2013-01-23 11:48:54 -05:00
CONTRIBUTING.md Switching to this.files property per gruntjs/grunt#606. 2013-01-09 14:48:55 -08:00
Gruntfile.js Added a processContent option 2012-12-29 22:18:21 +09:00
LICENSE-MIT docs 2012-10-03 12:44:36 -05:00
package.json prep for rc7 2013-01-23 11:48:54 -05:00
README.md fix version in generated readme 2013-01-26 22:57:05 -05:00

grunt-contrib-jst Build Status

Precompile Underscore templates to JST file.

Getting Started

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, install this plugin with this command:

npm install grunt-contrib-jst --save-dev

Jst task

Run this task with the grunt jst command.

This task is a [multi task][] so any targets, files and options should be specified according to the [multi task][] documentation. [multi task]: https://github.com/gruntjs/grunt/wiki/Configuring-tasks

Version 0.4.x of this plugin is compatible with Grunt 0.4.x. Version 0.3.x of this plugin is compatible with Grunt 0.3.x.

Options

separator

Type: String Default: linefeed + linefeed

Concatenated files will be joined on this string.

namespace

Type: String Default: 'JST'

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

processName

Type: function Default: null

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();
  }
}

templateSettings

Type: Object Default: null

The settings passed to underscore when compiling templates.

jst: {
  compile: {
    options: {
      templateSettings: {
        interpolate : /\{\{(.+?)\}\}/g
      }
    },
    files: {
      "path/to/compiled/templates.js": ["path/to/source/**/*.html"]
    }
  }
}

prettify

Type: boolean Default: false

When doing a quick once-over of your compiled template file, it's nice to see an easy-to-read format that has one line per template. This will accomplish that.

options: {
  prettify: true
}

amdWrapper

Type: boolean Default: false

With Require.js and a pre-compiled template.js you want the templates to be wrapped in a define. This will wrap the output in:

define(function() {
  //Templates
  return this["NAMESPACE"];
});

Example:

options: {
  amdWrapper: true
}

processContent

Type: function

This option accepts a function which takes one argument (the file content) and returns a string which will be used as template string. The example below strips whitespace characters from the beginning and the end of each line.

options: {
  processContent: function(src) {
    return src.replace(/(^\s+|\s+$)/gm, '');
  }
}

Usage Examples

jst: {
  compile: {
    options: {
      templateSettings: {
        interpolate : /\{\{(.+?)\}\}/g
      }
    },
    files: {
      "path/to/compiled/templates.js": ["path/to/source/**/*.html"]
    }
  }
}

Release History

  • 2013-01-22v0.4.0rc7Updating grunt/gruntplugin dependencies to rc7. Changing in-development grunt/gruntplugin dependency versions from tilde version ranges to specific versions.
  • 2013-01-08v0.4.0rc5Updating to work with grunt v0.4.0rc5. Switching to this.files api.
  • 2012-10-11v0.3.1Rename grunt-contrib-lib dep to grunt-lib-contrib.
  • 2012-08-22v0.3.0Options no longer accepted from global config key.
  • 2012-08-15v0.2.3Support for nested namespaces.
  • 2012-08-11v0.2.2Added processName functionality & escaping single quotes in filenames.
  • 2012-08-09v0.2.0Refactored from grunt-contrib into individual repo.

Task submitted by Tim Branyen

This file was generated on Sat Jan 26 2013 22:56:46.