Cypress Image Diff Documentation
  • Migrate from v1 to v2
  • Getting started
    • Cypress integration
      • Typescript
      • Javascript
      • Browserstack
      • Cypress < v10
    • cy.compareSnapshot command
    • Custom config file
      • ROOT_DIR
      • FAILURE_THRESHOLD
      • RETRY_OPTIONS
      • FAIL_ON_MISSING_BASELINE
      • COMPARISON_OPTIONS
      • JSON_REPORT
      • CYPRESS_SCREENSHOT_OPTIONS
      • REPORT_DIR
      • SCREENSHOTS_DIR
      • NAME_TEMPLATE
    • Reporting
      • JSON report
      • Cypress Image Diff HTML Report
      • Legacy HTML Report
    • Client options
    • Running tests
    • Contributing
    • Publishing
Powered by GitBook
On this page
  1. Getting started
  2. Reporting

Legacy HTML Report

PreviousCypress Image Diff HTML ReportNextClient options

Last updated 1 year ago

Legacy HTML Report from version 1 continues to function in version 2, but is planned to be deprecated soon. Please consider using the .

For some reasons, you still want to use the legacy HTML report, add the following after hook:

// cypress/support/index.js for Cypress versions below 10
// cypress/support/{scheme}.js for Cypress versions 10 and above, where {scheme} defaults to e2e
after(() => {
  cy.task('generateReport')
})

The report will look something like:

Note: Baseline, comparison and diff images will only be added to the report for failing tests.

Legacy HTML report will be created following folder:

    .
    ├── cypress-image-diff-html-report

Note: Report folder name for legacy HTML report can't be customized via REPORT_DIR, it's hardcoded as cypress-image-diff-html-report.

Cypress Image Diff HTML Report