grunt-contrib-jst/docs/jst-options.md

99 lines
2.1 KiB
Markdown
Raw Normal View History

2012-10-19 07:02:45 +08:00
# Options
## separator
Type: `String`
Default: linefeed + linefeed
Concatenated files will be joined on this string.
2012-11-28 22:41:10 +08:00
## namespace
2012-10-19 07:02:45 +08:00
Type: `String`
Default: 'JST'
2012-10-03 21:46:16 +08:00
2013-03-07 01:54:06 +08:00
The namespace in which the precompiled templates will be assigned. Use dot notation (e.g. App.Templates) for nested namespaces or false for no namespace wrapping. When false with amd option set true, templates will be returned directly from the AMD wrapper.
2012-10-03 21:46:16 +08:00
2012-11-28 22:41:10 +08:00
## processName
Type: `function`
2012-10-19 07:02:45 +08:00
Default: null
2012-10-03 21:46:16 +08:00
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.
```js
options: {
processName: function(filepath) {
return filepath.toUpperCase();
2012-10-03 21:46:16 +08:00
}
}
```
2012-11-28 22:41:10 +08:00
## templateSettings
Type: `Object`
2012-10-19 07:02:45 +08:00
Default: null
2012-10-03 21:46:16 +08:00
The settings passed to underscore when compiling templates.
```js
jst: {
compile: {
options: {
templateSettings: {
interpolate : /\{\{(.+?)\}\}/g
}
},
files: {
"path/to/compiled/templates.js": ["path/to/source/**/*.html"]
}
}
}
```
2012-11-28 22:41:10 +08:00
## 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.
```js
options: {
prettify: true
}
```
2013-03-07 01:54:06 +08:00
## amd
Type: `boolean`
Default: false
2013-03-07 01:54:06 +08:00
Wraps the output file with an AMD define function and returns the compiled template namespace unless namespace has been explicitly set to false in which case the template function will be returned directly.
```js
define(function() {
2013-03-07 01:54:06 +08:00
//...//
2013-07-15 10:25:18 +08:00
return this['[template namespace]'];
});
```
Example:
```js
options: {
2013-03-07 01:54:06 +08:00
amd: true
}
```
2012-12-29 21:18:21 +08:00
## processContent
Type: `function`
2012-12-29 21:18:21 +08:00
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.
```js
2012-12-29 21:18:21 +08:00
options: {
processContent: function(src) {
return src.replace(/(^\s+|\s+$)/gm, '');
}
}
```