@jsenv/snapshot 2.14.2 → 2.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.14.2",
+  "version": "2.15.0",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {
@@ -31,13 +31,13 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@jsenv/assert": "4.4.5",
-    "@jsenv/ast": "6.6.7",
+    "@jsenv/assert": "4.4.6",
+    "@jsenv/ast": "6.6.9",
     "@jsenv/exception": "1.1.7",
-    "@jsenv/humanize": "1.4.0",
-    "@jsenv/filesystem": "4.14.6",
-    "@jsenv/terminal-recorder": "1.5.11",
-    "@jsenv/urls": "2.7.1",
+    "@jsenv/humanize": "1.5.0",
+    "@jsenv/filesystem": "4.15.0",
+    "@jsenv/terminal-recorder": "1.5.14",
+    "@jsenv/urls": "2.7.2",
     "@jsenv/utils": "2.3.0",
     "ansi-regex": "6.1.0",
     "pixelmatch": "7.1.0",

package/src/side_effects/create_capture_side_effects.js

@@ -9,6 +9,8 @@ const executionEffectsDefault = {
   return: true,
 };
 
+let currentCapture = false;
+
 export const createCaptureSideEffects = ({
   sourceFileUrl,
   logEffects = true,
@@ -50,6 +52,7 @@ export const createCaptureSideEffects = ({
     replaceFilesystemWellKnownValues,
   };
   let functionExecutingCount = 0;
+  let ignored = false;
   const capture = (fn, { callSite, baseDirectory } = {}) => {
     const unicodeSupported = UNICODE.supported;
     const ansiSupported = ANSI.supported;
@@ -74,6 +77,7 @@ export const createCaptureSideEffects = ({
     };
     const onSideEffectRemoved = () => {};
     const addSideEffect = (sideEffect) => {
+      if (ignored) return null;
       sideEffects.push(sideEffect);
       onSideEffectAdded(sideEffect);
       return sideEffect;
@@ -286,6 +290,7 @@ export const createCaptureSideEffects = ({
       });
     };
     const onFinally = () => {
+      currentCapture = null;
       delete process.env.CAPTURING_SIDE_EFFECTS;
       UNICODE.supported = unicodeSupported;
       ANSI.supported = ansiSupported;
@@ -326,6 +331,13 @@ export const createCaptureSideEffects = ({
     process.env.CAPTURING_SIDE_EFFECTS = "1";
     functionExecutingCount++;
     let returnedPromise = false;
+    currentCapture = {
+      ignoreWhile: (fn) => {
+        ignored = true;
+        fn();
+        ignored = false;
+      },
+    };
     try {
       const valueReturned = fn();
       if (valueReturned && typeof valueReturned.then === "function") {
@@ -355,7 +367,17 @@ export const createCaptureSideEffects = ({
       }
     }
   };
+  capture.ignoreSideEffects = ignoreSideEffects;
+
   return capture;
 };
 
+export const ignoreSideEffects = (fn) => {
+  if (!currentCapture) {
+    console.warn(`ignoreSideEffects called outside of captureSideEffects`);
+    return;
+  }
+  currentCapture.ignoreWhile(fn);
+};
+
 const RETURN_PROMISE = {};

package/src/side_effects/snapshot_tests.js

@@ -2,7 +2,10 @@ import { writeFileSync } from "@jsenv/filesystem";
 import { urlToBasename, urlToFilename, urlToRelativeUrl } from "@jsenv/urls";
 import { takeDirectorySnapshot } from "../filesystem_snapshot.js";
 import { getCallerLocation } from "../get_caller_location.js";
-import { createCaptureSideEffects } from "./create_capture_side_effects.js";
+import {
+  createCaptureSideEffects,
+  ignoreSideEffects,
+} from "./create_capture_side_effects.js";
 import { renderSideEffects, renderSmallLink } from "./render_side_effects.js";
 
 /**
@@ -235,11 +238,12 @@ export const snapshotTests = async (
 // snapshotTests.prefConfigure(options)
 // snapshotTests(import.meta.url, ({ test }) => { })
 // which are equivalent
-
 snapshotTests.prefConfigure = (options) => {
   preconfiguredOptions = options;
 };
 
+snapshotTests.ignoreSideEffects = ignoreSideEffects;
+
 // see https://github.com/parshap/node-sanitize-filename/blob/master/index.js
 const asValidFilename = (string) => {
   return string