@jsenv/snapshot 2.14.0 → 2.14.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.14.0",
+  "version": "2.14.1",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {
@@ -36,7 +36,7 @@
     "@jsenv/exception": "1.1.7",
     "@jsenv/humanize": "1.4.0",
     "@jsenv/filesystem": "4.14.6",
-    "@jsenv/terminal-recorder": "1.5.9",
+    "@jsenv/terminal-recorder": "1.5.10",
     "@jsenv/urls": "2.7.1",
     "@jsenv/utils": "2.3.0",
     "ansi-regex": "6.1.0",

package/src/main.js

@@ -5,6 +5,7 @@ export {
 export { createReplaceFilesystemWellKnownValues } from "./filesystem_well_known_values.js";
 export { getCallerLocation } from "./get_caller_location.js";
 export { replaceFluctuatingValues } from "./replace_fluctuating_values.js";
+export { captureLogsIntoFile } from "./side_effects/capture_logs_into_file.js";
 export { renderLogsGif } from "./side_effects/render_logs_gif.js";
 export { snapshotSideEffects } from "./side_effects/snapshot_side_effects.js";
 export { snapshotTests } from "./side_effects/snapshot_tests.js";

package/src/side_effects/capture_logs_into_file.js

@@ -0,0 +1,14 @@
+import { createCaptureSideEffects } from "./create_capture_side_effects.js";
+import { renderLogsSvg } from "./render_logs_svg.js";
+
+export const captureLogsIntoFile = async (fn, { svgFileUrl }) => {
+  const capture = createCaptureSideEffects({
+    executionEffects: false,
+    filesystemEffects: false,
+    logEffects: {
+      group: false,
+    },
+  });
+  const sideEffects = await capture(fn);
+  renderLogsSvg(sideEffects, svgFileUrl);
+};

package/src/side_effects/log/log_side_effects.js

@@ -71,7 +71,7 @@ export const logSideEffects = (logSideEffectsOptions) => {
               const logGroupSideEffect = {
                 code: "log_group",
                 type: `log_group`,
-                value: {},
+                value: {}, // TODO: the concatenation of the logs
                 render: {
                   md: (options) => {
                     const renderLogGroup = () => {

package/src/side_effects/render_logs_gif.js

@@ -2,7 +2,7 @@ import { writeFileSync } from "@jsenv/filesystem";
 import { startTerminalRecording } from "@jsenv/terminal-recorder";
 import { isLogSideEffect } from "./log/log_side_effects.js";
 
-export const renderLogsGif = async (sideEffects, gitFileUrl) => {
+export const renderLogsGif = async (sideEffects, gifFileUrl) => {
   const terminalRecorder = await startTerminalRecording({
     gif: true,
   });
@@ -15,5 +15,5 @@ export const renderLogsGif = async (sideEffects, gitFileUrl) => {
   }
   const result = await terminalRecorder.stop();
   const gif = await result.gif();
-  writeFileSync(new URL(gitFileUrl), gif);
+  writeFileSync(new URL(gifFileUrl), gif);
 };

package/src/side_effects/render_logs_svg.js

@@ -0,0 +1,27 @@
+import { writeFileSync } from "@jsenv/filesystem";
+import { startTerminalRecording } from "@jsenv/terminal-recorder";
+import { isLogSideEffect } from "./log/log_side_effects.js";
+
+export const renderLogsSvg = async (
+  sideEffects,
+  svgFileUrl,
+  svgOptions = {},
+) => {
+  const terminalRecorder = await startTerminalRecording({
+    svg: {
+      title: "Terminal",
+      width: "auto",
+      ...svgOptions,
+    },
+  });
+  for (const sideEffect of sideEffects) {
+    if (isLogSideEffect(sideEffect)) {
+      await terminalRecorder.write(`${sideEffect.value}\n`, {
+        delay: sideEffect.delay,
+      });
+    }
+  }
+  const result = await terminalRecorder.stop();
+  const svg = await result.svg();
+  writeFileSync(new URL(svgFileUrl), svg);
+};