grunt-yui-template

Precompile Y.Template files.

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-yui-template --save-dev

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

grunt.loadNpmTasks('grunt-yui-template');

The "yui_template" task

Overview

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

grunt.initConfig({
  yui_template: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
        files: [{
            expand: true,
            src: 'src/**/*.{micro,hbs}.html',
            ext: '.js',
            rename: function(dest, src) {
                // compile from moduleFoo/tmpl to moduleFoo/js
                return src.replace(/\/tmpl\//, '/js/');
            }
        }]
    },
  },
});

Usage Examples

YUI like module directory structure

Templates are stored in a tmpl/ folder within the module and built to js/, where they can be picked up by shifter and wrapped up as modules.

grunt.initConfig({
  yui_template: {
    files: [{
      expand: true,
      src: 'src/**/*.{micro,hbs}.html',
      ext: '.js',
      rename: function(dest, src) {
        // compile from moduleFoo/tmpl to moduleFoo/js
        return src.replace(/\/tmpl\//, '/js/');
      }
    }]
  },
});

Contributing

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.

Release History

(Nothing yet)

grunt-yui-template-compile