@jsenv/snapshot 1.2.7 → 1.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "1.2.7",
+  "version": "1.3.0",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {
@@ -35,11 +35,11 @@
     "test": "node --conditions=development ./scripts/test.mjs"
   },
   "dependencies": {
-    "@jsenv/filesystem": "4.6.5",
-    "@jsenv/urls": "2.2.3",
+    "@jsenv/filesystem": "4.6.6",
+    "@jsenv/urls": "2.2.4",
     "@jsenv/utils": "2.1.1",
-    "@jsenv/assert": "3.0.2",
-    "prettier": "3.2.4"
+    "@jsenv/assert": "4.0.0",
+    "prettier": "3.3.2"
   },
   "devDependencies": {
     "strip-ansi": "7.1.0"

package/src/file_snapshots.js

@@ -13,7 +13,6 @@ import { urlToFilename, urlToRelativeUrl } from "@jsenv/urls";
 import { CONTENT_TYPE } from "@jsenv/utils/src/content_type/content_type.js";
 
 import { assert } from "@jsenv/assert";
-import { formatStringAssertionErrorMessage } from "@jsenv/assert/src/error_info/strings.js";
 
 export const takeFileSnapshot = (fileUrl) => {
   fileUrl = assertAndNormalizeFileUrl(fileUrl);
@@ -53,7 +52,7 @@ const createFileSnapshot = (fileUrl) => {
     throw e;
   }
   if (!fileSnapshot.stat.isFile()) {
-    throw new Error(`file expected at ${fileUrl}`);
+    throw new Error(`file expect at ${fileUrl}`);
   }
 
   const isTextual = CONTENT_TYPE.isTextual(
@@ -83,11 +82,14 @@ const compareFileSnapshots = (actualFileSnapshot, expectedFileSnapshot) => {
   const failureMessage = `snapshot comparison failed for "${filename}"`;
 
   if (!actualFileSnapshot.stat) {
-    throw assert.createAssertionError(`${failureMessage}
+    const fileNotFoundAssertionError =
+      assert.createAssertionError(`${failureMessage}
 --- reason ---
 file not found
 --- file ---
 ${fileUrl}`);
+    fileNotFoundAssertionError.name = "FileNotFoundAssertionError";
+    throw fileNotFoundAssertionError;
   }
   if (!expectedFileSnapshot.stat) {
     return;
@@ -98,26 +100,25 @@ ${fileUrl}`);
     if (actualFileContent.equals(expectedFileContent)) {
       return;
     }
-    throw assert.createAssertionError(`${failureMessage}
+    const fileContentAssertionError =
+      assert.createAssertionError(`${failureMessage}
 --- reason ---
 content has changed
 --- file ---
 ${fileUrl}`);
+    fileContentAssertionError.name = "FileContentAssertionError";
+    throw fileContentAssertionError;
   }
   if (actualFileContent === expectedFileContent) {
     return;
   }
-  const message = formatStringAssertionErrorMessage({
+  assert({
+    message: failureMessage,
+    details: fileUrl,
     actual: actualFileContent,
-    expected: expectedFileContent,
-    name: `file content`,
-    format: assert.format,
+    expect: expectedFileContent,
+    forceMultilineDiff: true,
   });
-  throw assert.createAssertionError(`${failureMessage}
---- reason ---
-${message}
---- file ---
-${fileUrl}`);
 };
 
 export const takeDirectorySnapshot = (directoryUrl) => {
@@ -159,17 +160,23 @@ export const takeDirectorySnapshot = (directoryUrl) => {
             (relativeUrl) => new URL(relativeUrl, directoryUrl).href,
           );
           if (missingFileCount === 1) {
-            throw assert.createAssertionError(`${failureMessage}
+            const fileMissingAssertionError =
+              assert.createAssertionError(`${failureMessage}
 --- reason ---
 "${missingRelativeUrls[0]}" is missing
 --- file missing ---
 ${missingUrls[0]}`);
+            fileMissingAssertionError.name = "FileMissingAssertionError";
+            throw fileMissingAssertionError;
           }
-          throw assert.createAssertionError(`${failureMessage}
+          const fileMissingAssertionError =
+            assert.createAssertionError(`${failureMessage}
 --- reason ---
 ${missingFileCount} files are missing
 --- files missing ---
 ${missingUrls.join("\n")}`);
+          fileMissingAssertionError.name = "FileMissingAssertionError";
+          throw fileMissingAssertionError;
         }
       }
 
@@ -185,17 +192,23 @@ ${missingUrls.join("\n")}`);
             (relativeUrl) => new URL(relativeUrl, directoryUrl).href,
           );
           if (extraFileCount === 1) {
-            throw assert.createAssertionError(`${failureMessage}
+            const extraFileAssertionError =
+              assert.createAssertionError(`${failureMessage}
 --- reason ---
 "${extraRelativeUrls[0]}" is unexpected
 --- file unexpected ---
 ${extraUrls[0]}`);
+            extraFileAssertionError.name = "ExtraFileAssertionError";
+            throw extraFileAssertionError;
           }
-          throw assert.createAssertionError(`${failureMessage}
+          const extraFileAssertionError =
+            assert.createAssertionError(`${failureMessage}
 --- reason ---
 ${extraFileCount} files are unexpected
 --- files unexpected ---
 ${extraUrls.join("\n")}`);
+          extraFileAssertionError.name = "ExtraFileAssertionError";
+          throw extraFileAssertionError;
         }
       }
 
@@ -259,12 +272,12 @@ const createDirectorySnapshot = (directoryUrl) => {
     if (e.code === "ENOTDIR") {
       // trailing slash is forced on directoryUrl
       // as a result Node.js throw ENOTDIR when doing "stat" operation
-      throw new Error(`directory expected at ${directoryUrl}`);
+      throw new Error(`directory expect at ${directoryUrl}`);
     }
     throw e;
   }
   if (!directorySnapshot.stat.isDirectory()) {
-    throw new Error(`directory expected at ${directoryUrl}`);
+    throw new Error(`directory expect at ${directoryUrl}`);
   }
 
   const entryNames = readdirSync(directoryUrl);