cypress-compare-screenshot v1.0.2

Cypress Compare Screenshot

A plugin for adding visual regression test to Cypress using ODiff The fastest pixel-by-pixel image visual difference tool in the world.

Why?

ODiff Benchmarks are the main motivation for this. 🚀

Getting Started

Install:

$ npm install cypress-compare-snapshots

Add the plugin

const { addCompareScreenshotPlugin } = require('cypress-compare-screenshot')

module.exports = defineConfig({
  trashAssetsBeforeRuns: false, // needed to avoid deleting expeted screenshot
  e2e: {
    setupNodeEvents (on, config) {
      addCompareScreenshotPlugin(on, config)
    }
  }
})

Add the command in support/commands.js

const { addCompareScreenshotCommand } = require('cypress-compare-screenshot')

addCompareScreenshotCommand({})

Using in Tests

Given the following test case under cypress/e2e/example.cy.js

describe('example', () => {
  it('passes', () => {
    cy.visit('https://example.cypress.io')
    cy.compareScreenshot()
  })
})

the command compareScreenshot will:

• create a screenshot (expected) under cypress/screenshots/example.cy.js/passes.png and save it for further runs
• if the screenshot is already created, the command will compare the recorded screenshot (actual) with the previously saved one (expected) and fail if there is a difference between these two screenshots. An image with the highlighted differences (diff) will be created.

ToDo

• write tests
• provide options to save screenshots under another directory
• provide options to set failure threshold
• update (expected) screenshot
• ...