@jsenv/snapshot 2.17.12 → 2.18.0

package/package.json

@@ -1,26 +1,28 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.17.12",
+  "version": "2.18.0",
+  "type": "module",
   "description": "Snapshot testing",
   "repository": {
     "type": "git",
     "url": "https://github.com/jsenv/core",
     "directory": "packages/tooling/snapshot"
   },
-  "license": "MIT",
   "author": {
     "name": "dmail",
     "email": "dmaillard06@gmail.com"
   },
-  "sideEffects": false,
-  "type": "module",
+  "license": "MIT",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "main": "./src/main.js",
   "exports": {
     ".": {
       "import": "./src/main.js"
     },
     "./*": "./*"
   },
-  "main": "./src/main.js",
   "files": [
     "/src/"
   ],
@@ -30,24 +32,22 @@
     "@jsenv/exception": "1.2.1",
     "@jsenv/filesystem": "4.15.15",
     "@jsenv/humanize": "1.7.6",
-    "@jsenv/terminal-recorder": "1.5.45",
+    "@jsenv/terminal-recorder": "1.5.46",
     "@jsenv/url-meta": "8.5.7",
     "@jsenv/urls": "2.9.8",
     "@jsenv/utils": "2.3.1",
     "ansi-regex": "6.2.2",
-    "pixelmatch": "7.1.0",
+    "pixelmatch": "7.2.0",
     "pngjs": "7.0.0",
-    "prettier": "3.8.1",
+    "prettier": "3.8.3",
     "strip-ansi": "7.2.0"
   },
   "devDependencies": {
     "@jsenv/assert": "../assert",
     "@jsenv/snapshot": "./"
   },
-  "engines": {
-    "node": ">=20.0.0"
-  },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "sideEffects": false
 }

package/src/replace_fluctuating_values.js

@@ -24,6 +24,7 @@ export const replaceFluctuatingValues = (
     rootDirectoryUrl,
     fileUrl,
     preserveAnsi,
+    preserveDurations = false,
     // for unit test
     replaceFilesystemWellKnownValues = createReplaceFilesystemWellKnownValues({
       rootDirectoryUrl,
@@ -84,7 +85,10 @@ export const replaceFluctuatingValues = (
   //   // string = string.replaceAll("‼", "⚠");
   //   return string;
   // };
-  const replaceThings = (string, { shouldReplaceDurations } = {}) => {
+  const replaceThings = (
+    string,
+    { preserveDurations: preserveDurationsLocal = false } = {},
+  ) => {
     if (stringType === "filesystem") {
       return replaceFilesystemWellKnownValues(string);
     }
@@ -96,7 +100,7 @@ export const replaceFluctuatingValues = (
       willBeWrittenOnFilesystem: false,
     });
     string = replaceHttpUrls(string);
-    if (shouldReplaceDurations !== false) {
+    if (!preserveDurationsLocal && !preserveDurations) {
       string = replaceDurations(string);
     }
     // string = replaceUnicodeFallbacks(string);
@@ -143,7 +147,7 @@ export const replaceFluctuatingValues = (
                 newValue = "[time]";
               } else {
                 newValue = replaceThings(attributeValue, {
-                  shouldReplaceDurations: name !== "style",
+                  preserveDurations: name === "style",
                 });
               }
               attributes[name] = newValue;

package/src/side_effects/render_side_effects.js

@@ -52,6 +52,7 @@ export const renderSideEffects = (
     }),
     sourceLocation = false,
     errorTransform,
+    preserveDurations = false,
   } = {},
 ) => {
   const { rootDirectoryUrl, replaceFilesystemWellKnownValues } =
@@ -61,6 +62,7 @@ export const renderSideEffects = (
     return replaceFluctuatingValues(value, {
       replaceFilesystemWellKnownValues,
       rootDirectoryUrl,
+      preserveDurations,
       ...options,
     });
   };

package/src/side_effects/snapshot_tests.js

@@ -35,6 +35,10 @@ import { renderSideEffects, renderSmallLink } from "./render_side_effects.js";
  * @param {url} [snapshotTestsOptions.filesystemEffects.baseDirectory]
  *        Urls of filesystem side effects will be relative to this base directory
  *        Default to the directory containing @sourceFileUrl
+ * @param {boolean} [snapshotTestsOptions.preserveDurations=false]
+ *        When true, duration-like values (e.g. "30s", "1.2 seconds") are kept as-is
+ *        in the snapshot instead of being replaced with "<X>s". Useful when the
+ *        test output intentionally contains duration strings.
  */
 let preconfiguredOptions = null;
 export const snapshotTests = async (
@@ -62,6 +66,7 @@ export const snapshotTests = async (
     filesystemEffects,
     throwWhenDiff = process.env.CI,
     sourceLocation = false,
+    preserveDurations = false,
   } = options;
   filesystemActions = {
     "**": "compare",
@@ -203,6 +208,7 @@ export const snapshotTests = async (
         generateOutFileUrl: generateScenarioOutFileUrl,
         title: scenario,
         sourceLocation,
+        preserveDurations,
       });
       writeFileSync(scenarioMdFileUrl, sideEffectsMarkdown);
     }