grunt-particles

grunt-particles

Invoke Scatter services from Grunt (and dynamically control its configuration)

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

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

grunt.loadNpmTasks('grunt-particles');

The "scatter" task

Overview

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

grunt.initConfig({
  scatter: {
    options: {
      // Task-specific options go here.
    }
  },
})

Options

options.services

Type: Array Default value: None (Option Required)

options.appRoot

Type: String Default value: None (Option Required)

options.particles

Type: Array Default value: []

If not specified particles will be read from the config using the options.scatterConfigPath

options.nodeModulesDir

Type: String Default value: ''

options.configDir

Type: String Default value: 'config'

options.scatterConfigPath

Type: String Default value: 'scatter:app'

Usage Examples

grunt.initConfig({
  scatter: {
    options: {
      services: ['svc|pipeline!testService'],
      particles: [__dirname + "/test/root"],
      nodeModulesDir:  __dirname + "/node_modules",
      appRoot: __dirname,
      configDir: __dirname + "/test/config"
    }
  }
})

License

MIT

---