@jsenv/snapshot 2.16.0 → 2.16.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.16.0",
+  "version": "2.16.2",
   "description": "Snapshot testing",
   "repository": {
     "type": "git",
@@ -26,13 +26,13 @@
   ],
   "dependencies": {
     "@jsenv/assert": "4.5.5",
-    "@jsenv/ast": "6.7.17",
+    "@jsenv/ast": "6.7.18",
     "@jsenv/exception": "1.2.1",
-    "@jsenv/filesystem": "4.15.10",
-    "@jsenv/humanize": "1.7.2",
-    "@jsenv/terminal-recorder": "1.5.31",
+    "@jsenv/filesystem": "4.15.11",
+    "@jsenv/humanize": "1.7.3",
+    "@jsenv/terminal-recorder": "1.5.32",
     "@jsenv/url-meta": "8.5.7",
-    "@jsenv/urls": "2.9.4",
+    "@jsenv/urls": "2.9.5",
     "@jsenv/utils": "2.3.1",
     "ansi-regex": "6.2.2",
     "pixelmatch": "7.1.0",

package/src/replace_fluctuating_values.js

@@ -11,6 +11,7 @@ import {
   stringifyHtmlAst,
   visitHtmlNodes,
 } from "@jsenv/ast";
+import { humanize } from "@jsenv/humanize";
 import { urlToExtension } from "@jsenv/urls";
 import { CONTENT_TYPE } from "@jsenv/utils/src/content_type/content_type.js";
 import stripAnsi from "strip-ansi";
@@ -109,7 +110,7 @@ export const replaceFluctuatingValues = (
     if (stringType === "json") {
       const jsValue = JSON.parse(value);
       const replaced = replaceInObject(jsValue, { replace: replaceThings });
-      return JSON.stringify(replaced, null, "  ");
+      return jsonStringifyWithUndefined(replaced);
     }
     if (stringType === "html" || stringType === "xml") {
       // do parse html
@@ -165,11 +166,19 @@ export const replaceFluctuatingValues = (
       return regexpSource;
     }
     const jsValueReplaced = replaceInObject(value, { replace: replaceThings });
-    return JSON.stringify(jsValueReplaced, null, "  ");
+    return jsonStringifyWithUndefined(jsValueReplaced);
   }
   return value;
 };
 
+// Use humanize for better JavaScript value representation
+const jsonStringifyWithUndefined = (obj) => {
+  return humanize(obj, {
+    quote: "auto", // Let humanize decide the best quotes
+    indentSize: 2,
+  });
+};
+
 const replaceInObject = (object, { replace }) => {
   const deepCopy = (
     value,

package/src/side_effects/render_side_effects.js

@@ -50,6 +50,7 @@ export const renderSideEffects = (
       // and in that case we might want to move it to an other file
       dedicatedFile: { line: 50, length: 5000 },
     }),
+    sourceLocation = false,
     errorTransform,
   } = {},
 ) => {
@@ -97,6 +98,7 @@ export const renderSideEffects = (
       replace,
       errorTransform,
       lastSideEffectNumber,
+      sourceLocation,
     });
   }
   markdown += sideEffectMd;
@@ -163,6 +165,7 @@ const renderOneSideEffect = (
     replace,
     errorTransform,
     lastSideEffectNumber,
+    sourceLocation,
   },
 ) => {
   const { render } = sideEffect;
@@ -197,6 +200,7 @@ const renderOneSideEffect = (
       replace,
       rootDirectoryUrl,
       errorTransform,
+      sourceLocation,
     });
   }
   if (sideEffect.code === "source_code") {
@@ -233,6 +237,7 @@ const renderText = (
     replace,
     rootDirectoryUrl,
     errorTransform,
+    sourceLocation,
   },
 ) => {
   if (text && typeof text === "object") {
@@ -247,8 +252,15 @@ const renderText = (
         sideEffectMdFileUrl,
         { preferRelativeNotation: true },
       );
-      const sourceCodeLinkText = `${callSiteRelativeUrl}:${callSite.line}:${callSite.column}`;
-      const sourceCodeLinkHref = `${callSiteRelativeUrl}#L${callSite.line}`;
+      let sourceCodeLinkText;
+      let sourceCodeLinkHref;
+      if (sourceLocation) {
+        sourceCodeLinkText = `${callSiteRelativeUrl}:${callSite.line}:${callSite.column}`;
+        sourceCodeLinkHref = `${callSiteRelativeUrl}#L${callSite.line}`;
+      } else {
+        sourceCodeLinkText = `${callSiteRelativeUrl}`;
+        sourceCodeLinkHref = `${callSiteRelativeUrl}`;
+      }
       sourceMd += "\n";
       sourceMd += renderSmallLink({
         text: sourceCodeLinkText,

package/src/side_effects/snapshot_tests.js

@@ -53,6 +53,7 @@ export const snapshotTests = async (
     logEffects,
     filesystemEffects,
     throwWhenDiff = process.env.CI,
+    sourceLocation = false,
   } = options;
   filesystemActions = {
     "**": "compare",
@@ -184,10 +185,13 @@ export const snapshotTests = async (
       });
       sideEffectsMap.set(scenario, sideEffects);
       const sideEffectsMarkdown = renderSideEffects(sideEffects, {
-        sourceFileUrl: `${callSite.url}#L${callSite.line}`,
+        sourceFileUrl: sourceLocation
+          ? `${callSite.url}#L${callSite.line}`
+          : callSite.url,
         sideEffectMdFileUrl: scenarioMdFileUrl,
         generateOutFileUrl: generateScenarioOutFileUrl,
         title: scenario,
+        sourceLocation,
       });
       writeFileSync(scenarioMdFileUrl, sideEffectsMarkdown);
     }