load-grunt-initconfig v0.0.2

load-grunt-initconfig

Separate your long configuration into bite-sized chunks.

Installation

npm install load-grunt-initconfig --save-dev

Usage

load-grunt-initconfig will look for config files in the .initconfig directory. Here is an example project structure:

$ tree -a
.
├── .initconfig
|   ├── clean.js
|   ├── copy.json
|   ├── jshint.js
|   └── mochaTest.json
└── Gruntfile.js

And an corresponding Gruntfile.js:

module.exports = function (grunt) {
  // load tasks
  grunt.loadNpmTasks('grunt-contrib-copy');
  grunt.loadNpmTasks('grunt-contrib-clean');
  grunt.loadNpmTasks('grunt-contrib-jshint');
  grunt.loadNpmTasks('grunt-mocha-test');
  // require init config
  require('load-grunt-initconfig')(grunt); // this is the important bit
  // register tasks
  grunt.registerTask('test', ['copy', 'jshint', 'clean', 'mochaTest']);
  grunt.registerTask('default', ['test']);
};

In our example, this will require the config files, combine them into a single object, and apply that object to grunt.initConfig. Each of the config files' names should map to a grunt task (e.g. mochaTest.json maps to the mochaTest task).

Options

You can configure load-grunt-initconfig with options:

• dir (the directory of your config files, default: .initconfig)

Here is an example using options:

module.exports = function (grunt) {
  // load tasks ...
  require('load-grunt-initconfig')(grunt, {
    dir: '.gruntconfig'
  });
  //register tasks ...
};

Config File Examples

There are two ways to include your config files, as json or javascript:

.json Example for jshint.js:

{
  "options": {
    "jshintrc": ".jshintrc"
  },
  "all": {
    "src": ["src/**/*.js"]
  }
}

For javascript, you can choose whether or not to inject the grunt object into your config:

javascript (with injection) Example for jshint.js:

// if you DO need injection, return an Function
module.exports = function (grunt) {
  return {
    options: {
      jshintrc: ".jshintrc"
    },
    all: {
      src: ["src/**/*.js"]
    }
  };
};

javascript (without injection) Example for jshint.js:

// if you don't need injection, return an Object
module.exports = {
  options: {
    jshintrc: ".jshintrc"
    },
    all: {
      src: ["src/**/*.js"]
    }
  }
};

More Info

If you are still unsure how the package works, check out the Gruntfile.js and .initconfig for this project on GitHub; it uses load-grunt-initconfig to test itself!