grunt-particles

grunt-particles

Invoke Scatter/Particles 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 "particles" task

Overview

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

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

Options

options.runServices

Type: Array Default value: None (Option Required)

options.appRoot

Type: String Default value: None (Option Required)

options.configDir

Type: String Default value: 'config'

options.configNamespace

Type: String Default value: 'particles:app'

Config parameters

In the context of options.configNamespace:

particles

Type: Array Default value: []

nodeModulesDir

Type: String Default value: ''

Usage Examples

grunt.initConfig({
  scatter: {
    options: {
      runServices: "svc|sequence!aService/toRun",
      appRoot: __dirname,
      configDir: __dirname + "/test/config"
    }
  }
})

{
  "particles": {
    "app": {
      "particles": ["${appRoot}/aParticle/root"]
    }
  }
}

License

MIT

---