grunt-hoodie's Introduction

grunt-hoodie

Start hoodie and delay grunting till it is ready. Triggers a callback with hosts and ports of couchDB, www and pocket.

Getting Started

This plugin requires Grunt ~0.4.1

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

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

grunt.loadNpmTasks('grunt-hoodie');

The "hoodie" task

Overview

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

grunt.initConfig({
  hoodie: {
    start: {
      options: {
        callback: function (stack) {
          // For example, set the port of grunt-connect-proxy:
          // grunt.config.set('connect.proxies.0.port', stack.www.port);
        }
      }
    }
  },
})

Options

options.callback

Type: Function Default value: function(stack) {}

A callback that is called when hoodie is up and running. Has one param called stack which contains the host and port information.

Usage Example

In this example, the port of grunt-connect-proxy for the /_api of hoodie is set after hoodie started.

grunt.initConfig({
  hoodie: {
    start: {
      options: {
        callback: function(config) {
          grunt.config.set('connect.proxies.0.port', config.stack.www.port);
        }
      }
    }
  },
  connect: {
    options: {
      port: 9000,
      hostname: 'localhost'
    },
    proxies: [
      {
        context: '/_api',
        host: 'localhost',
        port: false,
        https: false,
        changeOrigin: false
      }
    ],
    …
  },
})