[
{
"path": ".editorconfig",
"content": "root = true\n\n[*]\nend_of_line = lf\ninsert_final_newline = true\n\n[*.{js,json,yml}]\ncharset = utf-8\nindent_style = space\nindent_size = 2\n"
},
{
"path": ".github/workflows/ci.yml",
"content": "name: CI\non:\n pull_request:\n branches:\n - main\n push:\n branches:\n - main\n\njobs:\n cache:\n name: CI cache\n runs-on: ubuntu-latest\n outputs:\n pnpm-cache: ${{ steps.vars.outputs.pnpm-cache }}\n key: ${{ steps.vars.outputs.key }}\n steps:\n - uses: actions/checkout@v4\n - uses: pnpm/action-setup@v3\n - uses: actions/setup-node@v4\n with:\n node-version-file: '.nvmrc'\n - id: vars\n run: |\n echo \"pnpm-cache=$(pnpm store path --silent)\" >> $GITHUB_OUTPUT\n echo \"key=${{ runner.os }}-pnpm-${{ hashFiles('pnpm-lock.yaml') }}\" >> $GITHUB_OUTPUT\n - name: Cache NPM and Cypress 📦\n uses: actions/cache@v4\n id: cache\n with:\n path: |\n ${{ steps.vars.outputs.pnpm-cache }}\n ~/.cache/Cypress\n key: ${{ steps.vars.outputs.key }}\n restore-keys: |\n ${{ runner.os }}-pnpm-${{ hashFiles('pnpm-lock.yaml') }}\n ${{ runner.os }}-pnpm-\n - run: pnpm install --frozen-lockfile --prefer-offline\n env:\n HUSKY: '0' # By default do not run HUSKY install\n\n lint:\n name: lint\n runs-on: ubuntu-latest\n needs: cache\n steps:\n - uses: actions/checkout@v4\n - uses: pnpm/action-setup@v3\n - uses: actions/setup-node@v4\n with:\n node-version-file: '.nvmrc'\n - name: Cache NPM and Cypress 📦\n uses: actions/cache@v4\n id: cache\n with:\n path: |\n ${{ needs.cache.outputs.pnpm-cache }}\n ~/.cache/Cypress\n key: ${{ needs.cache.outputs.key }}\n restore-keys: |\n ${{ runner.os }}-pnpm-${{ hashFiles('pnpm-lock.yaml') }}\n ${{ runner.os }}-pnpm-\n - run: pnpm install --frozen-lockfile --prefer-offline\n env:\n HUSKY: '0' # By default do not run HUSKY install\n - run: pnpm lint:ci\n - run: pnpm format:ci\n\n test:\n name: test\n runs-on: ubuntu-latest\n needs: cache\n steps:\n - uses: actions/checkout@v4\n - uses: pnpm/action-setup@v3\n - uses: actions/setup-node@v4\n with:\n node-version-file: '.nvmrc'\n - name: Cache NPM and Cypress 📦\n uses: actions/cache@v4\n id: cache\n with:\n path: |\n ${{ needs.cache.outputs.pnpm-cache }}\n ~/.cache/Cypress\n key: ${{ needs.cache.outputs.key }}\n restore-keys: |\n ${{ runner.os }}-pnpm-${{ hashFiles('pnpm-lock.yaml') }}\n ${{ runner.os }}-pnpm-\n - run: pnpm install --frozen-lockfile --prefer-offline\n env:\n HUSKY: '0' # By default do not run HUSKY install\n - run: pnpm --filter cypress-plugin-visual-regression-diff -r build\n - name: Test e2e\n run: pnpm test:e2e:ci\n - name: Test component-testing\n run: pnpm test:ct:ci\n - uses: actions/upload-artifact@v4\n with:\n name: test\n path: |\n examples/next/**/*.png\n examples/next/**/*.jpg\n examples/next/**/*.jpeg\n\n test-integration-coverage:\n name: test-integration-coverage\n runs-on: ubuntu-latest\n needs: cache\n steps:\n - uses: actions/checkout@v4\n - uses: pnpm/action-setup@v3\n - uses: actions/setup-node@v4\n with:\n node-version-file: '.nvmrc'\n - name: Cache NPM and Cypress 📦\n uses: actions/cache@v4\n id: cache\n with:\n path: |\n ${{ needs.cache.outputs.pnpm-cache }}\n ~/.cache/Cypress\n key: ${{ needs.cache.outputs.key }}\n restore-keys: |\n ${{ runner.os }}-pnpm-${{ hashFiles('pnpm-lock.yaml') }}\n ${{ runner.os }}-pnpm-\n - run: pnpm install --frozen-lockfile --prefer-offline\n env:\n HUSKY: '0' # By default do not run HUSKY install\n - name: Test integration (with coverage) and upload to CodeClimate\n if: ${{ github.ref == 'refs/heads/main' }}\n uses: paambaati/codeclimate-action@v4.0.0\n env:\n CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}\n with:\n debug: true\n coverageCommand: pnpm test:integration:ci\n coverageLocations: |\n ${{github.workspace}}/packages/*/coverage/lcov.info:lcov\n - name: Test integration (with coverage)\n if: ${{ github.ref != 'refs/heads/main' }}\n run: pnpm test:integration:ci\n\n prepare-release:\n name: detect changes, bump package versions, generate changelog and commit it to main branch\n runs-on: ubuntu-latest\n needs: [cache, lint, test, test-integration-coverage]\n if: ${{ github.actor != 'dependabot[bot]' && github.ref == 'refs/heads/main' && github.event_name == 'push' }}\n permissions:\n contents: write\n pull-requests: write\n outputs:\n releases_created: ${{ steps.release.outputs.releases_created }}\n steps:\n - uses: google-github-actions/release-please-action@v3.7.13\n id: release\n with:\n command: manifest\n default-branch: main\n monorepo-tags: true\n \n build-and-release:\n name: build and release\n runs-on: ubuntu-latest\n needs: [cache, prepare-release]\n if: needs.prepare-release.outputs.releases_created\n steps:\n - uses: actions/checkout@v4\n - uses: pnpm/action-setup@v3\n - uses: actions/setup-node@v4\n with:\n node-version-file: '.nvmrc'\n registry-url: 'https://registry.npmjs.org'\n - name: Cache NPM and Cypress 📦\n uses: actions/cache@v4\n id: cache\n with:\n path: |\n ${{ needs.cache.outputs.pnpm-cache }}\n ~/.cache/Cypress\n key: ${{ needs.cache.outputs.key }}\n restore-keys: |\n ${{ runner.os }}-pnpm-${{ hashFiles('pnpm-lock.yaml') }}\n ${{ runner.os }}-pnpm-\n - run: pnpm install --frozen-lockfile --prefer-offline\n env:\n HUSKY: '0' # By default do not run HUSKY install\n - name: Build packages to get cross-references working 🔧\n run: pnpm build\n - name: Release package\n run: pnpm publish -r\n env:\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}\n GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n"
},
{
"path": ".gitignore",
"content": "# Logs\nlogs\n*.log\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\nlerna-debug.log*\n\n# Yarn\n.yarn/*\n*/.yarn\n!.yarn/patches\n!.yarn/plugins\n!.yarn/releases\n!.yarn/sdks\n!.yarn/versions\n.pnp.*\n\n# Diagnostic reports (https://nodejs.org/api/report.html)\nreport.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json\n\n# Runtime data\npids\n*.pid\n*.seed\n*.pid.lock\n\n# Directory for instrumented libs generated by jscoverage/JSCover\nlib-cov\n\n# Coverage directory used by tools like istanbul\ncoverage\n*.lcov\n\n# nyc test coverage\n.nyc_output\n\n# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)\n.grunt\n\n# Bower dependency directory (https://bower.io/)\nbower_components\n\n# node-waf configuration\n.lock-wscript\n\n# Compiled binary addons (https://nodejs.org/api/addons.html)\nbuild/Release\n\n# Dependency directories\nnode_modules/\njspm_packages/\n\n# TypeScript v1 declaration files\ntypings/\n\n# TypeScript cache\n*.tsbuildinfo\n\n# Optional npm cache directory\n.npm\n\n# Optional eslint cache\n.eslintcache\n\n# Microbundle cache\n.rpt2_cache/\n.rts2_cache_cjs/\n.rts2_cache_es/\n.rts2_cache_umd/\n\n# Optional REPL history\n.node_repl_history\n\n# Output of 'npm pack'\n*.tgz\n\n# Yarn Integrity file\n.yarn-integrity\n\n# dotenv environment variables file\n.env\n.env.test\n\n# parcel-bundler cache (https://parceljs.org/)\n.cache\n\n# Next.js build output\n.next\n\n# Nuxt.js build / generate output\n.nuxt\ndist\n\n# Gatsby files\n.cache/\n# Comment in the public line in if your project uses Gatsby and *not* Next.js\n# https://nextjs.org/blog/next-9-1#public-directory-support\n# public\n\n# vuepress build output\n.vuepress/dist\n\n# Serverless directories\n.serverless/\n\n# FuseBox cache\n.fusebox/\n\n# DynamoDB Local files\n.dynamodb/\n\n# TernJS port file\n.tern-port\n"
},
{
"path": ".nvmrc",
"content": "20.17.0\n"
},
{
"path": ".release-please-manifest.json",
"content": "{\n \"packages/cypress-plugin-visual-regression-diff\": \"3.3.10\"\n}\n"
},
{
"path": "CHANGELOG.md",
"content": "## [3.3.9](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.3.8...v3.3.9) (2023-06-12)\n\n## [3.3.8](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.3.7...v3.3.8) (2023-06-05)\n\n## [3.3.7](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.3.6...v3.3.7) (2023-06-05)\n\n## [3.3.6](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.3.5...v3.3.6) (2023-06-05)\n\n## [3.3.5](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.3.4...v3.3.5) (2023-05-29)\n\n## [3.3.4](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.3.3...v3.3.4) (2023-05-29)\n\n## [3.3.3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.3.2...v3.3.3) (2023-05-29)\n\n## [3.3.2](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.3.1...v3.3.2) (2023-05-29)\n\n## [3.3.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.3.0...v3.3.1) (2023-05-21)\n\n\n### Bug Fixes\n\n* **deps:** update all non-major dependency bump ([#228](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/228)) ([845590e](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/845590e25edc8c0372fcf25333454ec03e5f167b))\n\n# [3.3.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.15...v3.3.0) (2023-05-21)\n\n\n### Bug Fixes\n\n* **deps:** update dependency pngjs to v7 ([#215](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/215)) ([af71297](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/af71297f3d2ab180798bb64a46145919a6924c74))\n\n\n### Features\n\n* createMissingImages option ([#222](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/222)) ([2aef358](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/2aef35840e00299783ddede6f240c6005ac5bfcb)), closes [#204](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/204)\n* separate versioning for images ([#221](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/221)) ([b2a7434](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/b2a74340fc2616aa16d54a4dfbd43ddbfdd24eb1)), closes [#197](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/197)\n\n## [3.2.15](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.14...v3.2.15) (2023-05-21)\n\n## [3.2.14](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.13...v3.2.14) (2023-03-26)\n\n## [3.2.13](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.12...v3.2.13) (2023-03-26)\n\n## [3.2.12](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.11...v3.2.12) (2023-03-26)\n\n\n### Bug Fixes\n\n* import meta-png cjs dependency ([#209](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/209)) ([41aeee5](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/41aeee52c362e4a1817a9e364963c4aff1407d0a)), closes [#207](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/207)\n\n## [3.2.11](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.10...v3.2.11) (2023-03-26)\n\n\n### Bug Fixes\n\n* treat maxDiffThreshold 0 as valid value ([f4d3ec9](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/f4d3ec946547d648d1ec8ea9ccf9369540255adf))\n\n## [3.2.10](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.9...v3.2.10) (2023-03-26)\n\n\n### Bug Fixes\n\n* add missing forceDeviceScaleFactor option ([ba7d2f1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/ba7d2f15b57390bb1ef69de6f7ed979438155444))\n\n## [3.2.9](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.8...v3.2.9) (2023-03-26)\n\n## [3.2.8](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.7...v3.2.8) (2022-12-18)\n\n## [3.2.7](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.6...v3.2.7) (2022-12-14)\n\n## [3.2.6](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.5...v3.2.6) (2022-12-11)\n\n## [3.2.5](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.4...v3.2.5) (2022-12-09)\n\n## [3.2.4](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.3...v3.2.4) (2022-12-04)\n\n## [3.2.3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.2...v3.2.3) (2022-11-30)\n\n\n### Bug Fixes\n\n* **deps:** update all non-major dependencies ([#191](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/191)) ([26e6d8b](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/26e6d8bce436243020dbc645e32d70fbdaca993b))\n\n## [3.2.2](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.1...v3.2.2) (2022-11-29)\n\n\n### Bug Fixes\n\n* return launchOptions so they are applied ([#186](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/186)) ([b1b9056](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/b1b905613c899af6d14af920e34290533c26c545))\n\n## [3.2.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.2.0...v3.2.1) (2022-11-29)\n\n\n### Bug Fixes\n\n* update images via GUI in Cypress 11 ([#193](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/193)) ([bdebca2](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/bdebca28aea1dea63473243679a5a71e6b21f165)), closes [#187](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/187)\n\n# [3.2.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.1.7...v3.2.0) (2022-11-29)\n\n\n### Features\n\n* support Cypress 11 ([#192](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/192)) ([7bd1a24](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/7bd1a24bcc5f38531d91845c141dd9a5713dec7e)), closes [#187](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/187)\n\n## [3.1.7](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.1.6...v3.1.7) (2022-11-23)\n\n## [3.1.6](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.1.5...v3.1.6) (2022-11-19)\n\n## [3.1.5](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.1.4...v3.1.5) (2022-11-12)\n\n## [3.1.4](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.1.3...v3.1.4) (2022-11-10)\n\n## [3.1.3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.1.2...v3.1.3) (2022-11-09)\n\n## [3.1.2](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.1.1...v3.1.2) (2022-11-07)\n\n\n### Bug Fixes\n\n* **deps:** update dependency sharp to v0.31.2 ([#174](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/174)) ([c2bce9d](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/c2bce9dda3a70635270375f99c17d458f4cf39b8))\n\n## [3.1.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.1.0...v3.1.1) (2022-11-04)\n\n\n### Bug Fixes\n\n* new image prefix starts at -1 ([#172](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/172)) ([8279208](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/8279208c2ec6dbbbf7dd846463f684f19dfe0df6))\n\n# [3.1.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.0.4...v3.1.0) (2022-11-03)\n\n\n### Features\n\n* support Cypress retries functionality ([#171](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/171)) ([7d7d010](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/7d7d010938ee124e694e8cf0270aa99c89db59df)), closes [#168](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/168)\n\n## [3.0.4](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.0.3...v3.0.4) (2022-11-03)\n\n\n### Bug Fixes\n\n* typings for older typescript ([#170](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/170)) ([96499ec](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/96499ecc2959bab8c39b599ba7eb87fbd79ceec3)), closes [#167](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/167)\n\n## [3.0.3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.0.2...v3.0.3) (2022-11-01)\n\n\n### Bug Fixes\n\n* ts declaration generation ([1a1e0cc](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/1a1e0ccd4c442d3e4d45f4d899139a08963e0c85))\n\n## [3.0.2](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.0.1...v3.0.2) (2022-10-27)\n\n\n### Bug Fixes\n\n* **deps:** update all non-major dependencies ([#165](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/165)) ([602640f](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/602640fcca6e8173930efa116244258549aa5264))\n\n## [3.0.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v3.0.0...v3.0.1) (2022-10-26)\n\n\n### Bug Fixes\n\n* reset name cache after tests run ([bfbf138](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/bfbf138fa52de06072db32a0181821b56ca5230f))\n\n# [3.0.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.12...v3.0.0) (2022-10-26)\n\n\n### Bug Fixes\n\n* security vulnerability ([d6f849c](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/d6f849cb017e452d9f121866a6429d4bee4b5f18))\n\n\n### Features\n\n* add matchAgainstPath option ([#146](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/146)) ([7a5e3a8](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/7a5e3a8ec5aa766e38ee372e11a6d1c155105126)), closes [#88](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/88)\n* auto clean unused files ([#124](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/124)) ([38679a7](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/38679a730edc4083b4bc751b19bc161bbb72d159)), closes [#118](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/118)\n* introduce imagesPath option ([#152](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/152)) ([961e137](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/961e137099ba22aa9f0b6d36e6e73d495196a764)), closes [#147](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/147)\n\n\n### BREAKING CHANGES\n\n* deprecate imagesDir option in favor of imagesPath - see docs for additional information\n* To use autocleanup feature you need to update all of the screenshots, best do it by running your test suite with cypress env 'pluginVisualRegressionUpdateImages' set to true.\n* matchImage returns object containing comparison details from now on (previously was returning subject element from a chain)\n\n## [2.3.12](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.11...v2.3.12) (2022-10-22)\n\n## [2.3.11](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.10...v2.3.11) (2022-10-19)\n\n## [2.3.10](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.9...v2.3.10) (2022-10-15)\n\n## [2.3.9](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.8...v2.3.9) (2022-10-14)\n\n## [2.3.8](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.7...v2.3.8) (2022-10-12)\n\n## [2.3.7](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.6...v2.3.7) (2022-10-12)\n\n## [2.3.6](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.5...v2.3.6) (2022-10-12)\n\n\n### Bug Fixes\n\n* **deps:** update dependency @frsource/base64 to v1.0.3 ([#144](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/144)) ([09ecbd8](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/09ecbd81c9978161de2a782cf3bc735ce8d6ca3f))\n\n## [2.3.5](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.4...v2.3.5) (2022-10-10)\n\n## [2.3.4](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.3...v2.3.4) (2022-10-10)\n\n## [2.3.3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.2...v2.3.3) (2022-10-10)\n\n## [2.3.2](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.1...v2.3.2) (2022-10-09)\n\n## [2.3.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.3.0...v2.3.1) (2022-10-06)\n\n\n### Bug Fixes\n\n* security vulnerabilities ([d0bda44](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/d0bda44d3055cd578381406a06607bfba48ff447))\n\n# [2.3.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.12...v2.3.0) (2022-10-06)\n\n\n### Features\n\n* show comparison for successful tests ([#137](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/137)) ([c09bab3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/c09bab3ef805de24fc7cbcc8c738137c35e3fe18)), closes [#104](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/104)\n\n## [2.2.12](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.11...v2.2.12) (2022-10-06)\n\n\n### Bug Fixes\n\n* **deps:** update dependency sharp to v0.31.1 ([#132](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/132)) ([15f0f5d](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/15f0f5d2824cba32d4611289442abd637d8438f5))\n\n## [2.2.11](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.10...v2.2.11) (2022-09-28)\n\n\n### Bug Fixes\n\n* **deps:** update dependency vue to v3.2.40 ([#131](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/131)) ([537fd16](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/537fd16c4507c394998c0c7f0da7cff18e2d35c5))\n\n## [2.2.10](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.9...v2.2.10) (2022-09-28)\n\n## [2.2.9](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.8...v2.2.9) (2022-09-27)\n\n## [2.2.8](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.7...v2.2.8) (2022-09-26)\n\n## [2.2.7](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.6...v2.2.7) (2022-09-26)\n\n## [2.2.6](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.5...v2.2.6) (2022-09-25)\n\n\n### Bug Fixes\n\n* remove alias leftovers from dist bundles ([407ce79](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/407ce79c6a6e00b509fd504f4cf615b3e3c504c3))\n\n## [2.2.5](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.4...v2.2.5) (2022-09-24)\n\n## [2.2.4](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.3...v2.2.4) (2022-09-24)\n\n## [2.2.3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.2...v2.2.3) (2022-09-24)\n\n## [2.2.2](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.1...v2.2.2) (2022-09-24)\n\n## [2.2.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.2.0...v2.2.1) (2022-09-24)\n\n# [2.2.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.1.0...v2.2.0) (2022-09-23)\n\n\n### Features\n\n* migrate to @frsource/base64 package ([e4f3a14](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/e4f3a14575648b76d4f41eeb5984b853b968c974))\n\n# [2.1.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.0.3...v2.1.0) (2022-09-23)\n\n\n### Features\n\n* provide modern exports ([5c911a1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/5c911a113624cea79e8b09eba2e643954a04a057))\n\n## [2.0.3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.0.2...v2.0.3) (2022-09-23)\n\n## [2.0.2](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.0.1...v2.0.2) (2022-09-22)\n\n## [2.0.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v2.0.0...v2.0.1) (2022-09-17)\n\n# [2.0.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.21...v2.0.0) (2022-09-15)\n\n\n### Features\n\n* img diff when resolution differs ([#108](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/108)) ([c8a5044](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/c8a504480d09f6ffd34321163bf14b1a2f0e7bb0)), closes [#94](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/94)\n\n\n### BREAKING CHANGES\n\n* different resolution doesn't fail test immediately - img diff is being done\n\n## [1.9.21](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.20...v1.9.21) (2022-09-14)\n\n\n### Bug Fixes\n\n* btoa utf8 encoding/decoding error ([#114](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/114)) ([0137014](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/01370148094f3152a374f4e612e75ef5fd2bc3d8))\n\n## [1.9.20](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.19...v1.9.20) (2022-09-13)\n\n## [1.9.19](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.18...v1.9.19) (2022-09-12)\n\n## [1.9.18](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.17...v1.9.18) (2022-09-09)\n\n## [1.9.17](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.16...v1.9.17) (2022-09-08)\n\n\n### Bug Fixes\n\n* **deps:** update dependency vue to v3.2.39 ([#110](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/110)) ([8a7f055](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/8a7f0555b1d664b83c7de64d93796408646704eb))\n\n## [1.9.16](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.15...v1.9.16) (2022-09-05)\n\n## [1.9.15](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.14...v1.9.15) (2022-09-03)\n\n## [1.9.14](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.13...v1.9.14) (2022-09-02)\n\n\n### Bug Fixes\n\n* image diff calculation ([529cb22](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/529cb22a22200af234bdbc1399b6f97880001d12)), closes [#107](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/107)\n\n## [1.9.13](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.12...v1.9.13) (2022-08-31)\n\n\n### Bug Fixes\n\n* **deps:** update dependency vue to v3.2.38 ([#101](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/101)) ([e2d3c82](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/e2d3c823822ecb6738202599500435cf59f2f6d1))\n\n## [1.9.12](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.11...v1.9.12) (2022-08-30)\n\n## [1.9.11](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.10...v1.9.11) (2022-08-30)\n\n## [1.9.10](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.9...v1.9.10) (2022-08-27)\n\n## [1.9.9](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.8...v1.9.9) (2022-08-26)\n\n## [1.9.8](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.7...v1.9.8) (2022-08-25)\n\n## [1.9.7](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.6...v1.9.7) (2022-08-23)\n\n## [1.9.6](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.5...v1.9.6) (2022-08-22)\n\n## [1.9.5](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.4...v1.9.5) (2022-08-22)\n\n## [1.9.4](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.3...v1.9.4) (2022-08-21)\n\n## [1.9.3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.2...v1.9.3) (2022-08-17)\n\n## [1.9.2](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.1...v1.9.2) (2022-08-09)\n\n## [1.9.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.9.0...v1.9.1) (2022-08-09)\n\n# [1.9.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.8.10...v1.9.0) (2022-08-09)\n\n\n### Features\n\n* add title option to matchImage command ([#81](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/81)) ([4d03866](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/4d03866f7f171473b16b4a7c869fbca02d5f46d1))\n\n## [1.8.10](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.8.9...v1.8.10) (2022-08-02)\n\n## [1.8.9](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.8.8...v1.8.9) (2022-08-01)\n\n## [1.8.8](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.8.7...v1.8.8) (2022-07-19)\n\n## [1.8.7](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.8.6...v1.8.7) (2022-07-17)\n\n## [1.8.6](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.8.5...v1.8.6) (2022-07-12)\n\n\n### Bug Fixes\n\n* **deps:** pin dependency vue to 3.2.37 ([#68](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/68)) ([d09a762](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/d09a762bbcf0f6e9bb886f80e4d01724bf0e3367))\n\n## [1.8.5](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.8.4...v1.8.5) (2022-07-07)\n\n## [1.8.4](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.8.3...v1.8.4) (2022-07-04)\n\n## [1.8.3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.8.2...v1.8.3) (2022-06-29)\n\n## [1.8.2](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.8.1...v1.8.2) (2022-06-27)\n\n## [1.8.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.8.0...v1.8.1) (2022-06-27)\n\n\n### Bug Fixes\n\n* remove automated screenshots update ([acb3ef0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/acb3ef08fb8ec5129bee9883431361dd804d23f3))\n\n# [1.8.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.7.8...v1.8.0) (2022-06-27)\n\n\n### Bug Fixes\n\n* **deps:** update dependency move-file to v3 ([#62](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/62)) ([4f6eaf6](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/4f6eaf64a0f3db6e54190ef7532059a451ad384f))\n\n\n### Features\n\n* make library cypress 10 compatible ([b26beb3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/b26beb391cf440d2d4b01261271b7acffa6f600e))\n* make plugin Cypress 10 compatible ([a03a17d](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/a03a17d7295dd811969c10ad562dda26795fd8f2))\n\n## [1.7.8](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.7.7...v1.7.8) (2022-06-24)\n\n## [1.7.7](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.7.6...v1.7.7) (2022-06-24)\n\n## [1.7.6](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.7.5...v1.7.6) (2022-06-24)\n\n\n### Bug Fixes\n\n* **deps:** update dependency pixelmatch to v5.3.0 ([#55](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/55)) ([ca5d278](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/ca5d2784a5fffb60bebe7643f8beced6ad9979bd))\n\n## [1.7.5](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.7.4...v1.7.5) (2022-06-24)\n\n## [1.7.4](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.7.3...v1.7.4) (2022-06-24)\n\n## [1.7.3](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.7.2...v1.7.3) (2022-06-23)\n\n## [1.7.2](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.7.1...v1.7.2) (2022-06-23)\n\n## [1.7.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.7.0...v1.7.1) (2022-03-15)\n\n\n### Bug Fixes\n\n* sanitize screenshot filenames ([fc57380](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/fc57380d40e72eec51d5fdf2615226a358efa070))\n\n# [1.7.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.6.0...v1.7.0) (2022-03-01)\n\n\n### Features\n\n* don't override screenshots if not needed ([9066017](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/90660179d05f4de1c803888fb66f8e1c240f7c37))\n\n# [1.6.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.5.0...v1.6.0) (2022-02-25)\n\n\n### Features\n\n* show scrollbar for overflowing images ([de994b9](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/de994b98ad3dea233aee70b0142992a309476e38))\n\n# [1.5.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.4.0...v1.5.0) (2022-02-24)\n\n\n### Features\n\n* add forceDeviceFactor option ([8d69632](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/8d6963222f924d73fc0aed08adecdb361104c2dc))\n\n# [1.4.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.3.1...v1.4.0) (2022-02-21)\n\n\n### Features\n\n* add possibility to change images dirname ([b831e94](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/b831e94677df906f0cbd889f7ce0994e1e8a7783))\n\n## [1.3.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.3.0...v1.3.1) (2021-11-23)\n\n\n### Bug Fixes\n\n* create missing dirs when renaming screenshot files ([38e5ff5](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/38e5ff5d5f7c2a8d9b971deb13af821773815f66))\n\n# [1.3.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.2.0...v1.3.0) (2021-11-09)\n\n\n### Bug Fixes\n\n* text overflowing when image is small ([3b04f8e](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/3b04f8e1782754c4c48e946ebdb2f43ccfec9461))\n\n\n### Features\n\n* externalize important APIs ([9f94086](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/9f9408657e7970bdad5dfc7a599943a34a779ab7))\n\n# [1.2.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.1.0...v1.2.0) (2021-10-26)\n\n\n### Features\n\n* stop logging all of the tasks ([573e728](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/573e7282799c802b0f6e9ecbe66501d043745ac3))\n\n# [1.1.0](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.0.1...v1.1.0) (2021-10-25)\n\n\n### Features\n\n* add queue flushing in after block ([70f828f](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/70f828ff68c4de276dd10c64ab61fece573d305f))\n\n## [1.0.1](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/v1.0.0...v1.0.1) (2021-10-25)\n\n\n### Bug Fixes\n\n* proper readme info ([dd87e19](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/dd87e19429fe232bd9027737ff7e218c52d8eb06))\n\n# 1.0.0 (2021-10-25)\n\n\n### Features\n\n* add typings ([0a0e8e6](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/0a0e8e63ba1df0f95cf81ba6b0b34a095a0b69be))\n* first implementation ([388cccf](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/388cccf5f033010e4de9f88294f5fca30c6d0cd1))\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# @frsource/cypress-plugin-visual-regression-diff Contributing Guide\n\nHey! It’s really exciting for us to see your interest in contributing to this library. Before taking off with your work, please take a moment to read through these guidelines:\n\n- [Code of Conduct](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/blob/master/CODE_OF_CONDUCT.md)\n- [Questions?](#questions)\n- [Reporting an issue or a feature request](#reporing-an-issue-or-a-feature-request)\n- [Pull Request Guidelines](#pull-request-guidelines)\n- [Development Setup](#development-setup)\n\n## Questions?\n\nDon’t hesitate to ask a question directly on the [discussions board](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/discussions)!\n\n## Reporting an issue or a feature request\n\n- Please always use GitHub Issues tracker with [appropriate template](https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FFRSOURCE%2Fcypress-plugin-visual-regression-diff%2Fissues%2Fnew%2Fchoose) to create a new issue or suggestion\n\n## Pull Request Guidelines\n\n- Check if there isn’t a similar PR already in the [GitHub Pull requests](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/pulls) - maybe somebody already has covered this topic?\n\n- Checkout the master branch and (after you do your work) file a PR against it\n\n- Read through the [development setup](#development-setup) to learn how to work with this project. Always make sure that `pnpm lint`, `pnpm build` and `pnpm test` pass\n\n- Please use [conventional commits v1.0.0 style guide](https://www.conventionalcommits.org/en/v1.0.0/) for commits and PR names\n\n- We have no preference about number of commits on the PR - they will be all squashed by GitHub while merging\n\n- When creating a new feature/plugin/integration:\n\n - Make sure the feature is covered by tests\n - Provide a meaningful description. In most cases it would make sens to first open a issue with a suggestion, discuss about it and have it approved before working on it\n\n- When fixing bug:\n - Try to cover the scenario with tests if possible\n - If an issue for this bug already exists, please reference it via (`Refs: #XYZ` - where `XYZ` is an issue number) at the very bottom of your commit message and PR description as proposed by [conventional commits v1.0.0 style guide](https://www.conventionalcommits.org/en/v1.0.0/#commit-message-with-multi-paragraph-body-and-multiple-footers)\n - If there is no issue connected with the bug, please provide a detailed description of the problem in the PR. Live demo preferred ([look for the codeine example project in the bug issue template](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/blob/master/.github/ISSUE_TEMPLATE/bug_report.md))\n\n## Development Setup\n\n\n\nYou will need [Node.js](https://nodejs.org/en/) **version 16+** and [pnpm](https://pnpm.io/installation).\n\n\n\nAfter cloning the repository, run:\n\n```bash\npnpm i # installs the project dependencies\n```\n\n### Committing Changes\n\nCommit messages should follow the [conventional commits v1.0.0](https://www.conventionalcommits.org/en/v1.0.0/) so that changelogs can be automatically generated. Commit messages will be automatically validated upon commit.\n\n### These npm scripts are available in the repo\n\nWhen fired in the project root they will run corresponding actions in every nested package at once.\n\n```bash\n# build the project for NPM and example usage\n$ pnpm build\n\n# run tests once\n$ pnpm test\n\n# open cypress component runner from example directory\n# requires plugin to be built first via `pnpm build`\n$ pnpm test:ct\n\n# open cypress e2e runner from example directory\n# requires plugin to be built first via `pnpm build`\n$ pnpm test:e2e\n\n# run integration tests once and collect coverage\n$ pnpm test:integration:coverage\n\n# run integration tests in watch mode\n$ pnpm test:integration:watch\n\n# lint & try to autofix linting errors\n$ pnpm fix:lint && pnpm format\n\n# lint files\n$ pnpm lint && pnpm format:ci\n```\n\nThere are some other scripts available in the `scripts` section of the `package.json` file.\n\n## Credits\n\nMany thanks to all the people who have already contributed to @frsource/cypress-plugin-visual-regression-diff! ❤️\n"
},
{
"path": "LICENSE",
"content": "MIT License\n\nCopyright (c) 2021 FRSOURCE - Let's shape your web\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
{
"path": "README.md",
"content": "\n \n \n \n \n \n \n \n \n \n \n \n \n
\n\n\n
\n\nPlugin for Cypress - Visual Regression Diff \nPerform visual regression test with a nice GUI as help. 💅 Only for Cypress! Both e2e and component-testing compatible 💪
\n\n\n Getting Started \n ·\n Usage \n ·\n FAQ \n ·\n File an Issue \n ·\n Have a question or an idea? \n
\n\n\n Plugin for visual regression testing that provides smooth experience:\n microbundle .\n typescript . \n
\n\n\n\n## Getting started\n\n### Installation\n\nYou can install this library using your favorite package manager:\n\n```bash\n# npm\nnpm install --save-dev @frsource/cypress-plugin-visual-regression-diff\n\n# yarn\nyarn add -D @frsource/cypress-plugin-visual-regression-diff\n\n# pnpm\npnpm add -D @frsource/cypress-plugin-visual-regression-diff\n```\n\nNext, you need to import the library:\n\n- first, in your support file (located by default in `cypress/support/index.js`):\n\n```ts\n// typescript / ES6\nimport \"@frsource/cypress-plugin-visual-regression-diff\";\n\n// javascript\nrequire(\"@frsource/cypress-plugin-visual-regression-diff\");\n```\n\n- secondly:\n - (for Cypress 10.0+) in `cypress.config.js` (or `cypress.config.ts`):\n\n```ts\n// typescript / ES6\nimport { defineConfig } from \"cypress\";\nimport { initPlugin } from \"@frsource/cypress-plugin-visual-regression-diff/plugins\";\n\nexport default defineConfig({\n // initPlugin must be called in the section where it is used: e2e or component\n e2e: {\n setupNodeEvents(on, config) {\n initPlugin(on, config);\n },\n },\n component: {\n setupNodeEvents(on, config) {\n initPlugin(on, config);\n },\n },\n});\n```\n\n- (for Cypress <10.0) in your plugins file (located by default in `cypress/plugins/index.js`):\n\n```ts\n// typescript / ES6\nimport { initPlugin } from \"@frsource/cypress-plugin-visual-regression-diff/plugins\";\n\nexport default function (\n on: Cypress.PluginEvents,\n config: Cypress.PluginConfigOptions\n) {\n initPlugin(on, config);\n\n return config;\n}\n\n// javascript\nconst {\n initPlugin,\n} = require(\"@frsource/cypress-plugin-visual-regression-diff/plugins\");\n\nmodule.exports = function (on, config) {\n initPlugin(on, config);\n\n return config;\n};\n```\n\nThat's it - now let's see how to use the library in [usage section](#usage).\n\n## Usage\n\nOnce installed, the library might be used by writing in your test:\n\n```ts\ncy.get(\".an-element-of-your-choice\").matchImage();\n```\n\nOr, if you would like to make a screenshot of whole document:\n\n```ts\ncy.matchImage();\n```\n\n`matchImage` command will do a screenshot and compare it with image from a previous run. In case of regression the test will fail and you'll get a \"See comparison\" button to see what's a root of a problem.\n\n## Example\n\nStill got troubles with installation? Have a look at [examples directory of this repo](./examples) to see how this plugin can be used in e2e or component-testing Cypress environment within your project.\n\n## Automatic clean up of unused images\n\nIt's useful to remove screenshots generated by the visual regression plugin that are not used by any test anymore.\nEnable this feature via env variable and enjoy freed up storage space 🚀:\n\n```bash\nnpx cypress run --env \"pluginVisualRegressionCleanupUnusedImages=true\"\n```\n\n## Configuration\n\nConfigure the plugin:\n\n- by passing in configuration as an argument to `matchImage` command:\n\n```ts\ncy.matchImage({\n // screenshot configuration, passed directly to the the Cypress screenshot method: https://docs.cypress.io/api/cypress-api/screenshot-api#Arguments\n // default: { }\n screenshotConfig: {\n blackout: ['.element-to-be-blackouted']\n },\n // pixelmatch options, see: https://www.npmjs.com/package/pixelmatch#pixelmatchimg1-img2-output-width-height-options\n // default: { includeAA: true }\n diffConfig: {\n threshold: 0.01,\n },\n // whether to create missing baseline images automatically\n // default: true\n createMissingImages: false,\n // whether to update images automatically, without making a diff - useful for CI\n // default: false\n updateImages: true,\n // directory path in which screenshot images will be stored\n // relative path are resolved against project root\n // absolute paths (both on unix and windows OS) supported\n // path separators will be normalised by the plugin depending on OS, you should always use / as path separator, e.g.: C:/my-directory/nested for windows-like drive notation\n // There are one special variable available to be used in the path:\n // - {spec_path} - relative path leading from project root to the current spec file directory (e.g. `/src/components/my-tested-component`)\n // default: '{spec_path}/__image_snapshots__'\n imagesPath: 'this-might-be-your-custom/maybe-nested-directory',\n // maximum threshold above which the test should fail\n // default: 0.01\n maxDiffThreshold: 0.1,\n // forces scale factor to be set as value \"1\"\n // helps with screenshots being scaled 2x on high-density screens like Mac Retina\n // default: true\n forceDeviceScaleFactor: false,\n // title used for naming the image file\n // default: Cypress.currentTest.titlePath (your test title)\n title: `${Cypress.currentTest.titlePath.join(' ')} (${Cypress.browser.displayName})`,\n // pass a path to custom image that should be used for comparison\n // instead of checking against the image from previous run\n // default: undefined\n matchAgainstPath: '/path/to/reference-image.png'\n})\n```\n\n- via [global env configuration](https://docs.cypress.io/guides/guides/environment-variables#Setting). Environment variable names are the same as keys of the configuration object above, but with added `pluginVisualRegression` prefix, e.g.:\n\n```bash\nnpx cypress run --env \"pluginVisualRegressionUpdateImages=true,pluginVisualRegressionDiffConfig={\\\"threshold\\\":0.01}\"\n```\n\n```ts\n// cypress.config.ts\nimport { defineConfig } from \"cypress\";\n\nexport default defineConfig({\n env: {\n pluginVisualRegressionUpdateImages: true,\n pluginVisualRegressionDiffConfig: { threshold: 0.01 },\n },\n});\n```\n\n```json\n// cypress.env.json (https://docs.cypress.io/guides/guides/environment-variables#Option-2-cypress-env-json)\n{\n \"pluginVisualRegressionUpdateImages\": true,\n \"pluginVisualRegressionDiffConfig\": { \"threshold\": 0.01 }\n}\n```\n\nFor more ways of setting environment variables [take a look here](https://docs.cypress.io/guides/guides/environment-variables#Setting).\n\n## FAQ\n\nWhy screenshots doesn't conform to the `viewport` set in my Cypress configuration? \n\nScreenshots in Cypress do not scale to the viewport size by default. You can change this behavior:\n\n- globally, by changing default screenshot configuration: Cypress.Screenshot.defaults({ capture: 'viewport' });\n- locally, by passing screenshot configuration directly to the .matchImage command: cy.matchImage({ screenshotConfig: { capture: 'viewport' } });\n\nI've upgraded version of this plugin and all on my baseline images has been automatically updated. Why? \n\nSometimes we need to do a breaking change in image comparison or image generation algorithms. To provide you with the easiest upgrade path - the plugin updates your baseline images automatically. Just commit them to your repository after the plugin upgrade and you are good to go!\n\n\n\n \n
\n"
},
{
"path": "eslint.config.mjs",
"content": "import { typescript, javascript } from '@frsource/eslint-config';\nimport globals from 'globals';\nimport cypress from 'eslint-plugin-cypress/flat'\n\n/** @type {import(\"eslint\").Linter.Config[]} */\nexport default [\n ...javascript,\n ...typescript,\n { ignores: ['**/dist', '**/coverage', '**/node_modules'] },\n { rules: { '@typescript-eslint/no-invalid-void-type': 'off' } },\n {\n plugins: { cypress },\n files: ['examples/*/cypress/**', 'packages/*/src/**'],\n languageOptions: {\n globals: {\n ...globals.es2021,\n ...globals.node,\n ...cypress.globals,\n },\n },\n },\n];\n"
},
{
"path": "examples/next/.gitignore",
"content": "# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.\n\n# dependencies\n/node_modules\n/.pnp\n.pnp.js\n\n# testing\n/coverage\n\n# we do not want to commit local screenshot files\n# as they might be different on different OSes\n**/__image_snapshots_local__\n\n# next.js\n/.next/\n/out/\n\n# production\n/build\n\n# misc\n.DS_Store\n*.pem\n\n# debug\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\n\n# local env files\n.env*.local\n\n# vercel\n.vercel\n\n# typescript\n*.tsbuildinfo\nnext-env.d.ts\n\n# cypress\n/cypress/screenshots\n/cypress/videos\n"
},
{
"path": "examples/next/README.md",
"content": "# Next.js + Cypress + @frsource/cypress-plugin-visual-regression-diff\n\nThis example shows how to configure @frsource/cypress-plugin-visual-regression-diff to work with Cypress & Next.js.\n\n## Project setup\n\n```bash\npnpm install\n```\n\n### Run end-to-end tests\n\n> Important - remember to run `pnpm && pnpm build` command in this repo's root directory before starting e2e tests.\n\n```bash\npnpm e2e\n```\n\n### Run component tests\n\n> Important - remember to run `pnpm && pnpm build` command in this repo's root directory before starting e2e tests.\n\n```bash\npnpm component\n```\n\n### Compiles and hot-reloads for development\n\n```bash\npnpm dev\n```\n\n### Compiles and minifies for production\n\n```bash\npnpm build\n```\n\n## Credits\n\nCreated using [Next.js Cypress template](https://nextjs.org/docs/pages/building-your-application/optimizing/testing#cypress).\n"
},
{
"path": "examples/next/components/about-component.cy.tsx",
"content": "import AboutComponent from './about-component'\n// Disable ESLint to prevent failing linting inside the Next.js repo.\n// If you're using ESLint on your project, we recommend installing the ESLint Cypress plugin instead:\n// https://github.com/cypress-io/eslint-plugin-cypress\n\ndescribe('About Page \n \n
\n \n )\n}\n"
},
{
"path": "examples/next/cypress/e2e/app.cy.ts",
"content": "describe(\"Navigation\", () => {\n it(\"should navigate to the about page\", () => {\n cy.visit(\"http://localhost:3000/\");\n\n cy.get('a[href*=\"about\"]').click();\n\n cy.url().should(\"include\", \"/about\");\n\n cy.matchImage().then(({ imgNewPath }) => {\n // match against image from custom path\n cy.matchImage({ matchAgainstPath: imgNewPath });\n });\n });\n});\n\nexport {};\n"
},
{
"path": "examples/next/cypress/fixtures/example.json",
"content": "{\n \"name\": \"Using fixtures to represent data\",\n \"email\": \"hello@cypress.io\",\n \"body\": \"Fixtures are a great way to mock data for responses to routes\"\n}\n"
},
{
"path": "examples/next/cypress/support/commands.ts",
"content": "/// \n// drag(subject: string, options?: Partial): Chainable\n// dismiss(subject: string, options?: Partial): Chainable\n// visit(originalFn: CommandOriginalFn, url: string, options: Partial): Chainable\n// }\n// }\n// }\n\nimport \"@frsource/cypress-plugin-visual-regression-diff/dist/support\";\n\n// Prevent TypeScript from reading file as legacy script\nexport {};\n"
},
{
"path": "examples/next/cypress/support/component-index.html",
"content": "\n\n \n Components App \n \n
\n \n \n
\n \n\n"
},
{
"path": "examples/next/cypress/support/component.ts",
"content": "// ***********************************************************\n// This example support/component.ts is processed and\n// loaded automatically before your test files.\n//\n// This is a great place to put global configuration and\n// behavior that modifies Cypress.\n//\n// You can change the location of this file or turn off\n// automatically serving support files with the\n// 'supportFile' configuration option.\n//\n// You can read more here:\n// https://on.cypress.io/configuration\n// ***********************************************************\n\n// Import commands.js using ES2015 syntax:\nimport \"./commands\";\n\n// Alternatively you can use CommonJS syntax:\n// require('./commands')\n\nimport { mount } from \"cypress/react18\";\n\n// Augment the Cypress namespace to include type definitions for\n// your custom command.\n// Alternatively, can be defined in cypress/support/component.d.ts\n// with a \n \n
Create Next App \n
\n
\n \n\n
\n \n\n \n Get started by editing{' '}\n pages/index.js\n
\n\n \n \n\n
\n \n Powered by{' '}\n \n \n \n \n
Components App \n \n \n
\n \n\n"
},
{
"path": "examples/webpack/cypress/support/component.ts",
"content": "// ***********************************************************\n// This example support/component.js is processed and\n// loaded automatically before your test files.\n//\n// This is a great place to put global configuration and\n// behavior that modifies Cypress.\n//\n// You can change the location of this file or turn off\n// automatically serving support files with the\n// 'supportFile' configuration option.\n//\n// You can read more here:\n// https://on.cypress.io/configuration\n// ***********************************************************\n\n// Import commands.js using ES2015 syntax:\nimport \"./commands.ts\";\n\n// Alternatively you can use CommonJS syntax:\n// require('./commands')\n"
},
{
"path": "examples/webpack/cypress/support/e2e.ts",
"content": "// ***********************************************************\n// This example support/component.js is processed and\n// loaded automatically before your test files.\n//\n// This is a great place to put global configuration and\n// behavior that modifies Cypress.\n//\n// You can change the location of this file or turn off\n// automatically serving support files with the\n// 'supportFile' configuration option.\n//\n// You can read more here:\n// https://on.cypress.io/configuration\n// ***********************************************************\n\n// Import commands.js using ES2015 syntax:\nimport \"./commands\";\n\n// Alternatively you can use CommonJS syntax:\n// require('./commands')\n"
},
{
"path": "examples/webpack/cypress.config.ts",
"content": "import { defineConfig } from \"cypress\";\nimport { initPlugin } from \"@frsource/cypress-plugin-visual-regression-diff/plugins\";\n\nmodule.exports = defineConfig({\n video: false,\n e2e: {\n setupNodeEvents(on, config) {\n initPlugin(on, config);\n },\n specPattern: \"cypress/e2e/**/*.cy.{js,jsx,ts,tsx}\",\n },\n\n component: {\n setupNodeEvents(on, config) {\n initPlugin(on, config);\n },\n devServer: {\n framework: \"vue-cli\",\n bundler: \"webpack\",\n },\n },\n});\n"
},
{
"path": "examples/webpack/package.json",
"content": "{\n \"name\": \"example\",\n \"version\": \"0.1.0\",\n \"private\": true,\n \"scripts\": {\n \"serve\": \"vue-cli-service serve\",\n \"build\": \"vue-cli-service build\",\n \"test:open\": \"vue-cli-service test:e2e --env \\\"pluginVisualRegressionImagesPath={spec_path}/__image_snapshots_local__\\\"\",\n \"test:run\": \"vue-cli-service test:e2e\",\n \"test:ct\": \"pnpm test:open --component\",\n \"test:ct:ci\": \"pnpm test:run --component --headless\",\n \"test:e2e\": \"pnpm test:open --e2e\",\n \"test:e2e:ci\": \"pnpm test:run --e2e --headless\"\n },\n \"dependencies\": {\n \"vue\": \"3.2.45\"\n },\n \"devDependencies\": {\n \"@frsource/cypress-plugin-visual-regression-diff\": \"workspace:*\",\n \"@vue/cli-plugin-e2e-cypress\": \"5.0.8\",\n \"@vue/cli-service\": \"5.0.8\",\n \"cypress\": \"12.12.0\",\n \"typescript\": \"5.0.4\"\n }\n}\n"
},
{
"path": "examples/webpack/public/index.html",
"content": "\n\n \n <%= htmlWebpackPlugin.options.title %> \n \n \n \n We're sorry but <%= htmlWebpackPlugin.options.title %> doesn't work\n properly without JavaScript enabled. Please enable it to\n continue. \n \n
\n \n \n\n"
},
{
"path": "examples/webpack/src/App.vue",
"content": "\n \n\n\n\n\n"
},
{
"path": "examples/webpack/src/components/HelloWorld.vue",
"content": "\n \n
{{ msg }} \n
\n For a guide and recipes on how to configure / customize this project,vue-cli documentation.\n
\n
Installed CLI Plugins \n
\n
Essential Links \n
\n
Ecosystem \n
\n
\n\n\n\n\n\n"
},
{
"path": "examples/webpack/src/main.js",
"content": "import { createApp } from \"vue\";\nimport App from \"./App.vue\";\n\ncreateApp(App).mount(\"#app\");\n"
},
{
"path": "examples/webpack/tsconfig.json",
"content": "{\n \"compilerOptions\": {\n \"target\": \"es5\",\n \"module\": \"esnext\",\n \"baseUrl\": \"./\",\n \"moduleResolution\": \"node\",\n \"paths\": {\n \"@/*\": [\"src/*\"]\n },\n \"lib\": [\"esnext\", \"dom\", \"dom.iterable\", \"scripthost\"]\n }\n}\n"
},
{
"path": "package.json",
"content": "{\n \"name\": \"root\",\n \"private\": true,\n \"author\": \"Jakub Freisler \",\n \"scripts\": {\n \"build\": \"pnpm -r build\",\n \"lint\": \"eslint '**/*.ts' --ignore-pattern '**/*.d.ts'\",\n \"lint:fix\": \"pnpm lint --fix\",\n \"lint:ci\": \"pnpm lint --max-warnings 0\",\n \"format\": \"pnpm -r format\",\n \"format:ci\": \"pnpm -r format:ci\",\n \"test\": \"pnpm -r test:ct:ci && pnpm -r test:e2e:ci && pnpm -r test:integration:ci\",\n \"test:integration\": \"pnpm -r test:integration\",\n \"test:integration:watch\": \"pnpm -r test:integration:watch\",\n \"test:integration:coverage\": \"pnpm -r test:integration:coverage\",\n \"test:integration:ci\": \"pnpm -r test:integration:ci\",\n \"test:ct\": \"pnpm -r test:ct\",\n \"test:ct:ci\": \"pnpm -r test:ct:ci\",\n \"test:e2e\": \"pnpm -r test:e2e\",\n \"test:e2e:ci\": \"pnpm -r test:e2e:ci\"\n },\n \"engines\": {\n \"node\": \">=10\"\n },\n \"packageManager\": \"pnpm@8.6.12\",\n \"peerDependencies\": {\n \"cypress\": \">=4.5.0\"\n },\n \"devDependencies\": {\n \"@frsource/eslint-config\": \"1.15.0\",\n \"eslint\": \"9.11.0\",\n \"eslint-plugin-cypress\": \"^3.5.0\",\n \"globals\": \"15.9.0\"\n }\n}\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/.prettierignore",
"content": "node_modules\n**/node_modules\n**/coverage\ncoverage\n**/dist\npnpm-lock.yaml\nCHANGELOG.md\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/CHANGELOG.md",
"content": "# Changelog\n\n## [3.3.10](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/compare/@frsource/cypress-plugin-visual-regression-diff-v3.3.9...@frsource/cypress-plugin-visual-regression-diff-v3.3.10) (2023-06-17)\n\n\n### Bug Fixes\n\n* **deps:** update dependency @frsource/base64 to v1.0.17 ([#244](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/issues/244)) ([d55c677](https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/commit/d55c67734d8526172bc1231128eb9faa8e39d51b))\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/__tests__/fixtures/prepare-screenshot-for-cleanup.spec.cy.js",
"content": "describe('Cleanup test', () => {\n it('Create screenshot to be removed', () => {\n cy.visit('/');\n cy.get('[data-testid=\"description\"]').matchImage();\n });\n});\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/__tests__/mocks/cypress.mock.ts",
"content": "import { vi } from 'vitest';\nimport { promises as fs } from 'fs';\n\nexport const Cypress = {\n Promise,\n};\nvi.stubGlobal('Cypress', Cypress);\n\nexport const cy = {\n readFile: vi.fn(fs.readFile),\n};\nvi.stubGlobal('cy', cy);\n\nexport const before = vi.fn();\nvi.stubGlobal('before', before);\n\nexport const after = vi.fn();\nvi.stubGlobal('after', after);\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/package.json",
"content": "{\n \"name\": \"@frsource/cypress-plugin-visual-regression-diff\",\n \"description\": \"Perform visual regression test with a nice GUI as help. 💅 Only for Cypress!\",\n \"version\": \"3.3.10\",\n \"author\": \"Jakub Freisler \",\n \"homepage\": \"https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff\",\n \"repository\": \"https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff.git\",\n \"sideEffects\": [\n \"./dist/**\"\n ],\n \"main\": \"dist/support.js\",\n \"types\": \"dist/support.d.ts\",\n \"exports\": {\n \".\": {\n \"types\": \"./dist/support.d.ts\",\n \"import\": \"./dist/support.mjs\",\n \"default\": \"./dist/support.js\"\n },\n \"./support\": {\n \"types\": \"./dist/support.d.ts\",\n \"import\": \"./dist/support.mjs\",\n \"default\": \"./dist/support.js\"\n },\n \"./plugins\": {\n \"types\": \"./dist/plugins.d.ts\",\n \"import\": \"./dist/plugins.mjs\",\n \"default\": \"./dist/plugins.js\"\n },\n \"./constants\": {\n \"types\": \"./dist/constants.d.ts\",\n \"import\": \"./dist/constants.mjs\",\n \"default\": \"./dist/constants.js\"\n },\n \"./*\": \"./*.js\"\n },\n \"typesVersions\": {\n \"*\": {\n \"support\": [\n \"dist/support.d.ts\"\n ],\n \"plugins\": [\n \"dist/plugins.d.ts\"\n ],\n \"constants\": [\n \"dist/constants.d.ts\"\n ]\n }\n },\n \"license\": \"MIT\",\n \"scripts\": {\n \"build\": \"del-cli dist && microbundle src/{support,plugins,constants}.ts --target node --tsconfig tsconfig.build.json -f cjs,modern && cpy 'dist/src/*' dist && del-cli dist/src \\\"dist/*.{hook,utils}.d.ts\\\"\",\n \"format\": \"prettier --write .\",\n \"format:ci\": \"prettier --check .\",\n \"test:integration\": \"vitest run\",\n \"test:integration:watch\": \"vitest\",\n \"test:integration:coverage\": \"vitest run --coverage\",\n \"test:integration:ci\": \"CI=true vitest run --coverage\"\n },\n \"engines\": {\n \"node\": \">=10\"\n },\n \"packageManager\": \"pnpm@8.6.12\",\n \"peerDependencies\": {\n \"cypress\": \">=4.5.0\"\n },\n \"devDependencies\": {\n \"@frsource/prettier-config\": \"^1.11.0\",\n \"@types/glob\": \"8.1.0\",\n \"@types/pixelmatch\": \"5.2.6\",\n \"@types/pngjs\": \"6.0.5\",\n \"@types/sharp\": \"0.32.0\",\n \"@types/tmp\": \"0.2.6\",\n \"@vitest/coverage-c8\": \"0.33.0\",\n \"cpy-cli\": \"4.2.0\",\n \"cypress\": \"12.14.0\",\n \"del-cli\": \"5.0.1\",\n \"microbundle\": \"0.15.1\",\n \"prettier\": \"3.3.3\",\n \"sanitize-filename\": \"1.6.3\",\n \"tmp-promise\": \"3.0.3\",\n \"typescript\": \"5.1.6\",\n \"vite-tsconfig-paths\": \"4.2.1\",\n \"vitest\": \"0.33.0\"\n },\n \"keywords\": [\n \"Cypress\",\n \"Cypress plugin\",\n \"visual regression testing\",\n \"visual diff\",\n \"image diff\",\n \"visual comparison\",\n \"image comparison\",\n \"Cypress visual regression\",\n \"regression testing\",\n \"visual snapshot\",\n \"image snapshot\",\n \"Cypress image snapshot\"\n ],\n \"dependencies\": {\n \"@frsource/base64\": \"1.0.79\",\n \"glob\": \"8.1.0\",\n \"meta-png\": \"1.0.6\",\n \"move-file\": \"2.1.0\",\n \"pixelmatch\": \"5.3.0\",\n \"pngjs\": \"7.0.0\",\n \"sharp\": \"0.32.6\"\n },\n \"publishConfig\": {\n \"access\": \"public\"\n },\n \"files\": [\n \"dist\",\n \"package.json\",\n \"README.md\",\n \"LICENSE\"\n ]\n}\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/prettier.config.mjs",
"content": "export { default } from '@frsource/prettier-config';\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/__snapshots__/support.test.ts.snap",
"content": "// Vitest Snapshot v1\n\nexports[`generateOverlayTemplate > generates proper template 1`] = `\n\"\n
\n \n some title - screenshot diff \n \n \n
\n
\n
\n New screenshot (hover mouse away too see the old one): \n \n
Old screenshot (hover over to see the new one): \n
\n
\n
\n
Diff between new and old screenshot \n
\n
\n
\n
\n
\n \n some title - screenshot diff \n \n \n
\n
\n
\n New screenshot (hover mouse away too see the old one): \n \n
Old screenshot (hover over to see the new one): \n
\n
\n
\n
Diff between new and old screenshot \n
\n
\n
\n
\n
\n \n some title - screenshot diff \n \n \n
\n
\n
\n New screenshot (hover mouse away too see the old one): \n \n
Old screenshot (hover over to see the new one): \n
\n
\n
\n
Diff between new and old screenshot \n
\n
\n
\n
= T extends false | null | undefined ? never : T;\n\nconst MIMIC_ROOT_WIN_REGEX = new RegExp(\n `^${PATH_VARIABLES.winSystemRootPath}\\\\${path.sep}([A-Z])\\\\${path.sep}`,\n);\nconst MIMIC_ROOT_UNIX_REGEX = new RegExp(\n `^${PATH_VARIABLES.unixSystemRootPath}\\\\${path.sep}`,\n);\n\nconst getConfigVariableOrThrow = (\n config: Cypress.PluginConfigOptions,\n name: K,\n) => {\n if (config[name]) {\n return config[name] as NotFalsy;\n }\n\n /* c8 ignore start */\n throw `[@frsource/cypress-plugin-visual-regression-diff] CypressConfig.${name} cannot be missing or \\`false\\`!`;\n};\n/* c8 ignore stop */\n\nexport const parseAbsolutePath = ({\n screenshotPath,\n projectRoot,\n}: {\n screenshotPath: string;\n projectRoot: string;\n}) => {\n let newAbsolutePath: string;\n const matchedMimicingWinRoot = screenshotPath.match(MIMIC_ROOT_WIN_REGEX);\n const matchedMimicingUnixRoot = screenshotPath.match(MIMIC_ROOT_UNIX_REGEX);\n if (matchedMimicingWinRoot && matchedMimicingWinRoot[1]) {\n const driveLetter = matchedMimicingWinRoot[1];\n newAbsolutePath = path.join(\n `${driveLetter}:\\\\`,\n screenshotPath.substring(matchedMimicingWinRoot[0].length),\n );\n } else if (matchedMimicingUnixRoot) {\n newAbsolutePath =\n path.sep + screenshotPath.substring(matchedMimicingUnixRoot[0].length);\n } else {\n newAbsolutePath = path.join(projectRoot, screenshotPath);\n }\n return path.normalize(newAbsolutePath);\n};\n\nexport const initAfterScreenshotHook =\n (config: Cypress.PluginConfigOptions) =>\n (\n details: Cypress.ScreenshotDetails,\n ):\n | void\n | Cypress.AfterScreenshotReturnObject\n | Promise => {\n // it's not a screenshot generated by FRSOURCE Cypress Plugin Visual Regression Diff\n /* c8 ignore start */\n if (details.name?.indexOf(IMAGE_SNAPSHOT_PREFIX) !== 0) return;\n /* c8 ignore stop */\n const screenshotsFolder = getConfigVariableOrThrow(\n config,\n 'screenshotsFolder',\n );\n const screenshotPath = details.name.substring(\n IMAGE_SNAPSHOT_PREFIX.length + path.sep.length,\n );\n const newAbsolutePath = parseAbsolutePath({\n screenshotPath,\n projectRoot: config.projectRoot,\n });\n\n return (async () => {\n await moveFile(details.path, newAbsolutePath);\n await fs.rm(path.join(screenshotsFolder, IMAGE_SNAPSHOT_PREFIX), {\n recursive: true,\n force: true,\n });\n\n return { path: newAbsolutePath };\n })();\n };\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/commands.ts",
"content": "import { FILE_SUFFIX, LINK_PREFIX, TASK } from './constants';\nimport type pixelmatch from 'pixelmatch';\nimport * as Base64 from '@frsource/base64';\nimport type { CompareImagesTaskReturn } from './types';\n\ndeclare global {\n // eslint-disable-next-line @typescript-eslint/no-namespace\n namespace Cypress {\n type MatchImageOptions = {\n screenshotConfig?: Partial;\n diffConfig?: Parameters[5];\n createMissingImages?: boolean;\n updateImages?: boolean;\n /**\n * @deprecated since version 3.0, use imagesPath instead\n */\n imagesDir?: string;\n imagesPath?: string;\n maxDiffThreshold?: number;\n forceDeviceScaleFactor?: boolean;\n title?: string;\n matchAgainstPath?: string;\n // IDEA: to be implemented if support for files NOT from filesystem needed\n // matchAgainst?: string | Buffer;\n };\n\n type MatchImageReturn = {\n diffValue: number | undefined;\n imgNewPath: string;\n imgPath: string;\n imgDiffPath: string;\n imgNewBase64: string | undefined;\n imgBase64: string | undefined;\n imgDiffBase64: string | undefined;\n imgNew: InstanceType | undefined;\n img: InstanceType | undefined;\n imgDiff: InstanceType | undefined;\n };\n\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n interface Chainable {\n /**\n * Command to create and compare image snapshots.\n * @memberof Cypress.Chainable\n * @example cy.get('.my-element').matchImage();\n */\n matchImage(\n options?: Cypress.MatchImageOptions,\n ): Chainable;\n }\n }\n}\n\nconst constructCypressError = (log: Cypress.Log, err: Error) => {\n // only way to throw & log the message properly in Cypress\n // https://github.com/cypress-io/cypress/blob/5f94cad3cb4126e0567290b957050c33e3a78e3c/packages/driver/src/cypress/error_utils.ts#L214-L216\n (err as unknown as { onFail: (e: Error) => void }).onFail = (err: Error) =>\n log.error(err);\n return err;\n};\n\nconst capitalize = (text: string) =>\n text.charAt(0).toUpperCase() + text.slice(1);\n\nconst getPluginEnv = (key: K) =>\n Cypress.env(`pluginVisualRegression${capitalize(key)}`) as\n | Cypress.MatchImageOptions[K]\n | undefined;\n\nconst booleanOption = (\n options: Cypress.MatchImageOptions,\n key: K,\n truthyValue: Return,\n falsyValue: Return,\n) =>\n options[key] === false || getPluginEnv(key) === false\n ? truthyValue\n : falsyValue;\n\nconst optionWithDefaults = (\n options: Cypress.MatchImageOptions,\n key: K,\n defaultValue: NonNullable,\n) => options[key] ?? getPluginEnv(key) ?? defaultValue;\n\nconst getImagesDir = (options: Cypress.MatchImageOptions) => {\n const imagesDir = options.imagesDir || getPluginEnv('imagesDir');\n\n // TODO: remove in 4.0.0\n if (imagesDir) {\n // eslint-disable-next-line no-console\n console.warn(\n '@frsource/cypress-plugin-visual-regression-diff] `imagesDir` option is deprecated, use `imagesPath` instead (https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff#configuration)',\n );\n }\n\n return imagesDir;\n};\n\nconst getImagesPath = (options: Cypress.MatchImageOptions) => {\n const imagesDir = getImagesDir(options);\n\n return (\n (imagesDir && `{spec_path}/${imagesDir}`) ||\n optionWithDefaults(options, 'imagesPath', '{spec_path}/__image_snapshots__')\n );\n};\n\nexport const getConfig = (options: Cypress.MatchImageOptions) => ({\n scaleFactor: booleanOption(\n options,\n 'forceDeviceScaleFactor',\n 1,\n 1 / window.devicePixelRatio,\n ),\n createMissingImages: optionWithDefaults(options, 'createMissingImages', true),\n updateImages: optionWithDefaults(options, 'updateImages', false),\n imagesPath: getImagesPath(options),\n maxDiffThreshold: optionWithDefaults(options, 'maxDiffThreshold', 0.01),\n diffConfig: optionWithDefaults(options, 'diffConfig', {}),\n screenshotConfig: optionWithDefaults(options, 'screenshotConfig', {}),\n matchAgainstPath: options.matchAgainstPath || undefined,\n});\n\nCypress.Commands.add(\n 'matchImage',\n { prevSubject: 'optional' },\n (subject, options = {}) => {\n const $el = subject as JQuery | undefined;\n let title: string;\n\n const {\n scaleFactor,\n createMissingImages,\n updateImages,\n imagesPath,\n maxDiffThreshold,\n diffConfig,\n screenshotConfig,\n matchAgainstPath,\n } = getConfig(options);\n\n const currentRetryNumber = (\n cy as unknown as {\n state: (s: string) => { currentRetry: () => number };\n }\n )\n .state('test')\n .currentRetry();\n\n return cy\n .then(() =>\n cy.task<{ screenshotPath: string; title: string }>(\n TASK.getScreenshotPathInfo,\n {\n titleFromOptions:\n options.title || Cypress.currentTest.titlePath.join(' '),\n imagesPath,\n specPath: Cypress.spec.relative,\n currentRetryNumber,\n },\n { log: false },\n ),\n )\n .then(({ screenshotPath, title: titleFromTask }) => {\n title = titleFromTask;\n let imgPath: string;\n return ($el ? cy.wrap($el) : cy)\n .screenshot(screenshotPath, {\n ...screenshotConfig,\n onAfterScreenshot(el, props) {\n imgPath = props.path;\n screenshotConfig.onAfterScreenshot?.(el, props);\n },\n log: false,\n })\n .then(() => imgPath);\n })\n .then((imgPath) =>\n cy\n .task(\n TASK.compareImages,\n {\n scaleFactor,\n imgNew: imgPath,\n imgOld:\n matchAgainstPath || imgPath.replace(FILE_SUFFIX.actual, ''),\n createMissingImages,\n updateImages,\n maxDiffThreshold,\n diffConfig,\n },\n { log: false },\n )\n .then((res) => ({\n res,\n imgPath,\n })),\n )\n .then(({ res, imgPath }) => {\n const log = Cypress.log({\n name: 'log',\n displayName: 'Match image',\n $el,\n });\n\n if (!res) {\n log.set('message', 'Unexpected error!');\n throw constructCypressError(log, new Error('Unexpected error!'));\n }\n\n log.set(\n 'message',\n `${res.message}${\n res.imgDiffBase64 && res.imgNewBase64 && res.imgOldBase64\n ? `\\n[See comparison](${LINK_PREFIX}${Base64.encode(\n encodeURIComponent(\n JSON.stringify({\n title,\n imgPath,\n imgDiffBase64: res.imgDiffBase64,\n imgNewBase64: res.imgNewBase64,\n imgOldBase64: res.imgOldBase64,\n error: res.error,\n }),\n ),\n )})`\n : ''\n }`,\n );\n\n if (res.error) {\n log.set('consoleProps', () => res);\n throw constructCypressError(log, new Error(res.message));\n }\n\n return {\n diffValue: res.imgDiff,\n imgNewPath: imgPath,\n imgPath: imgPath.replace(FILE_SUFFIX.actual, ''),\n imgDiffPath: imgPath.replace(FILE_SUFFIX.actual, FILE_SUFFIX.diff),\n imgNewBase64: res.imgNewBase64,\n imgBase64: res.imgOldBase64,\n imgDiffBase64: res.imgDiffBase64,\n imgNew:\n typeof res.imgNewBase64 === 'string'\n ? Cypress.Buffer.from(res.imgNewBase64, 'base64')\n : undefined,\n img:\n typeof res.imgOldBase64 === 'string'\n ? Cypress.Buffer.from(res.imgOldBase64, 'base64')\n : undefined,\n imgDiff:\n typeof res.imgDiffBase64 === 'string'\n ? Cypress.Buffer.from(res.imgDiffBase64, 'base64')\n : undefined,\n };\n });\n },\n);\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/constants.ts",
"content": "const PLUGIN_NAME = 'cp-visual-regression-diff';\nexport const LINK_PREFIX = `#${PLUGIN_NAME}-`;\nexport const OVERLAY_CLASS = `${PLUGIN_NAME}-overlay`;\nexport const IMAGE_SNAPSHOT_PREFIX = `__${PLUGIN_NAME}_snapshots__`;\n\nexport enum FILE_SUFFIX {\n diff = '.diff',\n actual = '.actual',\n}\n\nexport const TASK = {\n getScreenshotPathInfo: `${PLUGIN_NAME}-getScreenshotPathInfo`,\n compareImages: `${PLUGIN_NAME}-compareImages`,\n approveImage: `${PLUGIN_NAME}-approveImage`,\n cleanupImages: `${PLUGIN_NAME}-cleanupImages`,\n doesFileExist: `${PLUGIN_NAME}-doesFileExist`,\n /* c8 ignore next */\n};\n\nexport const PATH_VARIABLES = {\n specPath: '{spec_path}',\n unixSystemRootPath: '{unix_system_root_path}',\n winSystemRootPath: '{win_system_root_path}',\n} as const;\n\nexport const WINDOWS_LIKE_DRIVE_REGEX = /^[A-Z]:$/;\n\nexport const METADATA_KEY = 'FRSOURCE_CPVRD_V';\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/image.utils.ts",
"content": "import path from 'path';\nimport fs from 'fs';\nimport { PNG, PNGWithMetadata } from 'pngjs';\nimport sharp from 'sharp';\nimport metaPngPkg from 'meta-png';\nconst { addMetadata, getMetadata } = metaPngPkg;\nimport glob from 'glob';\nimport { wasScreenshotUsed } from './screenshotPath.utils';\nimport { METADATA_KEY } from './constants';\n\n// version of images generated by this plugin\n// bump only when there is a breaking change to:\n// image comparison or image generation algorithms\nconst DIFF_IMAGES_VERSION = '1';\n\nexport const addPNGMetadata = (png: Buffer) =>\n addMetadata(png, METADATA_KEY, DIFF_IMAGES_VERSION /* c8 ignore next */);\nexport const getPNGMetadata = (png: Buffer) =>\n getMetadata(png, METADATA_KEY /* c8 ignore next */);\nexport const isImageCurrentVersion = (png: Buffer) =>\n getPNGMetadata(png) === DIFF_IMAGES_VERSION;\nexport const isImageGeneratedByPlugin = (png: Buffer) =>\n !!getPNGMetadata(png /* c8 ignore next */);\n\nexport const writePNG = (name: string, png: PNG | Buffer) =>\n fs.writeFileSync(\n name,\n addPNGMetadata(png instanceof PNG ? PNG.sync.write(png) : png),\n );\n\nconst inArea = (x: number, y: number, height: number, width: number) =>\n y > height || x > width;\n\nexport const fillSizeDifference = (\n image: PNG,\n width: number,\n height: number,\n) => {\n for (let y = 0; y < image.height; y++) {\n for (let x = 0; x < image.width; x++) {\n if (inArea(x, y, height, width)) {\n const idx = (image.width * y + x) << 2;\n image.data[idx] = 0;\n image.data[idx + 1] = 0;\n image.data[idx + 2] = 0;\n image.data[idx + 3] = 64;\n }\n }\n }\n return image;\n /* c8 ignore next */\n};\n\nexport const createImageResizer =\n (width: number, height: number) => (source: PNG) => {\n const resized = new PNG({ width, height, fill: true });\n PNG.bitblt(source, resized, 0, 0, source.width, source.height, 0, 0);\n return resized;\n /* c8 ignore next */\n };\n\nexport const scaleImageAndWrite = async ({\n scaleFactor,\n path,\n}: {\n scaleFactor: number;\n path: string;\n}) => {\n const imgBuffer = fs.readFileSync(path);\n if (scaleFactor === 1) return imgBuffer;\n\n const rawImgNew = PNG.sync.read(imgBuffer);\n const newImageWidth = Math.ceil(rawImgNew.width * scaleFactor);\n const newImageHeight = Math.ceil(rawImgNew.height * scaleFactor);\n await sharp(imgBuffer).resize(newImageWidth, newImageHeight).toFile(path);\n\n return fs.readFileSync(path);\n};\n\nexport const alignImagesToSameSize = (\n firstImage: PNGWithMetadata,\n secondImage: PNGWithMetadata,\n) => {\n const firstImageWidth = firstImage.width;\n const firstImageHeight = firstImage.height;\n const secondImageWidth = secondImage.width;\n const secondImageHeight = secondImage.height;\n\n const resizeToSameSize = createImageResizer(\n Math.max(firstImageWidth, secondImageWidth),\n Math.max(firstImageHeight, secondImageHeight),\n );\n\n const resizedFirst = resizeToSameSize(firstImage);\n const resizedSecond = resizeToSameSize(secondImage);\n\n return [\n fillSizeDifference(resizedFirst, firstImageWidth, firstImageHeight),\n fillSizeDifference(resizedSecond, secondImageWidth, secondImageHeight),\n ];\n};\n\nexport const cleanupUnused = (rootPath: string) => {\n glob\n .sync('**/*.png', {\n cwd: rootPath,\n ignore: 'node_modules/**/*',\n })\n .forEach((pngPath) => {\n const absolutePath = path.join(rootPath, pngPath);\n if (\n !wasScreenshotUsed(pngPath) &&\n isImageGeneratedByPlugin(fs.readFileSync(absolutePath))\n ) {\n fs.unlinkSync(absolutePath);\n }\n });\n};\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/plugins.test.ts",
"content": "import { it, expect, describe, vi } from 'vitest';\nimport { initTaskHook } from './task.hook';\nimport { initAfterScreenshotHook } from './afterScreenshot.hook';\nimport { initPlugin } from './plugins';\n\nvi.mock('./task.hook.ts', () => ({\n initTaskHook: vi.fn().mockReturnValue('task'),\n}));\nvi.mock('./afterScreenshot.hook.ts', () => ({\n initAfterScreenshotHook: vi.fn().mockReturnValue('after:screenshot'),\n}));\n\ndescribe('initPlugin', () => {\n it('inits hooks', () => {\n const onMock = vi.fn();\n initPlugin(onMock, {\n env: { pluginVisualRegressionForceDeviceScaleFactor: false },\n } as unknown as Cypress.PluginConfigOptions);\n\n expect(onMock).toBeCalledWith('task', 'task');\n expect(onMock).toBeCalledWith('after:screenshot', 'after:screenshot');\n expect(initTaskHook).toBeCalledTimes(1);\n expect(initAfterScreenshotHook).toBeCalledTimes(1);\n });\n});\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/plugins.ts",
"content": "import { initTaskHook } from './task.hook';\nimport { initAfterScreenshotHook } from './afterScreenshot.hook';\n\n/* c8 ignore start */\nconst initForceDeviceScaleFactor = (on: Cypress.PluginEvents) => {\n // based on https://github.com/cypress-io/cypress/issues/2102#issuecomment-521299946\n on('before:browser:launch', (browser, launchOptions) => {\n if (browser.name === 'chrome' || browser.name === 'chromium') {\n launchOptions.args.push('--force-device-scale-factor=1');\n launchOptions.args.push('--high-dpi-support=1');\n return launchOptions;\n } else if (browser.name === 'electron' && browser.isHeaded) {\n // eslint-disable-next-line no-console\n console.log(\n \"There isn't currently a way of setting the device scale factor in Cypress when running headed electron so we disable the image regression commands.\",\n );\n }\n });\n};\n/* c8 ignore stop */\n\nexport const initPlugin = (\n on: Cypress.PluginEvents,\n config: Cypress.PluginConfigOptions,\n) => {\n /* c8 ignore start */\n if (config.env['pluginVisualRegressionForceDeviceScaleFactor'] !== false) {\n initForceDeviceScaleFactor(on);\n }\n /* c8 ignore stop */\n on('task', initTaskHook(config));\n on('after:screenshot', initAfterScreenshotHook(config));\n};\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/screenshotPath.utils.ts",
"content": "import path from 'path';\nimport {\n FILE_SUFFIX,\n IMAGE_SNAPSHOT_PREFIX,\n PATH_VARIABLES,\n WINDOWS_LIKE_DRIVE_REGEX,\n} from './constants';\nimport sanitize from 'sanitize-filename';\n\nconst nameCacheCounter: Record = {};\nconst lastRetryNameCacheCounter: Record = {};\nlet lastRetryNumber = 0;\n\nconst resetMap = (map: Record) => {\n // eslint-disable-next-line @typescript-eslint/no-dynamic-delete\n for (const key in map) delete map[key];\n};\n\nconst parsePathPartVariables = (\n specPath: string,\n pathPart: string,\n i: number,\n) => {\n if (pathPart === PATH_VARIABLES.specPath) {\n return path.dirname(specPath);\n } else if (i === 0 && !pathPart) {\n // when unix-like absolute path\n return PATH_VARIABLES.unixSystemRootPath;\n } else if (i === 0 && WINDOWS_LIKE_DRIVE_REGEX.test(pathPart)) {\n // when win-like absolute path\n return path.join(PATH_VARIABLES.winSystemRootPath, pathPart[0]);\n }\n\n return pathPart;\n};\n\nexport const generateScreenshotPath = ({\n titleFromOptions,\n imagesPath,\n specPath,\n currentRetryNumber,\n}: {\n titleFromOptions: string;\n imagesPath: string;\n specPath: string;\n currentRetryNumber: number;\n}) => {\n const screenshotPath = path.join(\n ...imagesPath.split('/').map(parsePathPartVariables.bind(void 0, specPath)),\n sanitize(titleFromOptions),\n );\n\n if (typeof nameCacheCounter[screenshotPath] === 'undefined') {\n nameCacheCounter[screenshotPath] = -1;\n }\n\n // it's a retry of last test, so let's reset the counter to value before last retry\n if (currentRetryNumber > lastRetryNumber) {\n // +1 because we index screenshots starting at 0\n for (const screenshotPath in lastRetryNameCacheCounter)\n nameCacheCounter[screenshotPath] -=\n lastRetryNameCacheCounter[screenshotPath] + 1;\n }\n\n resetMap(lastRetryNameCacheCounter);\n\n lastRetryNumber = currentRetryNumber;\n lastRetryNameCacheCounter[screenshotPath] = ++nameCacheCounter[\n screenshotPath\n ];\n\n return path.join(\n IMAGE_SNAPSHOT_PREFIX,\n `${screenshotPath} #${nameCacheCounter[screenshotPath]}${FILE_SUFFIX.actual}.png`,\n );\n};\n\nconst screenshotPathRegex = new RegExp(\n `^([\\\\s\\\\S]+?) #([0-9]+)(?:(?:\\\\${FILE_SUFFIX.diff})|(?:\\\\${FILE_SUFFIX.actual}))?\\\\.(?:png|PNG)$`,\n);\nexport const wasScreenshotUsed = (imagePath: string) => {\n const matched = imagePath.match(screenshotPathRegex);\n /* c8 ignore next */ if (!matched) return false;\n const [, screenshotPath, numString] = matched;\n const num = parseInt(numString);\n /* c8 ignore next */ if (!screenshotPath || isNaN(num)) return false;\n return (\n screenshotPath in nameCacheCounter &&\n num <= nameCacheCounter[screenshotPath]\n );\n};\n\nexport const resetScreenshotNameCache = () => {\n lastRetryNumber = 0;\n resetMap(nameCacheCounter);\n resetMap(lastRetryNameCacheCounter);\n};\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/support.test.ts",
"content": "import { it, expect, describe, vi } from 'vitest';\nimport { setGracefulCleanup } from 'tmp-promise';\nimport '@mocks/cypress.mock';\nimport { generateOverlayTemplate } from './support';\n\nsetGracefulCleanup();\n\nvi.mock('./commands.ts', () => ({}));\n\ndescribe('generateOverlayTemplate', () => {\n it('generates proper template', () => {\n expect(\n generateOverlayTemplate({\n title: 'some title',\n imgNewBase64: 'img-new-base64',\n imgOldBase64: 'img-old-base64',\n imgDiffBase64: 'img-diff-base64',\n wasImageNotUpdatedYet: true,\n error: true,\n }),\n ).toMatchSnapshot();\n\n expect(\n generateOverlayTemplate({\n title: 'some title',\n imgNewBase64: 'img-new-base64',\n imgOldBase64: 'img-old-base64',\n imgDiffBase64: 'img-diff-base64',\n wasImageNotUpdatedYet: false,\n error: true,\n }),\n ).toMatchSnapshot();\n\n expect(\n generateOverlayTemplate({\n title: 'some title',\n imgNewBase64: 'img-new-base64',\n imgOldBase64: 'img-old-base64',\n imgDiffBase64: 'img-diff-base64',\n wasImageNotUpdatedYet: false,\n error: false,\n }),\n ).toMatchSnapshot();\n });\n});\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/support.ts",
"content": "import * as Base64 from '@frsource/base64';\nimport './commands';\nimport { LINK_PREFIX, OVERLAY_CLASS, TASK } from './constants';\n\n/* c8 ignore start */\nfunction queueClear() {\n (cy as unknown as { queue: { reset: () => void } }).queue.reset?.();\n (cy as unknown as { queue: { clear: () => void } }).queue.clear();\n (cy as unknown as { state: (k: string, value: unknown) => void }).state(\n 'index',\n 0,\n );\n}\n\nfunction queueRun() {\n // needed to run a task outside of the test processing flow\n (cy as unknown as { queue: { run: () => void } }).queue.run();\n}\n/* c8 ignore stop */\nexport const generateOverlayTemplate = ({\n title,\n imgNewBase64,\n imgOldBase64,\n imgDiffBase64,\n wasImageNotUpdatedYet,\n error,\n}: {\n title: string;\n imgNewBase64: string;\n imgOldBase64: string;\n imgDiffBase64: string;\n wasImageNotUpdatedYet: boolean;\n error: boolean;\n}) => `\n
\n \n ${title} - screenshot diff \n \n \n
\n
\n
\n New screenshot (hover mouse away too see the old one): \n \n
Old screenshot (hover over to see the new one): \n
\n
\n
\n
Diff between new and old screenshot \n
\n
\n
\n
(\n TASK.doesFileExist,\n { path: imgPath },\n { log: false },\n ).then((wasImageNotUpdatedYet) => {\n if (!top) return false;\n\n Cypress.$(\n generateOverlayTemplate({\n title,\n imgNewBase64,\n imgOldBase64,\n imgDiffBase64,\n error,\n wasImageNotUpdatedYet,\n }),\n ).appendTo(top.document.body);\n\n const wrapper = Cypress.$(`.${OVERLAY_CLASS}`, top.document.body);\n wrapper.on('click', 'button[data-type=\"close\"]', function () {\n wrapper.remove();\n });\n\n wrapper.on('submit', 'form', function (e) {\n queueClear();\n e.preventDefault();\n\n cy.task(TASK.approveImage, { img: imgPath }).then(() =>\n wrapper.remove(),\n );\n\n queueRun();\n });\n });\n\n queueRun();\n\n return false;\n },\n );\n});\n/* c8 ignore stop */\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/task.hook.test.ts",
"content": "import { it, expect, describe, beforeEach, afterEach } from 'vitest';\nimport path from 'path';\nimport { promises as fs, existsSync } from 'fs';\nimport { dir, file, setGracefulCleanup, withFile } from 'tmp-promise';\nimport {\n approveImageTask,\n compareImagesTask,\n doesFileExistTask,\n getScreenshotPathInfoTask,\n CompareImagesCfg,\n cleanupImagesTask,\n} from './task.hook';\nimport { generateScreenshotPath } from './screenshotPath.utils';\nimport { IMAGE_SNAPSHOT_PREFIX } from './constants';\n\nsetGracefulCleanup();\n\nconst fixturesPath = path.resolve(__dirname, '..', '__tests__', 'fixtures');\nconst oldImgFixture = 'screenshot.png';\nconst newImgFixture = 'screenshot.actual.png';\nconst newFileContent = 'new file content';\n\nconst generateConfig = async (cfg: Partial) => ({\n updateImages: false,\n createMissingImages: true,\n scaleFactor: 1,\n title: 'some title',\n imgNew: await writeTmpFixture((await file()).path, newImgFixture),\n imgOld: await writeTmpFixture((await file()).path, oldImgFixture),\n maxDiffThreshold: 0.5,\n diffConfig: {},\n ...cfg,\n});\nconst writeTmpFixture = async (pathToWriteTo: string, fixtureName: string) => {\n await fs.mkdir(path.dirname(pathToWriteTo), { recursive: true });\n await fs.writeFile(\n pathToWriteTo,\n await fs.readFile(path.join(fixturesPath, fixtureName)),\n );\n return pathToWriteTo;\n};\n\ndescribe('getScreenshotPathInfoTask', () => {\n const specPath = 'some/nested/spec-path/spec.ts';\n\n it('returns sanitized path and title', () => {\n expect(\n getScreenshotPathInfoTask({\n titleFromOptions: 'some-title-withśpęćiał人物',\n imagesPath: 'nested/images/dir',\n specPath,\n currentRetryNumber: 0,\n }),\n ).toEqual({\n screenshotPath:\n '__cp-visual-regression-diff_snapshots__/nested/images/dir/some-title-withśpęćiał人物 #0.actual.png',\n title: 'some-title-withśpęćiał人物 #0.actual',\n });\n });\n\n it('supports {spec_path} variable', () => {\n expect(\n getScreenshotPathInfoTask({\n titleFromOptions: 'some-title',\n imagesPath: '{spec_path}/images/dir',\n specPath,\n currentRetryNumber: 0,\n }),\n ).toEqual({\n screenshotPath:\n '__cp-visual-regression-diff_snapshots__/some/nested/spec-path/images/dir/some-title #0.actual.png',\n title: 'some-title #0.actual',\n });\n });\n\n it('supports OS-specific absolute paths', () => {\n expect(\n getScreenshotPathInfoTask({\n titleFromOptions: 'some-title',\n imagesPath: '/images/dir',\n specPath,\n currentRetryNumber: 0,\n }),\n ).toEqual({\n screenshotPath:\n '__cp-visual-regression-diff_snapshots__/{unix_system_root_path}/images/dir/some-title #0.actual.png',\n title: 'some-title #0.actual',\n });\n\n expect(\n getScreenshotPathInfoTask({\n titleFromOptions: 'some-title',\n imagesPath: 'C:/images/dir',\n specPath,\n currentRetryNumber: 0,\n }),\n ).toEqual({\n screenshotPath:\n '__cp-visual-regression-diff_snapshots__/{win_system_root_path}/C/images/dir/some-title #0.actual.png',\n title: 'some-title #0.actual',\n });\n });\n});\n\ndescribe('cleanupImagesTask', () => {\n describe('when env is set', () => {\n const generateUsedScreenshotPath = async (projectRoot: string) => {\n const screenshotPathWithPrefix = generateScreenshotPath({\n titleFromOptions: 'some-file',\n imagesPath: 'images',\n specPath: 'some/spec/path',\n currentRetryNumber: 0,\n });\n return path.join(\n projectRoot,\n screenshotPathWithPrefix.substring(\n IMAGE_SNAPSHOT_PREFIX.length + path.sep.length,\n ),\n );\n };\n\n it('does not remove used screenshot', async () => {\n const { path: projectRoot } = await dir();\n const screenshotPath = await writeTmpFixture(\n await generateUsedScreenshotPath(projectRoot),\n oldImgFixture,\n );\n\n cleanupImagesTask({\n projectRoot,\n env: { pluginVisualRegressionCleanupUnusedImages: true },\n } as unknown as Cypress.PluginConfigOptions);\n\n expect(existsSync(screenshotPath)).toBe(true);\n });\n\n it('removes unused screenshot', async () => {\n const { path: projectRoot } = await dir();\n const screenshotPath = await writeTmpFixture(\n path.join(projectRoot, 'some-file-2 #0.png'),\n oldImgFixture,\n );\n\n cleanupImagesTask({\n projectRoot,\n env: { pluginVisualRegressionCleanupUnusedImages: true },\n } as unknown as Cypress.PluginConfigOptions);\n\n expect(existsSync(screenshotPath)).toBe(false);\n });\n });\n});\n\ndescribe('approveImageTask', () => {\n let newImgPath: string;\n let oldImgPath: string;\n let diffImgPath: string;\n\n beforeEach(() =>\n withFile(async ({ path }) => {\n oldImgPath = path;\n newImgPath = `${oldImgPath}.actual`;\n await fs.writeFile(newImgPath, newFileContent);\n diffImgPath = `${oldImgPath}.diff`;\n await fs.writeFile(diffImgPath, '');\n }),\n );\n afterEach(async () => {\n if (existsSync(diffImgPath)) await fs.unlink(diffImgPath);\n if (existsSync(newImgPath)) await fs.unlink(newImgPath);\n });\n\n it('removes diff image and replaces old with new', async () => {\n approveImageTask({ img: newImgPath });\n\n expect((await fs.readFile(oldImgPath)).toString()).toBe(newFileContent);\n expect(existsSync(newImgPath)).toBe(false);\n expect(existsSync(diffImgPath)).toBe(false);\n });\n});\n\ndescribe('compareImagesTask', () => {\n describe('when images should be updated', () => {\n describe('when old screenshot exists', () => {\n it('resolves with a success message', async () =>\n expect(\n compareImagesTask(await generateConfig({ updateImages: true })),\n ).resolves.toEqual({\n error: false,\n message:\n 'Image diff factor (0%) is within boundaries of maximum threshold option 0.5.',\n imgDiff: 0,\n imgDiffBase64: '',\n imgNewBase64: '',\n imgOldBase64: '',\n maxDiffThreshold: 0.5,\n }));\n });\n });\n\n describe(\"when images shouldn't be updated\", () => {\n describe(\"when old screenshot doesn't exist\", () => {\n it('resolves with a success message', async () => {\n const cfg = await generateConfig({ updateImages: false });\n await fs.unlink(cfg.imgOld);\n\n await expect(compareImagesTask(cfg)).resolves.toEqual({\n error: false,\n message:\n 'Image diff factor (0%) is within boundaries of maximum threshold option 0.5.',\n imgDiff: 0,\n imgDiffBase64: '',\n imgNewBase64: '',\n imgOldBase64: '',\n maxDiffThreshold: 0.5,\n });\n });\n\n describe('when createMissingImages=false', () => {\n it('rejects with error message', async () => {\n const cfg = await generateConfig({\n updateImages: false,\n createMissingImages: false,\n });\n await fs.unlink(cfg.imgOld);\n\n await expect(compareImagesTask(cfg)).resolves.toEqual({\n error: true,\n message: `Baseline image is missing at path: \"${cfg.imgOld}\". Provide a baseline image or enable \"createMissingImages\" option in plugin configuration.`,\n imgDiff: 0,\n imgDiffBase64: '',\n imgNewBase64: '',\n imgOldBase64: '',\n maxDiffThreshold: 0.5,\n });\n });\n });\n });\n\n describe('when old screenshot exists', () => {\n describe('when new image has different resolution', () => {\n it('resolves with an error message', async () => {\n const cfg = await generateConfig({ updateImages: false });\n\n await expect(compareImagesTask(cfg)).resolves.toMatchSnapshot();\n });\n });\n\n describe('when new image is exactly the same as old one', () => {\n it('resolves with a success message', async () => {\n const cfg = await generateConfig({ updateImages: false });\n await writeTmpFixture(cfg.imgNew, oldImgFixture);\n\n await expect(compareImagesTask(cfg)).resolves.toMatchSnapshot();\n });\n });\n });\n });\n});\n\ndescribe('doesFileExistsTask', () => {\n it('checks whether file exists', () => {\n expect(doesFileExistTask({ path: 'some/random/path' })).toBe(false);\n expect(\n doesFileExistTask({ path: path.join(fixturesPath, oldImgFixture) }),\n ).toBe(true);\n });\n});\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/task.hook.ts",
"content": "import fs from 'fs';\nimport { PNG } from 'pngjs';\nimport pixelmatch, { PixelmatchOptions } from 'pixelmatch';\nimport moveFile from 'move-file';\nimport path from 'path';\nimport { FILE_SUFFIX, TASK } from './constants';\nimport {\n cleanupUnused,\n alignImagesToSameSize,\n scaleImageAndWrite,\n isImageCurrentVersion,\n writePNG,\n} from './image.utils';\nimport {\n generateScreenshotPath,\n resetScreenshotNameCache,\n} from './screenshotPath.utils';\nimport type { CompareImagesTaskReturn } from './types';\n\nexport type CompareImagesCfg = {\n scaleFactor: number;\n title: string;\n imgNew: string;\n imgOld: string;\n createMissingImages: boolean;\n updateImages: boolean;\n maxDiffThreshold: number;\n diffConfig: PixelmatchOptions;\n};\n\nconst round = (n: number) => Math.ceil(n * 1000) / 1000;\n\nconst unlinkSyncSafe = (path: string) =>\n fs.existsSync(path) && fs.unlinkSync(path);\nconst moveSyncSafe = (pathFrom: string, pathTo: string) =>\n fs.existsSync(pathFrom) && moveFile.sync(pathFrom, pathTo);\n\nexport const getScreenshotPathInfoTask = (cfg: {\n titleFromOptions: string;\n imagesPath: string;\n specPath: string;\n currentRetryNumber: number;\n}) => {\n const screenshotPath = generateScreenshotPath(cfg);\n\n return { screenshotPath, title: path.basename(screenshotPath, '.png') };\n};\n\nexport const cleanupImagesTask = (config: Cypress.PluginConfigOptions) => {\n if (config.env['pluginVisualRegressionCleanupUnusedImages']) {\n cleanupUnused(config.projectRoot);\n }\n\n resetScreenshotNameCache();\n\n return null;\n};\n\nexport const approveImageTask = ({ img }: { img: string }) => {\n const oldImg = img.replace(FILE_SUFFIX.actual, '');\n unlinkSyncSafe(oldImg);\n\n const diffImg = img.replace(FILE_SUFFIX.actual, FILE_SUFFIX.diff);\n unlinkSyncSafe(diffImg);\n\n moveSyncSafe(img, oldImg);\n\n return null;\n};\n\nexport const compareImagesTask = async (\n cfg: CompareImagesCfg,\n): Promise => {\n const messages = [] as string[];\n const rawImgNewBuffer = await scaleImageAndWrite({\n scaleFactor: cfg.scaleFactor,\n path: cfg.imgNew,\n });\n let imgDiff: number | undefined;\n let imgNewBase64: string, imgOldBase64: string, imgDiffBase64: string;\n let error = false;\n\n if (fs.existsSync(cfg.imgOld) && !cfg.updateImages) {\n const rawImgNew = PNG.sync.read(rawImgNewBuffer);\n const rawImgOldBuffer = fs.readFileSync(cfg.imgOld);\n const rawImgOld = PNG.sync.read(rawImgOldBuffer);\n const isImgSizeDifferent =\n rawImgNew.height !== rawImgOld.height ||\n rawImgNew.width !== rawImgOld.width;\n\n const [imgNew, imgOld] = isImgSizeDifferent\n ? alignImagesToSameSize(rawImgNew, rawImgOld)\n : [rawImgNew, rawImgOld];\n\n const { width, height } = imgNew;\n const diff = new PNG({ width, height });\n const diffConfig = Object.assign({ includeAA: true }, cfg.diffConfig);\n\n const diffPixels = pixelmatch(\n imgNew.data,\n imgOld.data,\n diff.data,\n width,\n height,\n diffConfig,\n );\n imgDiff = diffPixels / (width * height);\n\n if (isImgSizeDifferent) {\n messages.push(\n `Warning: Images size mismatch - new screenshot is ${rawImgNew.width}px by ${rawImgNew.height}px while old one is ${rawImgOld.width}px by ${rawImgOld.height} (width x height).`,\n );\n }\n\n if (imgDiff > cfg.maxDiffThreshold) {\n messages.unshift(\n `Image diff factor (${round(\n imgDiff,\n )}%) is bigger than maximum threshold option ${cfg.maxDiffThreshold}.`,\n );\n error = true;\n }\n\n const diffBuffer = PNG.sync.write(diff);\n imgNewBase64 = PNG.sync.write(imgNew).toString('base64');\n imgDiffBase64 = diffBuffer.toString('base64');\n imgOldBase64 = PNG.sync.write(imgOld).toString('base64');\n\n if (error) {\n writePNG(\n cfg.imgNew.replace(FILE_SUFFIX.actual, FILE_SUFFIX.diff),\n diffBuffer,\n );\n } else {\n if (rawImgOld && !isImageCurrentVersion(rawImgOldBuffer)) {\n writePNG(cfg.imgNew, rawImgNewBuffer);\n moveFile.sync(cfg.imgNew, cfg.imgOld);\n } else {\n // don't overwrite file if it's the same (imgDiff < cfg.maxDiffThreshold && !isImgSizeDifferent)\n fs.unlinkSync(cfg.imgNew);\n }\n }\n } else {\n // there is no \"old screenshot\" or screenshots should be immediately updated\n imgDiff = 0;\n imgNewBase64 = '';\n imgDiffBase64 = '';\n imgOldBase64 = '';\n if (cfg.createMissingImages) {\n writePNG(cfg.imgNew, rawImgNewBuffer);\n moveFile.sync(cfg.imgNew, cfg.imgOld);\n } else {\n error = true;\n messages.unshift(\n `Baseline image is missing at path: \"${cfg.imgOld}\". Provide a baseline image or enable \"createMissingImages\" option in plugin configuration.`,\n );\n }\n }\n\n if (typeof imgDiff !== 'undefined') {\n if (!error) {\n messages.unshift(\n `Image diff factor (${round(\n imgDiff,\n )}%) is within boundaries of maximum threshold option ${\n cfg.maxDiffThreshold\n }.`,\n );\n }\n\n return {\n error,\n message: messages.join('\\n'),\n imgDiff,\n imgNewBase64,\n imgDiffBase64,\n imgOldBase64,\n maxDiffThreshold: cfg.maxDiffThreshold,\n };\n }\n\n /* c8 ignore next */\n return null;\n};\n\nexport const doesFileExistTask = ({ path }: { path: string }) =>\n fs.existsSync(path);\n\n/* c8 ignore start */\nexport const initTaskHook = (config: Cypress.PluginConfigOptions) => ({\n [TASK.getScreenshotPathInfo]: getScreenshotPathInfoTask,\n [TASK.cleanupImages]: cleanupImagesTask.bind(undefined, config),\n [TASK.doesFileExist]: doesFileExistTask,\n [TASK.approveImage]: approveImageTask,\n [TASK.compareImages]: compareImagesTask,\n});\n/* c8 ignore stop */\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/src/types.ts",
"content": "export type CompareImagesTaskReturn = null | {\n error?: boolean;\n message?: string;\n imgDiff?: number;\n imgNewBase64?: string;\n imgDiffBase64?: string;\n imgOldBase64?: string;\n maxDiffThreshold?: number;\n};\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/tsconfig.build.json",
"content": "{\n \"extends\": \"./tsconfig.json\",\n \"include\": [\"src/*.ts\"],\n \"exclude\": [\"src/*.test.ts\"]\n}\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/tsconfig.json",
"content": "{\n \"compilerOptions\": {\n \"target\": \"es6\",\n \"lib\": [\"es6\", \"dom\"],\n \"types\": [\"cypress\"],\n \"strict\": true,\n \"moduleResolution\": \"node\",\n \"esModuleInterop\": true,\n \"baseUrl\": \".\",\n \"paths\": {\n \"@fixtures/*\": [\"__tests__/partials/*\"],\n \"@mocks/*\": [\"__tests__/mocks/*\"]\n },\n \"resolveJsonModule\": true\n },\n \"include\": [\"src/*.ts\", \"vitest.config.ts\"]\n}\n"
},
{
"path": "packages/cypress-plugin-visual-regression-diff/vitest.config.ts",
"content": "import { defineConfig, configDefaults } from 'vitest/config';\nimport tsconfigPaths from 'vite-tsconfig-paths';\nimport path from 'path';\n\nconst exludeFiles = [...configDefaults.exclude, 'example', '.yarn', '*.js'];\nconst testsGlob = 'src/**.test.{js,mjs,cjs,ts,mts,cts,jsx,tsx}';\n\nconst isCI = !!process.env.CI;\n\nexport default defineConfig({\n plugins: [tsconfigPaths()],\n test: {\n exclude: exludeFiles,\n include: [testsGlob],\n coverage: {\n provider: 'c8',\n reporter: isCI\n ? ['text', ['lcovonly', { projectRoot: '../..' }]]\n : ['text', 'lcov'],\n lines: 90,\n functions: 90,\n branches: 90,\n statements: 90,\n },\n alias: {\n '@fixtures/*': path.resolve(__dirname, '__tests__', 'partials'),\n '@mocks/*': path.resolve(__dirname, '__tests__', 'mocks'),\n },\n },\n});\n"
},
{
"path": "pnpm-workspace.yaml",
"content": "packages:\n - 'packages/*'\n - 'examples/*'\n"
},
{
"path": "release-please-config.json",
"content": "{\n \"$schema\": \"https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json\",\n \"sequential-calls\": true,\n \"plugins\": [\"node-workspace\"],\n \"packages\": {\n \"packages/cypress-plugin-visual-regression-diff\": {\n \"path\": \"packages/cypress-plugin-visual-regression-diff\",\n \"component\": \"@frsource/cypress-plugin-visual-regression-diff\"\n }\n }\n}\n"
},
{
"path": "renovate.json",
"content": "{\n \"$schema\": \"https://docs.renovatebot.com/renovate-schema.json\",\n \"extends\": [\"github>FRSOURCE/renovate-config\"]\n}\n"
}
] ![\"NPM](\"https://img.shields.io/npm/v/@frsource/cypress-plugin-visual-regression-diff.svg\")
\n \n \n ![\"NPM](\"https://img.shields.io/npm/dt/@frsource/cypress-plugin-visual-regression-diff.svg\")
\n \n \n ![\"CodeClimate](\"https://api.codeclimate.com/v1/badges/b4f9a6e7b071771dd82f/maintainability.svg\")
\n \n \n ![\"semantic-relase](\"https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\"){kind=icon}
\n \n \n ![\"license](\"https://img.shields.io/github/license/FRSOURCE/cypress-plugin-visual-regression-diff.svg\")
\n \n![\"Cypress](\"https://github.com/FRSOURCE/cypress-plugin-visual-regression-diff/blob/main/assets/logo.svg\"){kind=logo}
\n![\"FRSOURCE](\"https://www.frsource.org/logo.jpg\"){kind=logo}
\n\n![\"Vue](\"./assets/logo.png\"){kind=logo}
\n