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

SCREENSHOTS_DIR

PreviousREPORT_DIRNextNAME_TEMPLATE

Last updated 10 months ago

The SCREENSHOTS_DIR specifies where all the screenshots are saved. It's relative to the .

💢 Default value: cypress-image-diff-screenshots

// cypress-image-diff.config.js
const config = {
  ROOT_DIR: 'visual-test',
  SCREENSHOTS_DIR: 'screenshots'
};

module.exports = config;

Output directory:

    .
    ├── visual-test
        ├── screenshots
            ├── baseline
            ├── comparison
            ├── diff
ROOT_DIR