refactor: use utils in nx-plugin (#1157)

related to #1091 

**This PR includes:**
- alignments of terminal args helper
- add command formatter helper to `utils`
- reuse utils in `nx-plugin` and remove old code
- remove bin logic from config target (left over of #1109)

---------

Co-authored-by: John Doe <[email protected]>

Author: BioPhoton

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

@@ -103,29 +103,6 @@ describe('nx-plugin', () => {
     });
   });
 
-  it('should consider plugin option bin in configuration target', async () => {
-    const cwd = path.join(testFileDir, 'configuration-option-bin');
-    registerPluginInWorkspace(tree, {
-      plugin: '@code-pushup/nx-plugin',
-      options: {
-        bin: 'XYZ',
-      },
-    });
-    await materializeTree(tree, cwd);
-
-    const { code, projectJson } = await nxShowProjectJson(cwd, project);
-
-    expect(code).toBe(0);
-
-    expect(projectJson.targets).toStrictEqual({
-      'code-pushup--configuration': expect.objectContaining({
-        options: {
-          command: `nx g XYZ:configuration --project="${project}"`,
-        },
-      }),
-    });
-  });
-
   it('should NOT add config targets dynamically if the project is configured', async () => {
     const cwd = path.join(testFileDir, 'configuration-already-configured');
     registerPluginInWorkspace(tree, '@code-pushup/nx-plugin');
@@ -199,8 +176,10 @@ describe('nx-plugin', () => {
     // Nx command
     expect(cleanStdout).toContain('nx run my-lib:code-pushup');
     // Run CLI executor
-    expect(cleanStdout).toContain('Command: npx @code-pushup/cli');
-    expect(cleanStdout).toContain('--dryRun --verbose');
+    expect(cleanStdout).toContain('Command:');
+    expect(cleanStdout).toContain('npx @code-pushup/cli');
+    expect(cleanStdout).toContain('--verbose');
+    expect(cleanStdout).toContain('--dryRun ');
   });
 
   it('should consider plugin option bin in executor target', async () => {

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

@@ -1,9 +1,5 @@
 import { type ExecutorContext, logger } from '@nx/devkit';
 import { executeProcess } from '../../internal/execute-process.js';
-import {
-  createCliCommandObject,
-  createCliCommandString,
-} from '../internal/cli.js';
 import { normalizeContext } from '../internal/context.js';
 import type { AutorunCommandExecutorOptions } from './schema.js';
 import { parseAutorunExecutorOptions } from './utils.js';
@@ -14,20 +10,33 @@ export type ExecutorOutput = {
   error?: Error;
 };
 
+/* eslint-disable-next-line max-lines-per-function */
 export default async function runAutorunExecutor(
   terminalAndExecutorOptions: AutorunCommandExecutorOptions,
   context: ExecutorContext,
 ): Promise<ExecutorOutput> {
+  const { objectToCliArgs, formatCommandStatus } = await import(
+    '@code-pushup/utils'
+  );
   const normalizedContext = normalizeContext(context);
   const cliArgumentObject = parseAutorunExecutorOptions(
     terminalAndExecutorOptions,
     normalizedContext,
   );
-  const { dryRun, verbose, command, bin } = terminalAndExecutorOptions;
-  const commandString = createCliCommandString({
-    command,
-    args: cliArgumentObject,
+  const {
+    dryRun,
+    verbose,
+    command: cliCommand,
     bin,
+  } = terminalAndExecutorOptions;
+  const command = bin ? `node` : 'npx';
+  const positionals = [
+    bin ?? '@code-pushup/cli',
+    ...(cliCommand ? [cliCommand] : []),
+  ];
+  const args = [...positionals, ...objectToCliArgs(cliArgumentObject)];
+  const commandString = formatCommandStatus([command, ...args].join(' '), {
+    cwd: context.cwd,
   });
   if (verbose) {
     logger.info(`Run CLI executor ${command ?? ''}`);
@@ -38,7 +47,8 @@ export default async function runAutorunExecutor(
   } else {
     try {
       await executeProcess({
-        ...createCliCommandObject({ command, args: cliArgumentObject, bin }),
+        command,
+        args,
         ...(context.cwd ? { cwd: context.cwd } : {}),
       });
     } catch (error) {

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

@@ -122,7 +122,7 @@ describe('runAutorunExecutor', () => {
       expect.stringContaining(`Run CLI executor`),
     );
     expect(loggerInfoSpy).toHaveBeenCalledWith(
-      expect.stringContaining('Command: npx @code-pushup/cli'),
+      expect.stringContaining('Command:'),
     );
   });
 
@@ -132,9 +132,7 @@ describe('runAutorunExecutor', () => {
     expect(loggerInfoSpy).toHaveBeenCalledTimes(0);
     expect(loggerWarnSpy).toHaveBeenCalledTimes(1);
     expect(loggerWarnSpy).toHaveBeenCalledWith(
-      expect.stringContaining(
-        'DryRun execution of: npx @code-pushup/cli --dryRun',
-      ),
+      expect.stringContaining('DryRun execution of'),
     );
   });
 });

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

@@ -11,7 +11,6 @@ const plugin = {
 export default plugin;
 
 export type { AutorunCommandExecutorOptions } from './executors/cli/schema.js';
-export { objectToCliArgs } from './executors/internal/cli.js';
 export { generateCodePushupConfig } from './generators/configuration/code-pushup-config.js';
 export { configurationGenerator } from './generators/configuration/generator.js';
 export type { ConfigurationGeneratorOptions } from './generators/configuration/schema.js';

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

@@ -1,19 +1,17 @@
 import type { TargetConfiguration } from '@nx/devkit';
 import type { RunCommandsOptions } from 'nx/src/executors/run-commands/run-commands.impl';
-import { objectToCliArgs } from '../../executors/internal/cli.js';
 import { PACKAGE_NAME } from '../../internal/constants.js';
 
-export function createConfigurationTarget(options?: {
+export async function createConfigurationTarget(options?: {
   projectName?: string;
-  bin?: string;
-}): TargetConfiguration<RunCommandsOptions> {
-  const { projectName, bin = PACKAGE_NAME } = options ?? {};
+}): Promise<TargetConfiguration<RunCommandsOptions>> {
+  const { projectName } = options ?? {};
+  const { objectToCliArgs } = await import('@code-pushup/utils');
   const args = objectToCliArgs({
     ...(projectName ? { project: projectName } : {}),
   });
-  const argsString = args.length > 0 ? args.join(' ') : '';
-  const baseCommand = `nx g ${bin}:configuration`;
+  const argsString = args.length > 0 ? ` ${args.join(' ')}` : '';
   return {
-    command: argsString ? `${baseCommand} ${argsString}` : baseCommand,
+    command: `nx g ${PACKAGE_NAME}:configuration${argsString}`,
   };
 }

packages/nx-plugin/src/index.ts

@@ -3,16 +3,16 @@ import { PACKAGE_NAME } from '../../internal/constants.js';
 import { createConfigurationTarget } from './configuration-target.js';
 
 describe('createConfigurationTarget', () => {
-  it('should return code-pushup--configuration target for given project', () => {
-    expect(
+  it('should return code-pushup--configuration target for given project', async () => {
+    await expect(
       createConfigurationTarget({ projectName: 'my-project' }),
-    ).toStrictEqual({
+    ).resolves.toStrictEqual({
       command: `nx g ${PACKAGE_NAME}:configuration --project="my-project"`,
     });
   });
 
-  it('should return code-pushup--configuration target without project name', () => {
-    expect(createConfigurationTarget()).toStrictEqual({
+  it('should return code-pushup--configuration target without project name', async () => {
+    await expect(createConfigurationTarget()).resolves.toStrictEqual({
       command: `nx g ${PACKAGE_NAME}:configuration`,
     });
   });