grunt.template

Template strings can be processed manually using the provided template functions. In addition, the config.get method (used by many tasks) automatically expands <% %> style template strings specified as config data inside the Gruntfile.

grunt.template.process

Process a Lo-Dash template string. The template argument will be processed recursively until there are no more templates to process.

The default data object is the entire config object, but if options.data is set, that object will be used instead. The default template delimiters are <% %> but if options.delimiters is set to a custom delimiter name (set with grunt.template.addDelimiters), those template delimiters will be used instead.

grunt.template.process(template [, options])

Inside templates, the grunt object is exposed so that you can do things like <%= grunt.template.today('yyyy') %>. Note that if the data object already has a grunt property, the grunt API will not be accessible in templates.

In this example, the baz property is processed recursively until there are no more <% %> templates to process.

var obj = {
  foo: 'c',
  bar: 'b<%= foo %>d',
  baz: 'a<%= bar %>e'
};
grunt.template.process('<%= baz %>', {data: obj}) // 'abcde'

grunt.template.setDelimiters

Set the Lo-Dash template delimiters to a predefined set in case grunt.util._.template needs to be called manually. The config delimiters <% %> are included by default.

You probably won't need to use this method, because you'll be using grunt.template.process which uses this method internally.

grunt.template.setDelimiters(name)

grunt.template.addDelimiters

Add a named set of Lo-Dash template delimiters. You probably won't need to use this method, because the built-in delimiters should be sufficient, but you could always add {% %} or [% %] style delimiters.

The name argument should be unique since it is how we access the delimiters from grunt.template.setDelimiters and as an option for grunt.template.process.

grunt.template.addDelimiters(name, opener, closer)

In this example, if we were to use the {% %} style mentioned above we would use the following:

grunt.template.addDelimiters('myDelimiters', '{%', '%}')

Helpers

grunt.template.date

Format a date using the dateformat library.

grunt.template.date(date, format)

In this example, a specific date is formatted as month/day/year.

grunt.template.date(847602000000, 'yyyy-mm-dd') // '1996-11-10'

grunt.template.today

Format today's date using the dateformat library.

grunt.template.today(format)

In this example, today's date is formatted as a 4-digit year.

grunt.template.today('yyyy') // '2017'

(somebody remind me to update this date every year so the docs appear current)