@jsenv/snapshot 2.6.8 → 2.6.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.6.8",
+  "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/filesystem_snapshot.js

@@ -170,27 +170,35 @@ export const takeDirectorySnapshot = (
   directoryUrl = new URL(directoryUrl);
   const associations = URL_META.resolveAssociations(
     {
-      included: pattern,
+      action: pattern,
     },
     directoryUrl,
   );
-  const predicate = ({ included }) => included;
-  const shouldVisitDirectory = (url) =>
-    URL_META.urlChildMayMatch({
+  const shouldVisitDirectory = (url) => {
+    return URL_META.urlChildMayMatch({
       url,
       associations,
-      predicate,
+      predicate: (meta) => Boolean(meta.action),
     });
-  const shouldIncludeFile = (url) =>
-    predicate(
-      URL_META.applyAssociations({
-        url,
-        associations,
-      }),
-    );
+  };
+  const shouldIncludeFile = (url) => {
+    const meta = URL_META.applyAssociations({
+      url,
+      associations,
+    });
+    return meta.action === true || meta.action === "presence_only";
+  };
+  const shouldCompareFile = (url) => {
+    const meta = URL_META.applyAssociations({
+      url,
+      associations,
+    });
+    return meta.action === true || meta.action === "compare";
+  };
   const directorySnapshot = createDirectorySnapshot(directoryUrl, {
     shouldVisitDirectory,
     shouldIncludeFile,
+    shouldCompareFile,
     clean: true,
   });
   return {
@@ -199,6 +207,7 @@ export const takeDirectorySnapshot = (
       const nextDirectorySnapshot = createDirectorySnapshot(directoryUrl, {
         shouldVisitDirectory,
         shouldIncludeFile,
+        shouldCompareFile,
       });
       directorySnapshot.compare(nextDirectorySnapshot, { throwWhenDiff });
     },
@@ -226,7 +235,7 @@ export const takeDirectorySnapshot = (
 };
 const createDirectorySnapshot = (
   directoryUrl,
-  { shouldVisitDirectory, shouldIncludeFile, clean },
+  { shouldVisitDirectory, shouldIncludeFile, shouldCompareFile, clean },
 ) => {
   const directorySnapshot = {
     type: "directory",
@@ -311,6 +320,9 @@ ${extraUrls.join("\n")}`);
       // content
       {
         for (const relativeUrl of relativeUrls) {
+          if (!shouldCompareFile(new URL(relativeUrl, directoryUrl))) {
+            continue;
+          }
           const snapshot = directoryContentSnapshot[relativeUrl];
           const nextSnapshot = nextDirectoryContentSnapshot[relativeUrl];
           if (nextSnapshot) {
@@ -370,6 +382,7 @@ ${extraUrls.join("\n")}`);
           {
             shouldVisitDirectory,
             shouldIncludeFile,
+            shouldCompareFile,
             clean,
           },
         );

package/src/get_caller_location.js

@@ -9,6 +9,9 @@ export const getCallerLocation = (callIndex = 1) => {
   const { stack } = new Error();
   Error.prepareStackTrace = prepareStackTrace;
   const callerCallsite = stack[callIndex];
+  if (!callerCallsite) {
+    return null;
+  }
   const fileName = callerCallsite.getFileName();
   const testCallSite = {
     url:

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,11 +89,16 @@ export const snapshotTests = async (
     });
     const outDirectoryUrl = new URL(
       `./${asValidFilename(scenario)}/`,
-      snapshotFileUrl,
+      sideEffectFileUrl,
     );
-    const outDirectorySnapshot = takeDirectorySnapshot(outDirectoryUrl);
+    const outDirectorySnapshot = takeDirectorySnapshot(outDirectoryUrl, {
+      pattern: {
+        "**/*": true,
+        "**/*.svg": "presence_only",
+      },
+    });
     const sideEffectsMarkdown = renderSideEffects(sideEffects, {
-      sideEffectFileUrl: snapshotFileUrl,
+      sideEffectFileUrl,
       outDirectoryUrl,
       generatedBy: false,
       titleLevel: 3,
@@ -89,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}`;