grunt-dustin

grunt-dustin

Better templating with LinkedIn's dust fork.

Grunt task

Render options

render

Type: Boolean

This tells the task to render templates.

resolve

Type: String

Passed to the adapter as the resolve option.

preserveWhiteSpace

Type: Boolean

Same as adapter option.

data

Type: String

Example: "test/data/*.json"

Passed to the adapter as the data option.

helpers

Type: String

Example: "test/helpers/*.js"

Register helpers for the render context. Passed to the adapter as the helpers option.

cache

Type: Boolean

Propagates to the adapter cache option.

Compile options

compile

Type: Boolean

This tells the target to compile templates.

resolve

Type: String

Passed to the adapter as the resolve option.

preserveWhiteSpace

Type: Boolean

Same as for rendering.

concat

Type: Boolean

This tells the target to concatenate files into the dest file. See the Grunt task config example for details.

Copy options

copy

Type: String

Example: "test/out/js/"

Copy client side libraries to this folder. If this option is set, rendering and compiling is ignored.

resolve

Type: String

Example: "js/"

The client side script will prefix partial paths with this to load them.

This:

{>"some/partial"/}

will resolve to this template: js/some/partial.js.

helpers

Type: String

Example: "test/helpers/client/*.js"

If set, the client scripts will include these helpers.

Example helper file:

dust.helpers.hello = function ( chunk, context, bodies, params ){
  return chunk.write("hello ")
}

dustinHelpers

Type: Boolean

Include dustin helpers to client side. You can see what helpers are available on the client side in the module dir lib/client/helpers.

dustHelpers

Type: Boolean

Include the dustjs helpers to client side.

Task config

grunt.initConfig({
  dustin: {
    // set global values for path resolution
    options: {
      // this prefixes partial lookup to shorten referencing
      resolve: "test/",
      setup: function( adapter, dust ){
        // whatever you want to do with dust before anything happens,
        // do it here
      }
    },
    copyClientLibs: {
      options: {
        // if the client option is present, every other is ignored
        // and client side libraries are copied to this dir
        copy: "test/out/js/",
        // set path resolution to client template loading
        // templates will attempt to load from this dir
        // example: {>"elements/message"/}
        // will load from template/elements/message.js
        resolve: "template/",
        helpers: "test/helpers/client/*.js",
        dustinHelpers: true,
        dustHelpers: true
      }
    },
    render: {
      options: {
        // this target renders html files
        render: true,
        // Dust removes white space by default. Don't do that now.
        preserveWhiteSpace: true,
        // create a global context from these json files
        // file names will be global properties
        data: "test/data/*.json",
        // execute these js files and let them register helpers
        helpers: "test/helpers/node/*.js",
        // this keeps the cache clear
        cache: false
      },
      expand: true,
      cwd: "test/page",
      src: "*.dust",
      dest: "test/out/",
      ext: ".html"
    },
    compile: {
      options: {
        // this target compiles js files
        compile: true,
        // we don't care about white space in compiled templates
        preserveWhiteSpace: false
      },
      expand: true,
      cwd: "test/",
      src: "elements/*.dust",
      dest: "test/out/template/",
      ext: ".js"
    },
    compileAndConcat: {
      options: {
        preserveWhiteSpace: false,
        compile: true,
        // this one concats compiled files into one
        concat: true
      },
      files: {
        "test/out/template/elements.js": "test/elements/*.dust"
      }
    }
  }
})

Licence

MIT