@ilukanets/gulp-to-jst
v1.0.1
Published
> A [gulp](http://gulpjs.com/) plugin to compile [underscore](http://underscorejs.org/#template) / [lodash](http://lodash.com/docs#template) templates into a single file.
Downloads
589
Maintainers
Readme
@ilukanets/gulp-to-jst
A gulp plugin to compile underscore / lodash templates into a single file.
Based on the same gulp plugin gulp-tojst.
It has replaced deprecated gulp-util dependency.
Install
Install using npm.
$ npm install @ilukanets/gulp-to-jst
Usage
var toJST = require('@ilukanets/gulp-to-jst');
gulp.task('jst', function () {
gulp.src('templates/**/*.html')
.pipe(toJST('jst.js', {
namespace: 'MY.NAME.SPACE',
separator: '\n',
prettify: true,
templateSettings: {
interpolate: /\{\{(.+?)\}\}/g
}
}))
.pipe(gulp.dest('build/templates'))
})
Options
amd
Type: boolean
Default: false
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.
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.
namespace
Type: string
Default: JST
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.
processName
Type: function
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.
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.
separator
Type: string
Default: \n
Concatenated files will be joined on this string.
templateSettings
Type: object
Default: {}
The settings passed to underscore when compiling templates. Accepts the same _.templateSettings options as the underscore\lodash library.
License
MIT