refactor: add colored formatting

Author: BioPhoton

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

@@ -3,6 +3,8 @@ import { executeProcess } from '../../internal/execute-process.js';
 import {
   createCliCommandObject,
   createCliCommandString,
+  formatCommandLog,
+  objectToCliArgs,
 } from '../internal/cli.js';
 import { normalizeContext } from '../internal/context.js';
 import type { AutorunCommandExecutorOptions } from './schema.js';
@@ -19,10 +21,11 @@ export default async function runAutorunExecutor(
   context: ExecutorContext,
 ): Promise<ExecutorOutput> {
   const normalizedContext = normalizeContext(context);
-  const { env, bin, ...mergedOptions } = mergeExecutorOptions(
-    context.target?.options,
-    terminalAndExecutorOptions,
-  );
+  const {
+    env,
+    bin = '@code-pushup/cli',
+    ...mergedOptions
+  } = mergeExecutorOptions(context.target?.options, terminalAndExecutorOptions);
   const cliArgumentObject = parseAutorunExecutorOptions(
     mergedOptions,
     normalizedContext,
@@ -33,12 +36,20 @@ export default async function runAutorunExecutor(
     bin,
     args: cliArgumentObject,
   });
+  const coloredCommandString = formatCommandLog(
+    'npx',
+    [
+      bin,
+      ...objectToCliArgs({ _: command ? [command] : [], ...cliArgumentObject }),
+    ],
+    env,
+  );
   if (verbose) {
     logger.info(`Run CLI executor ${command ?? ''}`);
-    logger.info(`Command: ${commandString}`);
+    logger.info(`Command: ${coloredCommandString}`);
   }
   if (dryRun) {
-    logger.warn(`DryRun execution of: ${commandString}`);
+    logger.warn(`DryRun execution of: ${coloredCommandString}`);
   } else {
     try {
       await executeProcess({

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

@@ -1,4 +1,5 @@
 import { logger } from '@nx/devkit';
+import ansis from 'ansis';
 import type { ProcessConfig } from '../../internal/execute-process.js';
 
 export function createCliCommandString(options?: {
@@ -12,6 +13,26 @@ export function createCliCommandString(options?: {
   )}`;
 }
 
+export function formatCommandLog(
+  command: string,
+  args: string[] = [],
+  env?: Record<string, string>,
+): string {
+  const logElements: string[] = [];
+  if (env) {
+    const envVars = Object.entries(env).map(
+      ([key, value]) =>
+        `${ansis.green(key)}="${ansis.blueBright(value.replaceAll('"', ''))}"`,
+    );
+    logElements.push(...envVars);
+  }
+  logElements.push(ansis.cyan(command));
+  if (args.length > 0) {
+    logElements.push(ansis.white(args.join(' ')));
+  }
+  return logElements.join(' ');
+}
+
 export function createCliCommandObject(options?: {
   args?: Record<string, unknown>;
   command?: string;