jest-image-snapshot

Adds the option to output diff base64 image string to console for failed tests.

Thanks @DianaSuvorova for the contribution!

This release contains a bug fix to allow default custom snapshot identifiers to be set up in configureToMatchImageSnapshot (https://github.com/americanexpress/jest-image-snapshot/issues/154).

Thanks to @erbridge for the fix!

The only change in this release is to allow customSnapshotIdentifier to be a function.

Included in this release:

Documentation changes and a fix for a bug where the snapshot count displayed in the Jest results was off.

Included in this release:

-chore(deps): update jest and peerDeps f8e4d342ac26fb2aa15401e5d760b0cb4d84326b

-docs(readme): Update jest peer dep version (#128) 62724126d7b40c1174f0c0237213b35fde16e21e
Document that Jest 24 is supported

-fix(options): Fix broken diffDirection option (#125) 9d7fc6a5cbf000265ddfdd51098ae034db3c2563

Included in this release:

-feat(matcher): Add jest retry times support 48bc2e4b0a980c0a68a7896612ae9fd1dfd4a644
Adds support for Jest retryTimes()

-feat(diffResult): Allow using vertical side to side comparison result image 1b3e540d801432b316fd469acd3310eae00dba5b
Allows users to configure whether the diff results image is arranged vertically or horizontally.

Included in this release:

-fix(sizeDiff): unique fail message for size diffs 829d55b0e5ba5494b3896a07201f0fc667bbaf32
Previously if snapshots were differently sized, an error would be thrown with the same message as if the image diff had passed the configured threshold. This gave the impression that jesst-image-snapshot was ignoring the failureThreshold config when differently sized images would fail even if the pixel or percentage difference between the images was below the configured threshold.

-feat(options): Add customDiffDir option 70a4b2efca74231926a58122bf8b6af517a9183a - closes #113
Allows users to configure the diff output directory that jest-image-snapshot should use

• feat(diff-snapshot/hashing): Added hash comparison - e4df5fd083f50feb0c0f592a287cf47f6e5e69a3 - closes #106

• fix(execution): use exec path to execute spawned diff-snapshot process. Change is to now use process.execPath to ensure that we spawn a new node process to run diff-snapshot if node is not on the environment. - 05dcee4fe7dd9be480e91e38d1d184080a0a3105 - closes #108

• feat(matcher): don't update passing snapshots unless specified - https://github.com/americanexpress/jest-image-snapshot/commit/d2d1931d44984a419ede5d4c4afba230cc1af9fd - fixes #74

• perf(diff-snapshot): perform work outside jest process - https://github.com/americanexpress/jest-image-snapshot/commit/f336c479fc773eda53ae5dba82d579ed4e32d86e - fixes #87

https://github.com/americanexpress/jest-image-snapshot/commit/cb529963b7f00c6c1be2a43bf4a7a815e611a0f0 closes #55

https://github.com/americanexpress/jest-image-snapshot/commit/0ce55c669fa1b3f5f5cdd565cdfc40d89acf8dc5 closes #61

https://github.com/americanexpress/jest-image-snapshot/commit/7fb8410025204216ef9ff37f88828916d7beaa3d closes #82

• fix(package): support jest v23

This release includes changes to:

• support node 9
• support Jest --ci flag and behave just like Jest snapshots do when said flag is passed.

This release includes the following features:

Create diff image even when images are of different sizes (#42)

• Resolves https://github.com/americanexpress/jest-image-snapshot/issues/49 and allows users to better make a decision as to whether snapshot should be updated or not for tests failing due to image size differences! Big thanks to @sergeybekrin for implementing this!

Clean up test results (__diff_output__) for a given test before said test's execution

• Resolves https://github.com/americanexpress/jest-image-snapshot/issues/52 which would often cause confusion as a test's diff image from a previous run's failure would be retained in file system

• Add expected image, and actual image to diff image that is output on test failures to make allow for side to side comparison. (#40)

• Add examples and improve integration tests

Now allows for a custom snapshots directory to be given.

Changes included in this release are:

• Add new configuration to allow for different failure threshold types #23
• Fix bug where it would still create a __diff_output__ directory for passing tests

Version 2.0.0 was a true community effort and brings in these changes:

• Adds default configuration option for toMatchImageSnapshot() allowing you to apply a common configuration for all uses of toMatchImageSnapshot(). Thanks @chrbala! (#20)
• toMatchImageSnapshot() no longer creates a diff snapshot for passing builds (Yay less bloat!) Thanks @phawxby! (#18)
• Replaces blink-diff with pixelmatch as pixelmatch is a better maintained, better performant library (toMatchImageSnapshot() is ~66% faster in some of our tests). Note that this is a breaking change in that some of the custom options you may have been using from blink-diff are not available in pixelmatch though for out of the box toMatchImageSnapshot() usage it is fully compatible with your code . Thanks @phawxby for this change! (#19)
• Adds integration tests to our suite. Thanks @wtgtybhertgeghgtwtg (#15)

• Better documentation
• Changes for compatibility with Jest 21.0.0

Full feature set!

Since initial release following was added:

• Better documentation
• Ability to toggle color output on or off (@elisherer in #5)

Initial public release.