@jsenv/snapshot 1.4.2 → 1.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {
@@ -35,9 +35,9 @@
     "test": "node --conditions=development ./scripts/test.mjs"
   },
   "dependencies": {
-    "@jsenv/assert": "4.0.11",
-    "@jsenv/filesystem": "4.7.2",
-    "@jsenv/urls": "2.2.7",
+    "@jsenv/assert": "4.0.13",
+    "@jsenv/filesystem": "4.7.3",
+    "@jsenv/urls": "2.2.8",
     "@jsenv/utils": "2.1.1",
     "pixelmatch": "6.0.0",
     "prettier": "3.3.2"

package/src/compare_png_files.js

@@ -20,7 +20,7 @@ export const comparePngFiles = (actualData, expectData) => {
   );
   const diffRatio = numberOfPixelsConsideredAsDiff / numberOfPixels;
   const diffPercentage = diffRatio * 100;
-  return diffPercentage <= 1;
+  return diffPercentage <= 0.5;
 };
 
 const getPngDimensions = (buffer) => {

package/src/file_snapshots.js

@@ -26,11 +26,8 @@ export const takeFileSnapshot = (fileUrl) => {
   const fileSnapshot = createFileSnapshot(fileUrl);
   removeFileSync(fileUrl, { allowUseless: true });
   return {
-    compare: (doIt = process.env.CI) => {
-      if (!doIt) {
-        return;
-      }
-      fileSnapshot.compare(createFileSnapshot(fileUrl));
+    compare: (throwWhenDiff = process.env.CI) => {
+      fileSnapshot.compare(createFileSnapshot(fileUrl), { throwWhenDiff });
     },
     writeContent: (content) => {
       writeFileSync(fileUrl, content);
@@ -51,11 +48,14 @@ const createFileSnapshot = (fileUrl) => {
     stat: null,
     contentType: CONTENT_TYPE.fromUrlExtension(fileUrl),
     content: "",
-    compare: (nextFileSnapshot) => {
+    compare: (nextFileSnapshot, { throwWhenDiff }) => {
       const filename = urlToFilename(fileUrl);
       const failureMessage = `snapshot comparison failed for "${filename}"`;
 
       if (!nextFileSnapshot.stat) {
+        if (!throwWhenDiff) {
+          return;
+        }
         const fileNotFoundAssertionError =
           new FileContentNotFoundAssertionError(`${failureMessage}
 --- reason ---
@@ -75,9 +75,14 @@ ${fileUrl}`);
         }
         if (fileSnapshot.contentType === "image/png") {
           if (comparePngFiles(fileContent, nextFileContent)) {
+            // restore old version to prevent git diff
+            writeFileSync(fileUrl, fileContent);
             return;
           }
         }
+        if (!throwWhenDiff) {
+          return;
+        }
         const fileContentAssertionError =
           new FileContentAssertionError(`${failureMessage}
 --- reason ---
@@ -89,6 +94,9 @@ ${fileUrl}`);
       if (nextFileContent === fileContent) {
         return;
       }
+      if (!throwWhenDiff) {
+        return;
+      }
       assert({
         message: failureMessage,
         actual: nextFileContent,
@@ -133,7 +141,10 @@ ${fileUrl}`);
 
 export const takeDirectorySnapshot = (
   directoryUrl,
-  pattern = { "**/*": true },
+  pattern = {
+    "**/*": true,
+    "**/.*/": false,
+  },
 ) => {
   directoryUrl = assertAndNormalizeDirectoryUrl(directoryUrl);
   directoryUrl = new URL(directoryUrl);
@@ -164,15 +175,12 @@ export const takeDirectorySnapshot = (
   });
   return {
     __snapshot: directorySnapshot,
-    compare: (doIt = process.env.CI) => {
-      if (!doIt) {
-        return;
-      }
+    compare: (throwWhenDiff = process.env.CI) => {
       const nextDirectorySnapshot = createDirectorySnapshot(directoryUrl, {
         shouldVisitDirectory,
         shouldIncludeFile,
       });
-      directorySnapshot.compare(nextDirectorySnapshot);
+      directorySnapshot.compare(nextDirectorySnapshot, { throwWhenDiff });
     },
     addFile: (relativeUrl, content) => {
       writeFileSync(new URL(relativeUrl, directoryUrl), content);
@@ -206,7 +214,7 @@ const createDirectorySnapshot = (
     stat: null,
     empty: false,
     contentSnapshot: {},
-    compare: (nextDirectorySnapshot) => {
+    compare: (nextDirectorySnapshot, { throwWhenDiff }) => {
       const dirname = `${urlToFilename(directoryUrl)}/`;
       const failureMessage = `snapshot comparison failed for "${dirname}"`;
       if (!directorySnapshot.stat || directorySnapshot.empty) {
@@ -225,7 +233,7 @@ const createDirectorySnapshot = (
         nextDirectorySnapshot.contentSnapshot;
       const nextRelativeUrls = Object.keys(nextDirectoryContentSnapshot);
       // missing content
-      {
+      if (throwWhenDiff) {
         const missingRelativeUrls = relativeUrls.filter(
           (relativeUrl) => !nextRelativeUrls.includes(relativeUrl),
         );
@@ -253,7 +261,7 @@ ${missingUrls.join("\n")}`);
         }
       }
       // unexpected content
-      {
+      if (throwWhenDiff) {
         const extraRelativeUrls = nextRelativeUrls.filter(
           (nextRelativeUrl) => !relativeUrls.includes(nextRelativeUrl),
         );
@@ -285,7 +293,9 @@ ${extraUrls.join("\n")}`);
         for (const relativeUrl of nextRelativeUrls) {
           const snapshot = directoryContentSnapshot[relativeUrl];
           const nextSnapshot = nextDirectoryContentSnapshot[relativeUrl];
-          snapshot.compare(nextSnapshot);
+          snapshot.compare(nextSnapshot, {
+            throwWhenDiff: relativeUrl.endsWith(".gif") ? false : throwWhenDiff,
+          });
         }
       }
     },