@jsenv/snapshot 2.6.9 → 2.6.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.6.9",
+  "version": "2.6.10",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {
@@ -35,11 +35,11 @@
   },
   "dependencies": {
     "@jsenv/assert": "4.1.13",
-    "@jsenv/ast": "6.2.11",
+    "@jsenv/ast": "6.2.12",
     "@jsenv/exception": "1.0.1",
-    "@jsenv/filesystem": "4.9.6",
+    "@jsenv/filesystem": "4.9.7",
     "@jsenv/terminal-recorder": "1.4.2",
-    "@jsenv/urls": "2.5.0",
+    "@jsenv/urls": "2.5.1",
     "@jsenv/utils": "2.1.2",
     "ansi-regex": "6.0.1",
     "pixelmatch": "6.0.0",

package/src/side_effects/snapshot_side_effects.js

@@ -7,10 +7,27 @@ import { createCaptureSideEffects } from "./create_capture_side_effects.js";
 import { renderSideEffects } from "./render_side_effects.js";
 
 export const snapshotSideEffects = (
+  sourceFileUrl,
   fn,
-  sideEffectFileUrl,
-  { outDirectoryUrl, errorStackHidden, ...captureOptions } = {},
+  {
+    sideEffectFileUrl,
+    sideEffectFilePattern = "./output/<basename>.md",
+    outDirectoryUrl,
+    errorStackHidden,
+    ...captureOptions
+  } = {},
 ) => {
+  if (sideEffectFileUrl === undefined) {
+    const basename = urlToBasename(sourceFileUrl, true);
+    const sideEffectFileRelativeUrl = sideEffectFilePattern.replaceAll(
+      "<basename>",
+      basename,
+    );
+    sideEffectFileUrl = new URL(sideEffectFileRelativeUrl, sourceFileUrl);
+  } else {
+    sideEffectFileUrl = new URL(sideEffectFileUrl, sourceFileUrl);
+  }
+
   const captureSideEffects = createCaptureSideEffects(captureOptions);
   if (outDirectoryUrl === undefined) {
     outDirectoryUrl = new URL(

package/src/side_effects/snapshot_tests.js

@@ -1,4 +1,4 @@
-import { urlToFilename, urlToRelativeUrl } from "@jsenv/urls";
+import { urlToBasename, urlToFilename, urlToRelativeUrl } from "@jsenv/urls";
 import {
   takeDirectorySnapshot,
   takeFileSnapshot,
@@ -9,20 +9,22 @@ import { renderSideEffects, renderSmallLink } from "./render_side_effects.js";
 
 /**
  * Generate a markdown file describing all test side effects. When executed in CI throw if there is a diff.
+ * @param {URL} sourceFileUrl
  * @param {Function} fnRegisteringTest
- * @param {URL} snapshotFileUrl
  * @param {Object} snapshotTestsOptions
- * @param {string|url} snapshotTestsOptions.sourceDirectoryUrl
+ * @param {string|url} snapshotTestsOptions.sideEffectFileUrl
+ * @param {string|url} snapshotTestsOptions.rootDirectoryUrl
  * @return {Array.<Object>} sideEffects
  */
 export const snapshotTests = async (
+  sourceFileUrl,
   fnRegisteringTest,
-  snapshotFileUrl,
   {
+    sideEffectFileUrl,
+    sideEffectFilePattern = "./<basename>/<basename>.md",
     rootDirectoryUrl,
     generatedBy = true,
     linkToSource = true,
-    sourceFileUrl,
     linkToEachSource,
     errorStackHidden,
     logEffects,
@@ -30,6 +32,17 @@ export const snapshotTests = async (
     throwWhenDiff = process.env.CI,
   } = {},
 ) => {
+  if (sideEffectFileUrl === undefined) {
+    const basename = urlToBasename(sourceFileUrl, true);
+    const sideEffectFileRelativeUrl = sideEffectFilePattern.replaceAll(
+      "<basename>",
+      basename,
+    );
+    sideEffectFileUrl = new URL(sideEffectFileRelativeUrl, sourceFileUrl);
+  } else {
+    sideEffectFileUrl = new URL(sideEffectFileUrl, sourceFileUrl);
+  }
+
   const testMap = new Map();
   const onlyTestMap = new Map();
   const test = (scenario, fn, options) => {
@@ -47,7 +60,7 @@ export const snapshotTests = async (
     filesystemEffects,
   });
   let markdown = "";
-  markdown += `# ${urlToFilename(snapshotFileUrl)}`;
+  markdown += `# ${urlToFilename(sideEffectFileUrl)}`;
   if (generatedBy) {
     let generatedByLink = renderSmallLink(
       {
@@ -58,7 +71,7 @@ export const snapshotTests = async (
         prefix: "Generated by ",
         suffix:
           linkToSource && sourceFileUrl
-            ? generateExecutingLink(sourceFileUrl, snapshotFileUrl)
+            ? generateExecutingLink(sourceFileUrl, sideEffectFileUrl)
             : "",
       },
     );
@@ -76,7 +89,7 @@ export const snapshotTests = async (
     });
     const outDirectoryUrl = new URL(
       `./${asValidFilename(scenario)}/`,
-      snapshotFileUrl,
+      sideEffectFileUrl,
     );
     const outDirectorySnapshot = takeDirectorySnapshot(outDirectoryUrl, {
       pattern: {
@@ -85,7 +98,7 @@ export const snapshotTests = async (
       },
     });
     const sideEffectsMarkdown = renderSideEffects(sideEffects, {
-      sideEffectFileUrl: snapshotFileUrl,
+      sideEffectFileUrl,
       outDirectoryUrl,
       generatedBy: false,
       titleLevel: 3,
@@ -94,15 +107,15 @@ export const snapshotTests = async (
     outDirectorySnapshot.compare(throwWhenDiff);
     markdown += sideEffectsMarkdown;
   }
-  const sideEffectFileSnapshot = takeFileSnapshot(snapshotFileUrl);
+  const sideEffectFileSnapshot = takeFileSnapshot(sideEffectFileUrl);
   sideEffectFileSnapshot.update(markdown, {
     mockFluctuatingValues: false,
     throwWhenDiff,
   });
 };
 
-const generateExecutingLink = (sourceFileUrl, snapshotFileUrl) => {
-  const relativeUrl = urlToRelativeUrl(sourceFileUrl, snapshotFileUrl, {
+const generateExecutingLink = (sourceFileUrl, sideEffectFileUrl) => {
+  const relativeUrl = urlToRelativeUrl(sourceFileUrl, sideEffectFileUrl, {
     preferRelativeNotation: true,
   });
   const href = `${relativeUrl}`;