@parallaxagency/retrogress NPM

Introduction

Tested on node version v8.9.4.

Retrogress allows you to make reference screenshots and check against them before comitting major changes to see whats changed and hopefully catch bugs earlier.

Uses puppeteer for generating page screenshots and pixelmatch for visual diffing.

Installation

To install retrogress in a project:

yarn add @parallaxagency/retrogress

Then add retrogress in an npm script for some nicer aliases:

{
  "scripts": {
    "diffs:reference": "retrogress --reference",
    "diffs:latest": "retrogress",
    "diffs:compare": "retrogress --diff"
  }
}

And finally you need to add a config file for the routes and sizes you want to generate screenshots for. Retrogress will look for a .retrogress.js file in the project root but you can change where this is located with the --config flag.

Config

The bare minimum you need in your .retrogress.js config is a routes object.

module.exports = {
  routes: {
    'home': 'http://example.com'
  }
}

The following options are available with defaults shown.

module.exports = {
  rootDir: path.join(process.cwd(), '/.retrogress'), // Defaults (not required)
  referenceFolder: 'reference', // Defaults (not required)
  latestFolder: 'latest', // Defaults (not required)
  diffsFolder: 'diffs', // Defaults (not required)
  sizes: [
    {
      width: 1920,
      height: 1080
    },
    {
      width: 320,
      height: 568
    }
  ],
  loadDelay: 1000, // Defaults (not required)
  pixelDifferenceThreshold: 0.1, // Defaults (not required)
  routes: { // (required)
    'home': 'http://example.com/',
    'about': 'http://example.com/about',
    'services-index': 'http://example.com/services',
    'services-view': 'http://example.com/services/view'
  }
}