node package manager
Painless code sharing. npm Orgs help your team discover, share, and reuse code. Create a free org »

gulp-html2tpl

gulp-html2tpl

Small gulp 3 plugin that will convert HTML files into Underscore.js templates and save them to filename supplied.

Install

npm install --save-dev gulp-html2tpl

Usage

var html2tpl = require('gulp-html2tpl');
 
gulp.task('compile', function() {
  gulp.src('templates/*.html')
      .pipe(html2tpl('templates.js'))
      .pipe(gulp.dest('dist'))
});

API

gulp-html2tpl(filename, options)

filename

The name of the file to save your new template object to.

options.varName

Type: String Default: templates

What the variable name will be. By default is:

var temaplates = {};

options.precompile

Type: Boolean Default: true

Whether or not the HTML should be run through the Underscore.js _.template() function.

Testing

Open a terminal in the directory containing gulp-html2tpl and then:

npm install
npm test

The License (MIT)

Copyright (c) 2014 TJ Eastmond

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.