Grunt plugin to compile and concatenate twig.js templates.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tasks
test
.gitignore
.jshintrc
.travis.yml
Gruntfile.js
LICENSE-MIT
README.md
package.json

README.md

grunt-twig Build Status

Compiles and concatenates twig.js templates; currently, just for use in the browser.

twig.js does not yet have the ability to compile templates to actual JavaScript code. It instead compiles templates into data structures that it can easily use later to render the template with a given data set (or "context").

Thus, your application will still need to load twig.js in order to use the compiled templates.

Getting Started

This plugin requires Grunt >=0.4.0

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-twig --save-dev

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

grunt.loadNpmTasks('grunt-twig');

The "twig" task

Overview

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

grunt.initConfig({
  twig: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.amd_wrapper

Type: boolean
Default value: true

Determines whether the output will be wrapped in a require(["twig"], ...) call.

options.amd_define

Type: boolean or string
Default value: false
Requirement: options.amd_wrapper must be set to true

Determines whether to define the AMD module or not.

Examples

  • options.amd_define: true
    define(["twig"], function(Twig) { ... return window.JST; });
  • options.amd_define: 'my-templates'
    define('my-templates', ["twig"], function(Twig) { ... return window.JST; });
    (window.JST may be replaced by options.variable value)

options.variable

Type: string
Default value: 'window.JST'

The name of the global variable that should store all the templates.

options.separator

Type: string

Default value: ';\n'

A string that is inserted between each compiled template when concatenating templates.

options.template

Type: string
Default value: '{{ variable }} = {{ variable }} || {};\n{{ templates }}\n'

A Twig template used to render the result of the grunt-twig task. Variables available:

  • variable (string): JST array variable name (options.variable).
  • templates (string): All compiled templates.

options.each_template

Type: string
Default value: '{{ variable }}["{{ filepath }}"] = Twig.twig({ data: {{ compiled }} });'

A Twig template used to render each compiled template. Variables available:

  • variable (string): JST array variable name (options.variable).
  • filepath (string): Filename of the template as declared in options.
  • compiled (string): twig.js's data structure (JSON) of tokens resulting from compiling the template.

options.template_key

Type: function(string) -> string
Default value: function(path) { return path; }

A function used to create a template hash key from a template's path. This determines where the template is found in the resulting template hash; e.g., window.JST['templates/list.html.twig'] vs window.JST['list.html.twig'].

Usage Examples

Default Options

In this example, the default options are used to compile two simple templates.

grunt.initConfig({
  twig: {
    build_target: {
      files: {
        'dest/my-compiled-templates.js': [
          'templates/testing.twig',
          'templates/hello.twig'
        ]
      }
    }
  }
})

If the testing.twig file has the content Testing and the hello.twig file has the content Hello, {{ name }}, the generated result would be something like:

require(["twig"], function(Twig) {
window.JST = window.JST || {};
window.JST["testing.twig"] = Twig.twig({ data: [{"type":"raw","value":"Testing\n"}] });
window.JST["hello.twig"] = Twig.twig({ data: [{"type":"raw","value":"Hello, "},{"type":"output","stack":[{"type":"Twig.expression.type.variable","value":"name","match":["name"]}]},{"type":"raw","value":"\n"}] });
});

The variable Option

In this example, the variable option is used to customize the name of the array that the compiled templates will be stored in.

grunt.initConfig({
  twig: {
    options: {
      variable: 'myTemplates'
    },
    my_target: {
      files: {
        'dest/my-compiled-templates.js': [
          'templates/testing.twig',
          'templates/hello.twig'
        ]
      }
    }
  }
})

In this case, the resulting file, dest/my-compiled-templates.js will look something like:

require(["twig"], function(Twig) {
myTemplates = myTemplates || {};
myTemplates["testing.twig"] = Twig.twig({ data: [{"type":"raw","value":"Testing\n"}] });
myTemplates["hello.twig"] = Twig.twig({ data: [{"type":"raw","value":"Hello, "},{"type":"output","stack":[{"type":"Twig.expression.type.variable","value":"name","match":["name"]}]},{"type":"raw","value":"\n"}] });
});

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

  • 1.0.0: Update for Grunt 1.0.0.
  • 0.1.3: Update to twig 0.7.1.
  • 0.1.2: Add try/catch block around rendering of template. (Matt Farmer)
  • 0.1.1: Added template_key option.