feat(nx-plugin): adjust bin path handling

CONTRIBUTING.md

@@ -69,50 +69,6 @@ You can control the execution of long-running tests over the `INCLUDE_SLOW_TESTS
 To change this setup, open (or create) the `.env` file in the root folder.
 Edit or add the environment variable there as follows: `INCLUDE_SLOW_TESTS=true`.
 
-### Executing local code
-
-We use the current version of Code PushUp and its plugins, to measure itself and its plugins.
-
-_Execute the latest CLI source_
-
-```jsonc
-// project.json
-{
-  "targets": {
-    "code-pushup": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "node packages/cli/src/index.ts",
-        "args": ["--no-progress", "--verbose"],
-        "env": {
-          "NODE_OPTIONS": "--import tsx",
-          "TSX_TSCONFIG_PATH": "tsconfig.base.json"
-        }
-      }
-    }
- }
-```
-
-_Setup code-pushup targets with the nx plugin_
-
-```jsonc
-// nx.json
-{
-  "plugins": [
-    {
-      "plugin": "@code-pushup/nx-plugin",
-      "options": {
-        "cliBin": "node ./packages/cli/src/index.ts",
-        "env": {
-          "NODE_OPTIONS": "--import=tsx",
-          "TSX_TSCONFIG_PATH": "tsconfig.base.json",
-        },
-      },
-    },
-  ],
-}
-```
-
 ## Git
 
 Commit messages must follow [conventional commits](https://conventionalcommits.org/) format.

e2e/nx-plugin-e2e/tests/plugin-create-nodes.e2e.test.ts

@@ -173,12 +173,10 @@ describe('nx-plugin', () => {
     });
 
     const cleanStdout = removeColorCodes(stdout);
-    // @TODO create test environment for working plugin. This here misses package-lock.json to execute correctly
-    expect(cleanStdout).toContain('Executing command:');
-    expect(cleanStdout).toContain('npx @code-pushup/cli');
-    expect(cleanStdout).toContain(
-      'NX   Successfully ran target code-pushup for project my-lib',
-    );
+    expect(cleanStdout).toContain('nx run my-lib:code-pushup');
+    expect(cleanStdout).toContain('$ npx @code-pushup/cli ');
+    expect(cleanStdout).toContain('--dryRun --verbose');
+    expect(cleanStdout).toContain(`--upload.project=\\"${project}\\"`);
   });
 
   it('should consider plugin option cliBin in executor target', async () => {

packages/nx-plugin/package.json

@@ -37,8 +37,7 @@
     "@nx/devkit": ">=17.0.0",
     "ansis": "^3.3.0",
     "nx": ">=17.0.0",
-    "zod": "^4.0.5",
-    "chalk": "5.3.0"
+    "zod": "^4.0.5"
   },
   "files": [
     "src",

packages/nx-plugin/src/executors/cli/README.md

@@ -72,6 +72,6 @@ Show what will be executed without actually executing it:
 | ----------------- | --------- | ------------------------------------------------------------------ |
 | **projectPrefix** | `string`  | prefix for upload.project on non root projects                     |
 | **dryRun**        | `boolean` | To debug the executor, dry run the command without real execution. |
-| **cliBin**        | `string`  | Path to Code PushUp CLI                                            |
+| **bin**           | `string`  | Path to Code PushUp CLI                                            |
 
 For all other options see the [CLI autorun documentation](../../../../cli/README.md#autorun-command).

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

@@ -53,47 +53,4 @@ describe('runAutorunExecutor', () => {
       },
     });
   });
-
-  it('should execute command with provided bin', async () => {
-    const bin = 'packages/cli/dist';
-    const output = await runAutorunExecutor(
-      {
-        verbose: true,
-        bin,
-      },
-      executorContext('utils'),
-    );
-    expect(output.success).toBe(true);
-
-    expect(executeProcessSpy).toHaveBeenCalledTimes(1);
-    expect(executeProcessSpy).toHaveBeenCalledWith(
-      expect.objectContaining({
-        args: expect.arrayContaining([bin]),
-      }),
-    );
-  });
-
-  it('should execute command with provided env vars', async () => {
-    const output = await runAutorunExecutor(
-      {
-        verbose: true,
-        env: {
-          NODE_OPTIONS: '--import tsx',
-          TSX_TSCONFIG_PATH: 'tsconfig.base.json',
-        },
-      },
-      executorContext('utils'),
-    );
-    expect(output.success).toBe(true);
-
-    expect(executeProcessSpy).toHaveBeenCalledTimes(1);
-    expect(executeProcessSpy).toHaveBeenCalledWith(
-      expect.objectContaining({
-        env: {
-          NODE_OPTIONS: '--import tsx',
-          TSX_TSCONFIG_PATH: 'tsconfig.base.json',
-        },
-      }),
-    );
-  });
 });

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

@@ -3,8 +3,6 @@ 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';
@@ -21,7 +19,7 @@ export default async function runAutorunExecutor(
   context: ExecutorContext,
 ): Promise<ExecutorOutput> {
   const normalizedContext = normalizeContext(context);
-  const { env, bin, ...mergedOptions } = mergeExecutorOptions(
+  const mergedOptions = mergeExecutorOptions(
     context.target?.options,
     terminalAndExecutorOptions,
   );
@@ -32,30 +30,29 @@ export default async function runAutorunExecutor(
   const { dryRun, verbose, command } = mergedOptions;
   const commandString = createCliCommandString({
     command,
-    bin,
     args: cliArgumentObject,
   });
-
   if (verbose) {
     logger.info(`Run CLI executor ${command ?? ''}`);
+    logger.info(`Command: ${commandString}`);
   }
-
-  try {
-    await executeProcess({
-      ...createCliCommandObject({ command, args: cliArgumentObject, bin }),
-      ...(context.cwd ? { cwd: context.cwd } : {}),
-      env,
-      dryRun,
-    });
-  } catch (error) {
-    logger.error(error);
-    return {
-      success: false,
-      command: commandString,
-      error: error instanceof Error ? error : new Error(stringifyError(error)),
-    };
+  if (dryRun) {
+    logger.warn(`DryRun execution of: ${commandString}`);
+  } else {
+    try {
+      await executeProcess({
+        ...createCliCommandObject({ command, args: cliArgumentObject }),
+        ...(context.cwd ? { cwd: context.cwd } : {}),
+      });
+    } catch (error) {
+      logger.error(error);
+      return {
+        success: false,
+        command: commandString,
+        error: error as Error,
+      };
+    }
   }
-
   return {
     success: true,
     command: commandString,

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

@@ -1,7 +1,7 @@
 import { logger } from '@nx/devkit';
 import { afterAll, afterEach, beforeEach, expect, vi } from 'vitest';
 import { executorContext } from '@code-pushup/test-nx-utils';
-import { MEMFS_VOLUME, removeColorCodes } from '@code-pushup/test-utils';
+import { MEMFS_VOLUME } from '@code-pushup/test-utils';
 import * as executeProcessModule from '../../internal/execute-process.js';
 import runAutorunExecutor from './executor.js';
 
@@ -124,25 +124,24 @@ describe('runAutorunExecutor', () => {
 
     expect(output.command).toMatch('--verbose');
     expect(loggerWarnSpy).toHaveBeenCalledTimes(0);
-    expect(loggerInfoSpy).toHaveBeenCalledTimes(1);
+    expect(loggerInfoSpy).toHaveBeenCalledTimes(2);
     expect(loggerInfoSpy).toHaveBeenCalledWith(
       expect.stringContaining(`Run CLI executor`),
     );
+    expect(loggerInfoSpy).toHaveBeenCalledWith(
+      expect.stringContaining('Command: npx @code-pushup/cli'),
+    );
   });
 
-  it('should call executeProcess with dryRun option', async () => {
-    const output = await runAutorunExecutor(
-      { dryRun: true },
-      executorContext('utils'),
-    );
+  it('should log command if dryRun is set', async () => {
+    await runAutorunExecutor({ dryRun: true }, executorContext('utils'));
 
-    expect(output.success).toBe(true);
-    expect(executeProcessSpy).toHaveBeenCalledWith(
-      expect.objectContaining({
-        dryRun: true,
-      }),
-    );
     expect(loggerInfoSpy).toHaveBeenCalledTimes(0);
-    expect(loggerWarnSpy).toHaveBeenCalledTimes(0);
+    expect(loggerWarnSpy).toHaveBeenCalledTimes(1);
+    expect(loggerWarnSpy).toHaveBeenCalledWith(
+      expect.stringContaining(
+        'DryRun execution of: npx @code-pushup/cli --dryRun',
+      ),
+    );
   });
 });

packages/nx-plugin/src/executors/cli/schema.json

@@ -21,13 +21,6 @@
       "type": "string",
       "description": "Path to Code PushUp CLI"
     },
-    "env": {
-      "type": "object",
-      "description": "Environment variables to set when running the command",
-      "additionalProperties": {
-        "type": "string"
-      }
-    },
     "verbose": {
       "type": "boolean",
       "description": "Print additional logs"

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

@@ -1,5 +1,4 @@
 import { logger } from '@nx/devkit';
-import chalk from 'chalk';
 import type { ProcessConfig } from '../../internal/execute-process.js';
 
 export function createCliCommandString(options?: {
@@ -13,49 +12,15 @@ export function createCliCommandString(options?: {
   )}`;
 }
 
