grunt-requirejs-templates

0.1.10 • Public • Published

grunt-requirejs-templates

A plugin to insert the content of template files like underscore, handlebars to variables into the javascript code

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-requirejs-templates --save-dev

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

grunt.loadNpmTasks('grunt-requirejs-templates');

What it does

Supposing that you have your template files in a separated folder and loads them with Require.js like this:

define([
    'text!templates/myTemplate.html'        
], function (Template) {
    
    var html = _.template(Template)({name: "Sergio"});
    
});

The grunt-requirejs gets the content of the template file and put it into a string to prevent your application to make a XMLHttpRequest to load it:

define([
], function () {
    
    var Template = '<p>This is my template file, <%=name%>!</p>';
    var html = _.template(Template)({name: "Sergio"});
    
});

Supported template engines

Today grunt-requirejs-templates supports this template engines:

Help us to write tests and support another template engines!

The "requirejs_templates" task

Overview

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

grunt.initConfig({
  requirejs_templates: {
    dist: {
      options: {
        // your options here
      },
    }
  }
});

Options

options.appDir

Type: String Default value: '.'

Path to your application

options.scripts

Type: String Default value: 'scripts'

Path to your javascript files

options.templates

Type: String Default value: 'templates'

options.output

Type: String Default value: null

Path to your create the script files after processing, the default value will output to the source folder.

Usage Examples

define({
  requirejs_templates: {
    dist: {
      options: {
        appDir: "app",
        scripts: "scripts", // This will read the app/scripts folder
        templates: "templates",
        output "dist" // This will create the dist/scripts folder
      },
    }
  }
});

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)

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.1.10
    1
    • latest

Version History

Package Sidebar

Install

npm i grunt-requirejs-templates

Weekly Downloads

1

Version

0.1.10

License

none

Last publish

Collaborators

  • sergiovilar