Hogan template compiler task for grunt.
Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-contrib-hogan
Then add this line to your project's grunt.js
gruntfile:
grunt.loadNpmTasks('grunt-contrib-hogan');
Grunt task that compiles Hogan templates into functions that can be loaded into the browser as is, or minified prior to loading.
Configuration for this task is added to your grunt.js
file with the hogan
key.
- files
object
- This sets the files that will be processed, by
destination: [source]
- This sets the files that will be processed, by
- options
object
- This is the options that will be passed to the hogan task
The namespace that the templates will be assigned to, the default is Templates
.
Example:
options: {
namespace: 'T'
}
Wraps the compiled templates with the require.js define(function() {})
function.
Example:
options: {
amdWrapper: true
}
Produces:
define(function() {
this["Templates"] = this["Templates"] || {};
return this["Templates"];
});
Strip out spaces from the compiled templates, and make the output look a little better by indenting template definitions.
args:
filename
Function that returns the key that the template file will be assigned.
Example:
options: {
defaultName: function(filename) {
return filename.split('/').pop();
}
}
Any options that might need to be passed to the Hogan.compile()
function.
hogan: {
publish: {
options: {
prettify: true,
templateName: function(file) {
return file.toUppercase();
}
},
files:{
"path/to/compiled.js": ["path/to/source/**/*.html"]
}
}
}
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 Matt McFarland Licensed under the MIT license.