feat: --serial-log-file arg

Author: urish

src/help.ts

@@ -11,6 +11,7 @@ export function cliHelp() {
       {green --quiet}, {green -q}                 Quiet: do not print version or status messages
       {green --expect-text} <string>      Expect the given text in the output
       {green --fail-text} <string>        Fail if the given text is found in the output
+      {green --serial-log-file} <string>  Save the serial monitor output to the given file
       {green --screenshot-part} <string>  Take a screenshot of the given part id (from diagram.json)
       {green --screenshot-time} <number>  Time in simulation milliseconds to take the screenshot
       {green --screenshot-file} <string>  File name to save the screenshot to (default: screenshot.png)

src/main.ts

@@ -1,6 +1,6 @@
 import arg from 'arg';
 import chalkTemplate from 'chalk-template';
-import { existsSync, readFileSync, writeFileSync } from 'fs';
+import { existsSync, readFileSync, writeFileSync, createWriteStream } from 'fs';
 import path, { join } from 'path';
 import YAML from 'yaml';
 import { APIClient } from './APIClient.js';
@@ -28,6 +28,7 @@ async function main() {
       '--version': Boolean,
       '--expect-text': String,
       '--fail-text': String,
+      '--serial-log-file': String,
       '--scenario': String,
       '--screenshot-part': String,
       '--screenshot-file': String,
@@ -43,6 +44,7 @@ async function main() {
   const quiet = args['--quiet'];
   const expectText = args['--expect-text'];
   const failText = args['--fail-text'];
+  const serialLogFile = args['--serial-log-file'];
   const scenarioFile = args['--scenario'];
   const timeout = args['--timeout'] ?? 30000;
   const screenshotPart = args['--screenshot-part'];
@@ -126,6 +128,8 @@ async function main() {
     scenario.validate();
   }
 
+  const serialLogStream = serialLogFile ? createWriteStream(serialLogFile) : null;
+
   if (expectText) {
     expectEngine.expectTexts.push(expectText);
     expectEngine.on('match', (text) => {
@@ -219,6 +223,8 @@ async function main() {
         for (const byte of bytes) {
           process.stdout.write(String.fromCharCode(byte));
         }
+
+        serialLogStream?.write(Buffer.from(bytes));
         expectEngine.feed(bytes);
       }
       if (event.event === 'chips:log') {