cypress-visual-regression/cypress-visual-regression (cypress-visual-regression)
### [`v5.2.1`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v521)
[Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/c3bc60389e7e70ce30ea99b19eb9d02a24736d07...975d33053196016be11707af2310dba41ac6a2f7)
- Fix bug with providing options through e2e file, fixes [#267](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/267)
### [`v5.2.0`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v520)
[Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/46f5913c2d954a6964c4b328e824b16e3186fd5d...c3bc60389e7e70ce30ea99b19eb9d02a24736d07)
- Enable overriding pixelmatch options, fixes [#263](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/263) and [#113](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/113)
- Move plugin options preparation logic to command.ts file
- Refactor how options priority works: default < e2e file < env vars < command options
- Update readme file describing the 'show difference' functionality
### [`v5.1.0`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v510)
[Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/cce0216e960c4fb5f68fc762920676f2af3c33b7...46f5913c2d954a6964c4b328e824b16e3186fd5d)
- Add a show difference functionality
- Expose created images in the plugin results
### [`v5.0.4`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v504)
[Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/60b3a38e9c7173909e9caa42b46ce254ea86143b...cce0216e960c4fb5f68fc762920676f2af3c33b7)
- Fix ignored parameters from the support file, fixes [#258](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/258)
### [`v5.0.3`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v503)
[Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/a42010f4062cadfb8e053928a2e2ce396ffecb82...60b3a38e9c7173909e9caa42b46ce254ea86143b)
- Remove the unneeded sanitation in the commnads.ts file, add missing one in updateSnapshot function. Fixes [#247](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/247) and [#252](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/252)
- Split integration tests into platform, project and plugin tests
- Fix a typo in documentation. Closes issue [#248](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/248)
### [`v5.0.2`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v502)
[Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/188a847e09d64bf69b67e9af9cd9af0b3b239b58...a42010f4062cadfb8e053928a2e2ce396ffecb82)
- Switch to `tsup` library (instead of regular `esbuild`)
- Remove `"type": "module"` from `package.json` file
- Output dedicated files for `cjs`, `esm` and `ts` projects. Fix issues [#244](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/244) and [#243](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/243)
- Add tests different project setups (`cjs`, `esm`, `ts`)
- Downgrade to `chalk` v4 (because of `cjs` support)
### [`v5.0.1`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v501)
[Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/8547407f514a1095fab6f45e54b57901aade0d82...188a847e09d64bf69b67e9af9cd9af0b3b239b58)
- Fixing path depth and cypress wrong saved path on headless (PR [#233](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/233))
- Fixing compareSnapshots paths (PR [#233](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/233))
- 225 v4 spec directory not included in screenshot path (PR [#233](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/233))
- Changing return type of takeScreenshot function (PR [#228](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/228))
- Restore onAfterScreenshot from the original API of 'cy screenshot' (PR [#235](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/235))
- build(deps-dev): bump vite from 4.5.2 to 4.5.3 (PR [#234](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/234))
### [`v5.0.0`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v500)
[Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/5eb8f060c1e348c8b86eb7fa10b1079e18003861...8547407f514a1095fab6f45e54b57901aade0d82)
- Formatting using prettier
- **FIX**: [errorThreshold when used in an object](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/220)
- **BREAKING**: Rollback to use single keys to configure cypress-regression-plugin, instead of using an object.
This is due to the fact that we cannot override an object on cypress CLI , please refer to [this issue](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/223) for more info .
Now any config key will have a **namespace** and will follow **camelCase** notation:
```TypeScript
env: {
visualRegressionType: TypeOption
visualRegressionBaseDirectory?: string
visualRegressionDiffDirectory?: string
visualRegressionGenerateDiff?: DiffOption
visualRegressionFailSilently?: boolean
}
```
### [`v4.0.0`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v400)
[Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/6fa1e92f9b49f48c767efc426095e11e12e2191b...5eb8f060c1e348c8b86eb7fa10b1079e18003861)
- Migrating to TS files
- Adding esbuild to build plugin
- Updating dependencies
- Adding winston for logging
- Adding formatting and linting
- **BREAKING**: now type can be of type 'base' or 'regression'
- **BREAKING**: Changed visual regression cypress envs. Now all vars related to visual regression plugin will be set inside an object like:
```TypeScript
env: {
visualRegression: {
type: TypeOption
baseDirectory?: string
diffDirectory?: string
generateDiff?: DiffOption
failSilently?: boolean
}
}
```
All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
â™» Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, check this box
This PR contains the following updates:
3.0.0
->5.2.1
Release Notes
cypress-visual-regression/cypress-visual-regression (cypress-visual-regression)
### [`v5.2.1`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v521) [Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/c3bc60389e7e70ce30ea99b19eb9d02a24736d07...975d33053196016be11707af2310dba41ac6a2f7) - Fix bug with providing options through e2e file, fixes [#267](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/267) ### [`v5.2.0`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v520) [Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/46f5913c2d954a6964c4b328e824b16e3186fd5d...c3bc60389e7e70ce30ea99b19eb9d02a24736d07) - Enable overriding pixelmatch options, fixes [#263](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/263) and [#113](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/113) - Move plugin options preparation logic to command.ts file - Refactor how options priority works: default < e2e file < env vars < command options - Update readme file describing the 'show difference' functionality ### [`v5.1.0`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v510) [Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/cce0216e960c4fb5f68fc762920676f2af3c33b7...46f5913c2d954a6964c4b328e824b16e3186fd5d) - Add a show difference functionality - Expose created images in the plugin results ### [`v5.0.4`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v504) [Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/60b3a38e9c7173909e9caa42b46ce254ea86143b...cce0216e960c4fb5f68fc762920676f2af3c33b7) - Fix ignored parameters from the support file, fixes [#258](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/258) ### [`v5.0.3`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v503) [Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/a42010f4062cadfb8e053928a2e2ce396ffecb82...60b3a38e9c7173909e9caa42b46ce254ea86143b) - Remove the unneeded sanitation in the commnads.ts file, add missing one in updateSnapshot function. Fixes [#247](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/247) and [#252](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/252) - Split integration tests into platform, project and plugin tests - Fix a typo in documentation. Closes issue [#248](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/248) ### [`v5.0.2`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v502) [Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/188a847e09d64bf69b67e9af9cd9af0b3b239b58...a42010f4062cadfb8e053928a2e2ce396ffecb82) - Switch to `tsup` library (instead of regular `esbuild`) - Remove `"type": "module"` from `package.json` file - Output dedicated files for `cjs`, `esm` and `ts` projects. Fix issues [#244](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/244) and [#243](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/243) - Add tests different project setups (`cjs`, `esm`, `ts`) - Downgrade to `chalk` v4 (because of `cjs` support) ### [`v5.0.1`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v501) [Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/8547407f514a1095fab6f45e54b57901aade0d82...188a847e09d64bf69b67e9af9cd9af0b3b239b58) - Fixing path depth and cypress wrong saved path on headless (PR [#233](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/233)) - Fixing compareSnapshots paths (PR [#233](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/233)) - 225 v4 spec directory not included in screenshot path (PR [#233](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/233)) - Changing return type of takeScreenshot function (PR [#228](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/228)) - Restore onAfterScreenshot from the original API of 'cy screenshot' (PR [#235](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/235)) - build(deps-dev): bump vite from 4.5.2 to 4.5.3 (PR [#234](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/234)) ### [`v5.0.0`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v500) [Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/5eb8f060c1e348c8b86eb7fa10b1079e18003861...8547407f514a1095fab6f45e54b57901aade0d82) - Formatting using prettier - **FIX**: [errorThreshold when used in an object](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/pull/220) - **BREAKING**: Rollback to use single keys to configure cypress-regression-plugin, instead of using an object. This is due to the fact that we cannot override an object on cypress CLI , please refer to [this issue](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/issues/223) for more info . Now any config key will have a **namespace** and will follow **camelCase** notation: ```TypeScript env: { visualRegressionType: TypeOption visualRegressionBaseDirectory?: string visualRegressionDiffDirectory?: string visualRegressionGenerateDiff?: DiffOption visualRegressionFailSilently?: boolean } ``` ### [`v4.0.0`](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/blob/HEAD/CHANGELOG.md#v400) [Compare Source](https://redirect.github.com/cypress-visual-regression/cypress-visual-regression/compare/6fa1e92f9b49f48c767efc426095e11e12e2191b...5eb8f060c1e348c8b86eb7fa10b1079e18003861) - Migrating to TS files - Adding esbuild to build plugin - Updating dependencies - Adding winston for logging - Adding formatting and linting - **BREAKING**: now type can be of type 'base' or 'regression' - **BREAKING**: Changed visual regression cypress envs. Now all vars related to visual regression plugin will be set inside an object like: ```TypeScript env: { visualRegression: { type: TypeOption baseDirectory?: string diffDirectory?: string generateDiff?: DiffOption failSilently?: boolean } } ``` All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
â™» Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.