grunt-jade-mod

jade task for grant wich is modifiable.

This grunt task uses 'grunt-contrib-jade' from its inside, so the detailed functionalities are depend on 'grunt-contrib-jade'.

The purpose of this task is to modify or to add some functionality to the 'Jade template engine', by using some 'modifier' libraries.
Currently, the only 'modifier' library usable with this task is 'phpjade'.

Getting Started

This plugin requires Grunt ~0.4.5

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-jade-mod --save

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

grunt.loadNpmTasks('grunt-jade-mod');

Additionally, you have to install the 'modifiers'.
The only usable modifier is 'phpjade', do the following to install that:

npm install phpjade --save

The "jade" task

Overview

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

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

Options

Because this task calls 'jade' task defined by 'grunt-contrib-jade', all options except some additions are same as 'grunt-contrib-jade', so please refer to 'grunt-contrib-jade' for original options.

Here describes some additional options.

modifiers

grunt.initConfig({
  jade: {
    your_target: {
      options: {
        modifiers: [ 'phpjade' ],
      }
      files: {
      }
  },
});

The 'modifiers' option is a series of modifier library names.
The library name is used as an argument for 'require()' function, so you might be able to use relative path to the library you want to use.
They are 'applied' sequentially to 'jade' engine so that they modify or add their own functionalities.

The options consumed by modifiers

Some options are modifier specific, because there are no place to control the modifiers except passing values as 'options'. For example, 'phpjade' accept 'usestrip' option to control its behavior.

grunt.initConfig({
  jade: {
    your_target: {
      options: {
        modifiers: [ 'phpjade' ],
        usestrip: true,
      }
    }
  }
});

See phpjade for more detailed information.

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 May 20 2015

Related projects

• phpjade
  php modifier module for Jade template engine.
• jade-mod-cli
  Jade cli with modifier support.