refactor: move commandLog

Author: John Doe

packages/nx-plugin/src/executors/cli/executor.ts

@@ -15,7 +15,9 @@ export default async function runAutorunExecutor(
   terminalAndExecutorOptions: AutorunCommandExecutorOptions,
   context: ExecutorContext,
 ): Promise<ExecutorOutput> {
-  const { objectToCliArgs, formatCommand } = await import('@code-pushup/utils');
+  const { objectToCliArgs, formatCommandStatus } = await import(
+    '@code-pushup/utils'
+  );
   const normalizedContext = normalizeContext(context);
   const cliArgumentObject = parseAutorunExecutorOptions(
     terminalAndExecutorOptions,
@@ -33,7 +35,7 @@ export default async function runAutorunExecutor(
     ...(cliCommand ? [cliCommand] : []),
   ];
   const args = [...positionals, ...objectToCliArgs(cliArgumentObject)];
-  const commandString = formatCommand([command, ...args].join(' '), {
+  const commandString = formatCommandStatus([command, ...args].join(' '), {
     cwd: context.cwd,
   });
   if (verbose) {

packages/utils/src/index.ts

@@ -88,7 +88,8 @@ export {
 } from './lib/guards.js';
 export { interpolate } from './lib/interpolate.js';
 export { logMultipleResults } from './lib/log-results.js';
-export { Logger, logger, formatCommand } from './lib/logger.js';
+export { Logger, logger } from './lib/logger.js';
+export { formatCommandStatus } from './lib/command.js';
 export { mergeConfigs } from './lib/merge-configs.js';
 export {
   addIndex,

packages/utils/src/lib/command.ts

@@ -0,0 +1,41 @@
+import ansis from 'ansis';
+import path from 'node:path';
+
+/**
+ * Formats a command string for display with status indicator.
+ *
+ * @param bin Command string with arguments.
+ * @param options Command options (cwd, env).
+ * @param status Command status ('pending' | 'success' | 'failure').
+ * @returns Formatted command string with colored status indicator.
+ */
+export function formatCommandStatus(
+  bin: string,
+  options?: {
+    env?: Record<string, string | number | boolean>;
+    cwd?: string;
+  },
+  status: 'pending' | 'success' | 'failure' = 'pending',
+): string {
+  const cwd = options?.cwd && path.relative(process.cwd(), options.cwd);
+  const cwdPrefix = cwd ? ansis.blue(cwd) : '';
+  const envString =
+    options?.env && Object.keys(options.env).length > 0
+      ? Object.entries(options.env).map(([key, value]) =>
+          ansis.gray(`${key}="${value}"`),
+        )
+      : [];
+  const statusColor =
+    status === 'pending'
+      ? ansis.blue('$')
+      : status === 'success'
+        ? ansis.green('$')
+        : ansis.red('$');
+
+  return [
+    ...(cwdPrefix ? [cwdPrefix] : []),
+    statusColor,
+    ...envString,
+    bin,
+  ].join(' ');
+}

…ckages/utils/src/lib/logger.unit.test.ts …kages/utils/src/lib/command.unit.test.tspackages/utils/src/lib/logger.unit.test.ts renamed to packages/utils/src/lib/command.unit.test.ts packages/utils/src/lib/logger.unit.test.ts renamed to packages/utils/src/lib/command.unit.test.ts

@@ -1,19 +1,13 @@
 import ansis from 'ansis';
 import path from 'node:path';
+import process from 'node:process';
 import { afterEach, describe, expect, it, vi } from 'vitest';
-import { formatCommand } from './logger.js';
+import { formatCommandStatus } from './command.js';
 
 describe('formatCommand', () => {
-  const originalCwd = process.cwd();
-
-  afterEach(() => {
-    vi.restoreAllMocks();
-  });
-
   it('should format complex command with cwd, env, and status', () => {
-    vi.spyOn(path, 'relative').mockReturnValue('<CWD>');
     expect(
-      formatCommand(
+      formatCommandStatus(
         'npx eslint . --format=json',
         {
           cwd: '<CWD>',
@@ -32,29 +26,20 @@ describe('formatCommand', () => {
     ['success' as const, ansis.green],
     ['failure' as const, ansis.red],
   ])(`should format command status %s explicitly`, (status, color) => {
-    expect(formatCommand('npx eslint . --format=json', {}, status)).toContain(
-      `${color('$')}`,
-    );
-  });
-
-  it('should include cwd prefix when cwd is provided and different from process.cwd()', () => {
-    const mockCwd = path.join(originalCwd, 'src');
-    vi.spyOn(path, 'relative').mockReturnValue('src');
-
-    expect(formatCommand('npx -v', { cwd: mockCwd })).toStartWith(
-      `${ansis.blue('src')} `,
-    );
+    expect(
+      formatCommandStatus('npx eslint . --format=json', {}, status),
+    ).toContain(`${color('$')}`);
   });
 
   it('should not include cwd prefix when cwd is same as process.cwd()', () => {
     vi.spyOn(path, 'relative').mockReturnValue('');
-    expect(formatCommand('npx -v', { cwd: originalCwd })).toStartWith(
+    expect(formatCommandStatus('npx -v', { cwd: process.cwd() })).toStartWith(
       `${ansis.blue('$')}`,
     );
   });
 
   it('should format command with multiple environment variables', () => {
-    const result = formatCommand('npx eslint .', {
+    const result = formatCommandStatus('npx eslint .', {
       env: { NODE_ENV: 'test', NODE_OPTIONS: '--import tsx' },
     });
     expect(result).toStartWith(
@@ -63,7 +48,7 @@ describe('formatCommand', () => {
   });
 
   it('should format command with environment variable containing spaces', () => {
-    const result = formatCommand('node packages/cli/src/index.ts', {
+    const result = formatCommandStatus('node packages/cli/src/index.ts', {
       env: { NODE_OPTIONS: '--import tsx' },
     });
     expect(result).toBe(

packages/utils/src/lib/logger.ts

@@ -3,6 +3,7 @@ import ansis, { type AnsiColors } from 'ansis';
 import os from 'node:os';
 import path from 'node:path';
 import ora, { type Ora } from 'ora';
+import { formatCommandStatus } from './command.js';
 import { dateToUnixTimestamp } from './dates.js';
 import { isEnvVarEnabled } from './env.js';
 import { stringifyError } from './errors.js';
@@ -245,9 +246,9 @@ export class Logger {
     },
   ): Promise<T> {
     return this.#spinner(worker, {
-      pending: formatCommand(bin, options, 'pending'),
-      success: () => formatCommand(bin, options, 'success'),
-      failure: () => formatCommand(bin, options, 'failure'),
+      pending: formatCommandStatus(bin, options, 'pending'),
+      success: () => formatCommandStatus(bin, options, 'success'),
+      failure: () => formatCommandStatus(bin, options, 'failure'),
     });
   }
 
@@ -532,42 +533,3 @@ export class Logger {
  * logger.info('Made with ❤️ by Code PushUp');
  */
 export const logger = new Logger();
-
-/**
- * Formats a command string for display with status indicator.
- *
- * @param bin Command string with arguments.
- * @param options Command options (cwd, env).
- * @param status Command status ('pending' | 'success' | 'failure').
- * @returns Formatted command string with colored status indicator.
- */
-export function formatCommand(
-  bin: string,
-  options?: {
-    env?: Record<string, string | number | boolean>;
-    cwd?: string;
-  },
-  status: 'pending' | 'success' | 'failure' = 'pending',
-): string {
-  const cwd = options?.cwd && path.relative(process.cwd(), options.cwd);
-  const cwdPrefix = cwd ? ansis.blue(cwd) : '';
-  const envString =
-    options?.env && Object.keys(options.env).length > 0
-      ? Object.entries(options.env).map(([key, value]) =>
-          ansis.gray(`${key}="${value}"`),
-        )
-      : [];
-  const statusColor =
-    status === 'pending'
-      ? ansis.blue('$')
-      : status === 'success'
-        ? ansis.green('$')
-        : ansis.red('$');
-
-  return [
-    ...(cwdPrefix ? [cwdPrefix] : []),
-    statusColor,
-    ...envString,
-    bin,
-  ].join(' ');
-}