refactor(utils): make execute process log compact

Author: vmasek

packages/utils/src/lib/execute-process.ts

@@ -1,4 +1,3 @@
-import { gray } from 'ansis';
 import {
   type ChildProcess,
   type ChildProcessByStdio,
@@ -7,7 +6,8 @@ import {
   spawn,
 } from 'node:child_process';
 import type { Readable, Writable } from 'node:stream';
-import { ui } from './logging.js';
+import { formatCommandLog } from './format-command-log.js';
+import { isVerbose, ui } from './logging.js';
 import { calcDuration } from './reports/utils.js';
 
 /**
@@ -150,12 +150,11 @@ export function executeProcess(cfg: ProcessConfig): Promise<ProcessResult> {
   const date = new Date().toISOString();
   const start = performance.now();
 
-  const logCommand = [command, ...(args || [])].join(' ');
-  ui().logger.log(
-    gray(
-      `Executing command:\n${logCommand}\nIn working directory:\n${cfg.cwd ?? process.cwd()}`,
-    ),
-  );
+  if (isVerbose()) {
+    ui().logger.log(
+      formatCommandLog(command, args, `${cfg.cwd ?? process.cwd()}`),
+    );
+  }
 
   return new Promise((resolve, reject) => {
     // shell:true tells Windows to use shell command for spawning a child process

packages/utils/src/lib/format-command-log.integration.test.ts

@@ -0,0 +1,61 @@
+import path from 'node:path';
+import { describe, expect, it } from 'vitest';
+import { removeColorCodes } from '@code-pushup/test-utils';
+import { formatCommandLog } from './format-command-log.js';
+
+describe('formatCommandLog', () => {
+  it('should format simple command', () => {
+    const result = removeColorCodes(
+      formatCommandLog('npx', ['command', '--verbose']),
+    );
+
+    expect(result).toBe('$ npx command --verbose');
+  });
+
+  it('should format simple command with explicit process.cwd()', () => {
+    const result = removeColorCodes(
+      formatCommandLog('npx', ['command', '--verbose'], process.cwd()),
+    );
+
+    expect(result).toBe('$ npx command --verbose');
+  });
+
+  it('should format simple command with relative cwd', () => {
+    const result = removeColorCodes(
+      formatCommandLog('npx', ['command', '--verbose'], './wololo'),
+    );
+
+    expect(result).toBe(`wololo $ npx command --verbose`);
+  });
+
+  it('should format simple command with absolute non-current path converted to relative', () => {
+    const result = removeColorCodes(
+      formatCommandLog(
+        'npx',
+        ['command', '--verbose'],
+        path.join(process.cwd(), 'tmp'),
+      ),
+    );
+    expect(result).toBe('tmp $ npx command --verbose');
+  });
+
+  it('should format simple command with relative cwd in parent folder', () => {
+    const result = removeColorCodes(
+      formatCommandLog('npx', ['command', '--verbose'], '..'),
+    );
+
+    expect(result).toBe(`.. $ npx command --verbose`);
+  });
+
+  it('should format simple command using relative path to parent directory', () => {
+    const result = removeColorCodes(
+      formatCommandLog(
+        'npx',
+        ['command', '--verbose'],
+        path.dirname(process.cwd()),
+      ),
+    );
+
+    expect(result).toBe('.. $ npx command --verbose');
+  });
+});

packages/utils/src/lib/format-command-log.ts

@@ -0,0 +1,27 @@
+import ansis from 'ansis';
+import path from 'node:path';
+
+/**
+ * Formats a command string with optional cwd prefix and ANSI colors.
+ *
+ * @param {string} command - The command to execute.
+ * @param {string[]} args - Array of command arguments.
+ * @param {string} [cwd] - Optional current working directory for the command.
+ * @returns {string} - ANSI-colored formatted command string.
+ */
+export function formatCommandLog(
+  command: string,
+  args: string[] = [],
+  cwd: string = process.cwd(),
+): string {
+  const relativeDir = path.relative(process.cwd(), cwd);
+
+  return [
+    ...(relativeDir && relativeDir !== '.'
+      ? [ansis.italic(ansis.gray(relativeDir))]
+      : []),
+    ansis.yellow('$'),
+    ansis.gray(command),
+    ansis.gray(args.map(arg => arg).join(' ')),
+  ].join(' ');
+}