Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    grunt-contrib-hoganpublic

    This package has been deprecated

    Author message:

    Deprecated due to rename, please use grunt-templates-hogan.

    grunt-contrib-hogan Build Status

    Hogan template compiler task for grunt.

    Getting Started

    Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-contrib-hogan

    Then add this line to your project's grunt.js gruntfile:

    grunt.loadNpmTasks('grunt-contrib-hogan');

    Overview

    Grunt task that compiles Hogan templates into functions that can be loaded into the browser as is, or minified prior to loading. Configuration for this task is added to your grunt.js file with the hogan key.

    Parameters

    • files object
      • This sets the files that will be processed, by destination: [source]
    • options object
      • This is the options that will be passed to the hogan task

    Options

    namespace string

    The namespace that the templates will be assigned to, the default is Templates.

    Example:

    options: {
      namespace: 'T'
    }

    amdWrapper boolean

    Wraps the compiled templates with the require.js define(function() {}) function.

    Example:

    options: {
      amdWrapper: true
    }

    Produces:

    define(function() {
      this["Templates"] = this["Templates"] || {};
     
      return this["Templates"];
    });

    amdRequire object

    Wraps the compiled templates with the require.js define(function() {}) function.

    Example:

    options: {
      amdWrapper: true,
      amdRequire: {
        hogan: "Hogan",
        otherLibrary: "$"
      }
    }

    Produces:

    define(["hogan","otherLibrary"], function(Hogan, $) {
      this["Templates"] = this["Templates"] || {};
     
      return this["Templates"];
    });

    commonJsWrapper boolean

    Wraps the compiled templates in a CommonJS module.exports for use with component(1).

    Example:

    options: {
      commonJsWrapper: true
    }

    Produces:

    this["Templates"] = this["Templates"] || {};
     
    if (typeof module !== 'undefined' && typeof module.exports !== 'undefined') {
      module.exports = this["Templates"];
    }
     
    // with "component build" this will be wrapped in:
    // require.register("project/file", function(exports, require, module){
    // ...
    // });

    prettify boolean

    Strip out spaces from the compiled templates, and make the output look a little better by indenting template definitions.

    defaultName function

    args:

    • filename

    Function that returns the key that the template file will be assigned.

    Example:

    options: {
      defaultName: function(filename) {
        return filename.split('/').pop();
      }
    }

    templateOptions object

    Any options that might need to be passed to the Hogan.compile() function.

    Configuration example

    hogan: {
          publish: {
            options: {
              prettify: true,
              defaultName: function(file) {
                return file.toUpperCase();
              }
            },
            files:{
              "path/to/compiled.js": ["path/to/source/**/*.html"]
            }
          }
        }

    Release History

    • 0.2.3 - Add option for custom AMD dependencies. Thanks @cconger!
    • 0.2.2 - Fix bug when compiling multiple files in a single target. Thanks @mikejestes!
    • 0.2.0 - Can now use the commonJS wrapper option. Thanks @smhg!
    • 0.1.0 - Updated for grunt release 0.4
    • 0.0.2 - No longer have to initialize a new Hogan.Template for every template you want to use.
    • 0.0.1 - Initial release

    License

    Copyright (c) 2012 Matt McFarland Licensed under the MIT license.

    install

    npm i grunt-contrib-hogan

    Downloadsweekly downloads

    24

    version

    0.2.4

    license

    none

    repository

    githubgithub

    last publish

    collaborators

    • avatar