jest-image-snapshot 5.1.1 → 6.0.0

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+# [6.0.0](https://github.com/americanexpress/jest-image-snapshot/compare/v5.2.0...v6.0.0) (2022-11-03)
+
+
+* chore(jest)!: add support for jest v29 (#309) ([79e53fc](https://github.com/americanexpress/jest-image-snapshot/commit/79e53fc010793f574cd9da783ced895af6987712)), closes [#309](https://github.com/americanexpress/jest-image-snapshot/issues/309)
+
+
+### BREAKING CHANGES
+
+* Drop support for Node v12 and Node v17,
+                 as Jest v29 does not support these versions.
+
+* ci(release): use Node v16 for release action
+
+Node v16 is the current active LTS release of Node.JS
+
+Co-authored-by: Jamie King <hello@jamieking.me>
+
+Co-authored-by: Jamie King <hello@jamieking.me>
+
+# [5.2.0](https://github.com/americanexpress/jest-image-snapshot/compare/v5.1.1...v5.2.0) (2022-08-31)
+
+
+### Features
+
+* remove snap suffix if use custom identifier ([#305](https://github.com/americanexpress/jest-image-snapshot/issues/305)) ([775ac0a](https://github.com/americanexpress/jest-image-snapshot/commit/775ac0a7dff33da9719b1dc36b9e382dc10a82a1))
+
 ## [5.1.1](https://github.com/americanexpress/jest-image-snapshot/compare/v5.1.0...v5.1.1) (2022-08-25)
 
 

package/README.md

@@ -75,7 +75,7 @@ Thanks `jest-image-snapshot`, that broken header would not have looked good in p
 npm i --save-dev jest-image-snapshot
 ```
 
-Please note that `Jest` `>=20 <=27` is a peerDependency. `jest-image-snapshot` will **not** work with anything below Jest 20.x.x
+Please note that `Jest` `>=20 <=29` is a peerDependency. `jest-image-snapshot` will **not** work with anything below Jest 20.x.x
 
 ### Invocation
 

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "jest-image-snapshot",
-  "version": "5.1.1",
+  "version": "6.0.0",
   "description": "Jest matcher for image comparisons. Most commonly used for visual regression testing.",
   "main": "src/index.js",
   "engines": {
-    "node": "^12.13.0 || ^14.15.0 || ^16.10.0 || >=17.0.0"
+    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
   },
   "scripts": {
     "lint": "eslint ./ --ignore-path .gitignore --ext .js",
@@ -53,14 +53,14 @@
     "eslint-config-amex": "^7.0.0",
     "husky": "^4.2.1",
     "image-size": "^0.8.3",
-    "jest": "^28.0.3",
-    "jest-snapshot": "^28.0.3",
+    "jest": "^29.0.0",
+    "jest-snapshot": "^29.0.0",
     "lockfile-lint": "^4.0.0",
     "mock-spawn": "^0.2.6",
     "semantic-release": "^17.0.4"
   },
   "dependencies": {
-    "chalk": "^1.1.3",
+    "chalk": "^4.0.0",
     "get-stdin": "^5.0.1",
     "glur": "^1.1.2",
     "lodash": "^4.17.4",
@@ -71,7 +71,7 @@
     "ssim.js": "^3.1.1"
   },
   "peerDependencies": {
-    "jest": ">=20 <=28"
+    "jest": ">=20 <=29"
   },
   "husky": {
     "hooks": {

package/src/diff-snapshot.js

@@ -205,7 +205,7 @@ function diffImageToSnapshot(options) {
 
   const comparisonFn = comparisonMethod === 'ssim' ? ssimMatch : pixelmatch;
   let result = {};
-  const baselineSnapshotPath = path.join(snapshotsDir, `${snapshotIdentifier}-snap.png`);
+  const baselineSnapshotPath = path.join(snapshotsDir, `${snapshotIdentifier}.png`);
   if (!fs.existsSync(baselineSnapshotPath)) {
     mkdirp.sync(path.dirname(baselineSnapshotPath));
     fs.writeFileSync(baselineSnapshotPath, receivedImageBuffer);

package/src/index.js

@@ -15,7 +15,7 @@
 const kebabCase = require('lodash/kebabCase');
 const merge = require('lodash/merge');
 const path = require('path');
-const Chalk = require('chalk').constructor;
+const Chalk = require('chalk').Instance;
 const { diffImageToSnapshot, runDiffImageToSnapshot } = require('./diff-snapshot');
 const fs = require('fs');
 const OutdatedSnapshotReporter = require('./outdated-snapshot-reporter');
@@ -108,7 +108,7 @@ function createSnapshotIdentifier({
   const counter = snapshotState._counters.get(currentTestName);
   const defaultIdentifier = kebabCase(`${path.basename(testPath)}-${currentTestName}-${counter}`);
 
-  let snapshotIdentifier = customSnapshotIdentifier || defaultIdentifier;
+  let snapshotIdentifier = customSnapshotIdentifier || `${defaultIdentifier}-snap`;
 
   if (typeof customSnapshotIdentifier === 'function') {
     const customRes = customSnapshotIdentifier({
@@ -174,7 +174,8 @@ function configureToMatchImageSnapshot({
     } = this;
     const chalkOptions = {};
     if (typeof noColors !== 'undefined') {
-      chalkOptions.enabled = !noColors;
+      // 1 means basic ANSI 16-color support, 0 means no support
+      chalkOptions.level = noColors ? 0 : 1;
     }
     const chalk = new Chalk(chalkOptions);
 
@@ -195,7 +196,7 @@ function configureToMatchImageSnapshot({
     const snapshotsDir = customSnapshotsDir || path.join(path.dirname(testPath), SNAPSHOTS_DIR);
     const receivedDir = customReceivedDir;
     const diffDir = customDiffDir;
-    const baselineSnapshotPath = path.join(snapshotsDir, `${snapshotIdentifier}-snap.png`);
+    const baselineSnapshotPath = path.join(snapshotsDir, `${snapshotIdentifier}.png`);
     OutdatedSnapshotReporter.markTouchedFile(baselineSnapshotPath);
 
     if (snapshotState._updateSnapshot === 'none' && !fs.existsSync(baselineSnapshotPath)) {