grunt-async-jade-data v0.1.1

grunt-async-jade-data

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-async-jade-data --save-dev

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

grunt.loadNpmTasks('grunt-async-jade-data');

The "async_jade_data" task

Overview

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

grunt.initConfig({
  async_jade_data: {
    options: {
      data: {
        // Global configuration goes here
      }
    },
    your_target: {
      options: {
        data: {
          // Target specific data goes here
        }
      }
    },
  },
});

Options

options.global

Type: Boolean Default value: false

A flag to tell if the global data should be used in this target

options.data

Type: Object Default value: {}

This object contains the functions that should be called to fill the jade data object

Usage Examples

Target options

In this example, a configuration file is loaded from the file system.

grunt.initConfig({
  async_jade_data: {
    publish: {
      options: {
        data: {
          config: function(done) {
            var fs = require("fs");
            fs.readFile(__dirname + '/config.json', function(err, data) {
              if(!err) {
                data = JSON.parse(data)
                done(data);
              }
            });
          }
        }
      }
    }
  },
});

Using global options

In this example, the target specific and global data are combined. Note that the target will override the global

grunt.initConfig({
  async_jade_data: {
    data: {
      language_params: function(done) {
        var fs = require("fs");
        fs.readFile(__dirname + '/language_params.json', function(err, data) {
          if(!err) {
            data = JSON.parse(data)
            done(data);
          }
        });
      }
    }
    publish: {
      options: {
      global: true //This tells the task to use the global options as well
        data: {
          config: function(done) {
            var fs = require("fs");
            fs.readFile(__dirname + '/config.json', function(err, data) {
              if(!err) {
                data = JSON.parse(data)
                done(data);
              }
            });
          }
        }
      }
    }
  },
});

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

###v0.1.0

• Adding the main task and it´s test