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. Custom config file

REPORT_DIR

PreviousCYPRESS_SCREENSHOT_OPTIONSNextSCREENSHOTS_DIR

Last updated 6 months ago

The REPORT_DIR specifies where the generated JSON report lives. It's relative to the .

💢 Default value: cypress-image-diff-html-report

// cypress-image-diff.config.js
const config = {
  ROOT_DIR: 'visual-test/custom-folder-name',
  REPORT_DIR: 'html-report',
};

module.exports = config;

Output directory:

    .
    ├── visual-test
        ├── custom-folder-name
            ├── html-report
ROOT_DIR