@jsenv/snapshot 2.18.2 → 2.18.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.18.2",
+  "version": "2.18.4",
   "type": "module",
   "description": "Snapshot testing",
   "repository": {
@@ -28,13 +28,13 @@
   ],
   "dependencies": {
     "@jsenv/assert": "4.5.7",
-    "@jsenv/ast": "6.8.2",
+    "@jsenv/ast": "6.8.3",
     "@jsenv/exception": "1.2.1",
-    "@jsenv/filesystem": "4.15.16",
-    "@jsenv/humanize": "1.7.7",
-    "@jsenv/terminal-recorder": "1.5.47",
+    "@jsenv/filesystem": "4.15.17",
+    "@jsenv/humanize": "1.7.8",
+    "@jsenv/terminal-recorder": "1.5.48",
     "@jsenv/url-meta": "8.5.7",
-    "@jsenv/urls": "2.9.9",
+    "@jsenv/urls": "2.9.10",
     "@jsenv/utils": "2.3.1",
     "ansi-regex": "6.2.2",
     "pixelmatch": "7.2.0",

package/src/side_effects/snapshot_tests.js

@@ -10,6 +10,10 @@ import { renderSideEffects, renderSmallLink } from "./render_side_effects.js";
 
 /**
  * Generate a markdown file describing test(s) side effects. When executed in CI throw if there is a diff.
+ *
+ * Options can be passed inline as the third argument or pre-configured with
+ * {@link snapshotTests.prefConfigure} to keep the call site formatting clean.
+ *
  * @param {URL} sourceFileUrl
  * @param {Function} fnRegisteringTest
  * @param {Object} snapshotTestsOptions
@@ -252,13 +256,23 @@ export const snapshotTests = async (
 
   return { dirUrlMap, sideEffectsMap };
 };
-// preConfigure is just so that when we update the snapshot test options
-// it does not influence too much the formatting
-// snapshotTests(import.meta.url, ({ test }) => { }, options)
-// becomes
-// snapshotTests.prefConfigure(options)
-// snapshotTests(import.meta.url, ({ test }) => { })
-// which are equivalent
+/**
+ * Pre-configure options for the next {@link snapshotTests} call.
+ *
+ * Useful to avoid options cluttering the call site when options are declared
+ * separately or updated frequently. The pre-configured options are merged into
+ * the next `snapshotTests` call and then cleared, so they apply exactly once.
+ *
+ * @param {Object} options - Same options accepted by {@link snapshotTests}.
+ *
+ * @example
+ * // Instead of:
+ * snapshotTests(import.meta.url, ({ test }) => { }, options)
+ *
+ * // Write:
+ * snapshotTests.prefConfigure(options)
+ * snapshotTests(import.meta.url, ({ test }) => { })
+ */
 snapshotTests.prefConfigure = (options) => {
   preconfiguredOptions = options;
 };