grunt-dot

0.1.2 • Public • Published

grunt-dot

Precompile doT templates into a single file

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

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

grunt.loadNpmTasks('grunt-dot');

The "dot" task

Overview

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

grunt.initConfig({
  dot: { 
    compile: {
      options: {
        /*
         * root: Sets the json root
         * templateSettings: override doT's default settings 
         */
      },
      files: {
        'target': [/* Files */],
      }
    }
  }
})

Options

options.root

Type: String

A string value that is the root key

options.fileExtension

Type: String Default value: 'dot'

A string value that is the file extension for the template

options.templateSettings

Type: Object Default value: {selfcontained: true}

A string value that is the file extension for the template

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

  • 0.1.2 Basic version working

Readme

Keywords

none

Package Sidebar

Install

npm i grunt-dot

Weekly Downloads

1

Version

0.1.2

License

none

Last publish

Collaborators

  • pspeter3