-export function formatCommandLog({
-  command,
-  args = [],
-  env,
-}: {
-  command: string;
-  args: string[];
-  env?: Record<string, string>;
-}): string {
-  const logElements: string[] = [];
-  if (env) {
-    const envVars = Object.entries(env).map(
-      ([key, value]) =>
-        `${chalk.green(key)}="${chalk.blueBright(value.replaceAll('"', ''))}"`,
-    );
-    // eslint-disable-next-line functional/immutable-data
-    logElements.push(...envVars);
-  }
-  // eslint-disable-next-line functional/immutable-data
-  logElements.push(chalk.cyan(command));
-  if (args.length > 0) {
-    // eslint-disable-next-line functional/immutable-data
-    logElements.push(chalk.dim.gray(args.join(' ')));
-  }
-  return logElements.join(' ');
-}
-
 export function createCliCommandObject(options?: {
   args?: Record<string, unknown>;
-  command?: 'autorun' | 'collect' | 'upload' | 'print-config' | string;
+  command?: string;
   bin?: string;
 }): ProcessConfig {
-  const { bin = 'npx @code-pushup/cli', command, args } = options ?? {};
-  const binArr = bin.split(' ');
-
-  // If bin contains spaces, use the first part as command and rest as args
-  // If bin is a single path, default to 'npx' and use the bin as first arg
-  const finalCommand = binArr.length > 1 ? (binArr[0] ?? 'npx') : 'npx';
-  const binArgs = binArr.length > 1 ? binArr.slice(1) : [bin];
-
+  const { bin = '@code-pushup/cli', command, args } = options ?? {};
   return {
-    command: finalCommand,
-    args: [...binArgs, ...objectToCliArgs({ _: command ?? [], ...args })],
+    command: 'npx',
+    args: [bin, ...objectToCliArgs({ _: command ?? [], ...args })],
     observer: {
       onError: error => {
         logger.error(error.message);