Grunt task for rendering Swig templates.
JavaScript HTML
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
tasks
test
.gitignore
.jscs.json
.jshintrc
.npmignore
.travis.yml
Gruntfile.js
README.md
package.json

README.md

grunt-swig2

Task for rendering Swig templates

Build Status Dependency Status devDependency Status NPM version

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

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

grunt.loadNpmTasks("grunt-swig2");

swig task

Run this task with the grunt swig command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Options

data

Type: Object, Array, Function Default: {}

Locals that will be passed to each template when rendering. If this is a function, then it will be called once per target with no args. If this is an array, then the values will be merged into a single object.

filters

Type: Object Default: {}

Object containing custom Swig filters, where the key is the filter name and the value is the filter function. Example:

options: {
    filters: {
        // Makes strings more exciting
        makeExciting: function( input ) {
            return input + "!!!";
        }
    }
}

tags

Type: Object Default: {}

Object containing custom Swig tags, where the key is the tag name and the value is a object that must contain parser and compiler functions. ends and blockLevel flags may also be passed, but are optional. Also, you may pass a ext key as well, which will add a Swig extension with the name of this tag.

Example:

options: {
    tags: {
        tagName: {
            parser: function( str, line, parser, types, options ) {
                // ...
            },
            compiler: function( compiler, args, content, parents, options, blockName ) {
                // ...
            },
            ends: true,
            blockLevel: true,
            ext: anythingHere
        }
    }
}

swigOptions

Type: Object Default: {}

A hash of Swig options.