refactor(ci): break up large executeCliCommand function, add jsdocs

Author: matejchalk

packages/ci/src/lib/cli/exec.ts

@@ -8,35 +8,25 @@ import {
 } from '@code-pushup/utils';
 import type { CommandContext } from './context.js';
 
+/**
+ * Executes Code PushUp CLI command and logs output in a way that's more readable in CI.
+ * @param args Arguments for Code PushUp CLI
+ * @param context Command context
+ * @param options Optional information on whether all persist formats are set (if known)
+ */
 export async function executeCliCommand(
   args: string[],
   context: CommandContext,
   options?: { hasFormats: boolean },
 ): Promise<void> {
-  // eslint-disable-next-line functional/no-let
-  let output = '';
-
-  const logRaw = (message: string) => {
-    if (!context.silent) {
-      if (!output) {
-        logger.newline();
-      }
-      logger.info(message, { noIndent: true, noLineBreak: true });
-    }
-    output += message;
-  };
-
-  const logEnd = () => {
-    if (!context.silent && output) {
-      logger.newline();
-    }
-  };
+  const { logOutputChunk, logOutputEnd, logSilencedOutput } =
+    createLogCallbacks(context);
 
   const observer: ProcessObserver = {
-    onStdout: logRaw,
-    onStderr: logRaw,
-    onComplete: logEnd,
-    onError: logEnd,
+    onStdout: logOutputChunk,
+    onStderr: logOutputChunk,
+    onComplete: logOutputEnd,
+    onError: logOutputEnd,
   };
 
   const config: ProcessConfig = {
@@ -54,13 +44,7 @@ export async function executeCliCommand(
         await executeProcess(config);
       } catch (error) {
         // ensure output of failed process is always logged for debugging
-        if (context.silent) {
-          logger.newline();
-          logger.info(output, { noIndent: true });
-          if (!output.endsWith('\n')) {
-            logger.newline();
-          }
-        }
+        logSilencedOutput();
         throw error;
       }
     });
@@ -69,6 +53,39 @@ export async function executeCliCommand(
   }
 }
 
+function createLogCallbacks(context: Pick<CommandContext, 'silent'>) {
+  // eslint-disable-next-line functional/no-let
+  let output = '';
+
+  const logOutputChunk = (message: string) => {
+    if (!context.silent) {
+      if (!output) {
+        logger.newline();
+      }
+      logger.info(message, { noIndent: true, noLineBreak: true });
+    }
+    output += message;
+  };
+
+  const logOutputEnd = () => {
+    if (!context.silent && output) {
+      logger.newline();
+    }
+  };
+
+  const logSilencedOutput = () => {
+    if (context.silent) {
+      logger.newline();
+      logger.info(output, { noIndent: true });
+      if (!output.endsWith('\n')) {
+        logger.newline();
+      }
+    }
+  };
+
+  return { logOutputChunk, logOutputEnd, logSilencedOutput };
+}
+
 function combineArgs(
   args: string[],
   context: CommandContext,