metalshark/grunt-html5compare

Compares HTML 5 files for equivalence.

grunt-html5compare

Compares HTML 5 files for equivalence.

Introduction

Ever needed to compare two HTML 5 files to make sure they match for unittests, then realised that using simple diffs meant that attribute ordering and whitespace caused problems? Well grunt-html5compare is the tool for the job!

Please have a look at the actual comparison itself for details and feel free to raise an issue if there is anything missing.

Windows users

This package relies on jsdom, which itself relies on contextify that then relies on node-gyp.

node-gyp is a build tool and that mean Windows needs a build environment. Thankfully there is a guide which should make life easier.

Getting Started

This plugin requires Grunt ~0.4.5

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

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

grunt.loadNpmTasks('grunt-html5compare');

*This plugin was designed to work with Grunt 0.4.x.

html5compare task

Run this task with the grunt html5compare command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Please be aware the the destination file(s) will be compared to the source file(s). If you can suggest a better syntax, then please raise an issue with a proposal.

Options

different

Type: Boolean Default: false

Only pass if the files are different.

Usage Examples

html5compare: {

    // Normal comparison of HTML files
    singleTask: {
      files: [
        {
          'comparison.html': 'original.html' // compare the two files
        }
      ]
    },

    // Reverse the logic so it only passes if files are different
    singleTaskDifferent: {
      options: {
        different: true // passes if they do not match
      },
      files: [
        {
          'comparison.html': 'original.html'
        }
      ]
    },

    // Expanded syntax
    singleTaskDifferent: {
        files: [
            expand: true,
            cwd: 'tests',
            src: 'originals/**/*.html'
            dest: 'comparisons',
            ext: '.html'
        ]
    }
  }