grunt-each

A grunt plugin to perform actions on a list of files.

Getting Started

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

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

grunt.loadNpmTasks('grunt-each');

Alternatively, install task-master and let it manage this for you.

The "each" task

Overview

In your project's Gruntfile, add a section named each to the data object passed into grunt.initConfig(). The each task is a multitask. For each target you define, specify a list of files in any of the normal grunt formats, and under options, add an actions property. This can be a function, a string (corresponding a to a module to require), or an array combining functions and strings. If an action is a string, grunt-each will attempt to require a module with that name and use that as the action. This allows actions to be published for reuse or to be abstracted to separate files when they are long or require testing or are used elsewhere in the codebase. Functions (or modules referenced by string) can be either sync or async. Synchronous actions are passed a file object with properties name, contents, and origContents and should return the modified contents. Asynchronous actions are passed the same file object, as well as a callback which accepts an optional error and the modified contents. Actions are composed in reverse, so that the contents property of the file in the second action will be the return value (or callback value) of the first action.

Examples

module.exports = function(grunt) {
  grunt.loadNpmTasks('grunt-each');

  grunt.initConfig({
    each: {
      // Single function
      split: {
        src: 'src/**/*.txt',
        dest: 'dest/',
        options: {
          // Synchronous action signature
          actions: function(file) {
            return file.contents.split(' ')[1]; 
          }
        }
      },
      // Single string
      splitString: {
        src: 'src/**/*.txt',
        dest: 'dest/'
        options: {
          actions: './actions/split'
        }
      },
      // Array combining these
      reverse: {
        src: 'src/**/*.txt',
        dest: 'dest/'
        options: {
          actions: ['./actions/split', function(file) {
            // Assuming ./actions/split does the same thing as the action in
            // each.split, the output of this composition will be the second
            // word in the file reversed.
            return file.contents.split('').reverse().join('');
          }]
        }
      },
      async: {
        src: 'src/**/*.txt',
        dest: 'dest/'
        options: {
          // Asynchronous action signature
          actions: [function(file, cb) {
            doSomethingAsync(file.contents, function(newStuff) {
              cb(null, newStuff);
            });
          }]
        }
      }
    }
  });
};

See the tests for extensive examples.

Contributing

Please see the contribution guidelines.