grunt-image-diff

Grunt implementation of Perceptual Image Diff

npm install grunt-image-diff
8 downloads in the last month

grunt-image-diff

Grunt implementation of Perceptual Image Diff

Getting Started

This plugin requires Grunt ~0.4.2

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-image-diff --save-dev

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

grunt.loadNpmTasks('grunt-image-diff');

The "image_diff" task

Overview

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

grunt.initConfig({
  image_diff: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.orig

Type: String Default value: '_orig'

A string value original file pattern.

options.test

Type: String Default value: '_test'

A string value test of difference file pattern.

options.diff

Type: String Default value: '_diff'

A string value difference file pattern to write difference to the file.

options.luminanceonly

Type: Bool Default value: true

To only consider luminance; ignore chroma (color) in the comparation.

options.colorfactor

Type: String Default value: '0.0'

How much of color to use, 0.0 to 1.0, 0.0 = ignore color.

Usage Examples

Default Options

grunt.initConfig({
  image_diff: {
    options: {
      orig: '_orig',
      test: '_test',
      diff: '_diff',
    },
    src: './screenshots/*.png'
  },
});

Release History

0.1.1 - Change options. Include luminanceonly and colorfactor. 0.1.0 - First version.

npm loves you