grunt-underscore-singlefile

grunt-underscore-singlefile

Collects your underscore templates into a single file, in order to reduce the number of server requests

Getting Started

This plugin requires Grunt ~0.4.2

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-underscore-singlefile --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-underscore-singlefile');

The "underscore_singlefile" task

Overview

In your project's Gruntfile, add a section named underscore_singlefile to the data object passed into grunt.initConfig().

grunt.initConfig({
    underscore_singlefile: {
        options : {
            name : 'templateVariableName',
            separartor : '\n\n'
        },
        build: {
            src: 'src/tpl/*.html',
            dest: 'js/tpls.js'
        }
    }
});

Options

options.separator

Type: String Default value: '\n'

A string value that is used to separate templates in destination file.

options.name

Type: String Default value: 'tpls'

A string value, name of Object, which contains all templates.

Usage Examples

Default Options

grunt.initConfig({
  underscore_singlefile: {
      files: {
          'tmp/default_options': [
              'test/fixtures/IndexView.html',
              'test/fixtures/MainView.html'
          ]
      }
  }
});

Custom Options

grunt.initConfig({
  underscore_singlefile: {
        options: {
            separartor: '\n/*--------------*/\n',
            name: 'templates'
        },
        files: {
            'tmp/custom_options': [
                'test/fixtures/IndexView.html',
                'test/fixtures/MainView.html'
            ]
        }
  },
});

Usage in project

 _.each(tpls,function(tpl,name){
     window[name].prototype.template = tpl;
 });

Release History

(Nothing yet)