refactor: intro evn options to cli executor

Author: John Doe

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

@@ -23,7 +23,13 @@ export default async function runAutorunExecutor(
     terminalAndExecutorOptions,
     normalizedContext,
   );
-  const { dryRun, verbose, command, bin } = terminalAndExecutorOptions;
+  const {
+    dryRun,
+    verbose,
+    command,
+    bin,
+    env: targetEnv,
+  } = terminalAndExecutorOptions;
   const commandString = createCliCommandString({
     command,
     args: cliArgumentObject,
@@ -40,6 +46,7 @@ export default async function runAutorunExecutor(
       await executeProcess({
         ...createCliCommandObject({ command, args: cliArgumentObject, bin }),
         ...(context.cwd ? { cwd: context.cwd } : {}),
+        ...(targetEnv ? { env: targetEnv } : {}),
       });
     } catch (error) {
       logger.error(error);

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

@@ -46,11 +46,13 @@ describe('runAutorunExecutor', () => {
     const output = await runAutorunExecutor({}, executorContext('utils'));
     expect(output.success).toBe(true);
     expect(output.command).toMatch('npx @code-pushup/cli');
-    expect(executeProcessSpy).toHaveBeenCalledWith({
-      command: 'npx',
-      args: expect.arrayContaining(['@code-pushup/cli']),
-      cwd: MEMFS_VOLUME,
-    });
+    expect(executeProcessSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        command: 'npx',
+        args: expect.arrayContaining(['@code-pushup/cli']),
+        cwd: MEMFS_VOLUME,
+      }),
+    );
   });
 
   it('should normalize context', async () => {
@@ -62,12 +64,15 @@ describe('runAutorunExecutor', () => {
       },
     );
     expect(output.success).toBe(true);
-    expect(output.command).toMatch('utils');
-    expect(executeProcessSpy).toHaveBeenCalledWith({
-      command: 'npx',
-      args: expect.arrayContaining(['@code-pushup/cli']),
-      cwd: 'cwd-form-context',
-    });
+    expect(output.command).toMatch('npx @code-pushup/cli');
+    expect(output.command).toContain('cwd-form-context');
+    expect(executeProcessSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        command: 'npx',
+        args: expect.arrayContaining(['@code-pushup/cli']),
+        cwd: 'cwd-form-context',
+      }),
+    );
   });
 
   it('should process executorOptions', async () => {

packages/nx-plugin/src/generators/configuration/schema.d.ts

@@ -2,7 +2,6 @@ import type { DynamicTargetOptions } from '../../internal/types.js';
 
 export type ConfigurationGeneratorOptions = {
   project: string;
-  bin?: string;
   skipTarget?: boolean;
   skipConfig?: boolean;
   skipFormat?: boolean;

packages/nx-plugin/src/internal/types.ts

@@ -1,4 +1,5 @@
 export type DynamicTargetOptions = {
   targetName?: string;
   bin?: string;
+  env?: Record<string, string>;
 };

packages/nx-plugin/src/plugin/target/executor-target.ts

@@ -5,13 +5,17 @@ import type { ProjectPrefixOptions } from '../types.js';
 export function createExecutorTarget(options?: {
   bin?: string;
   projectPrefix?: string;
-}): TargetConfiguration<ProjectPrefixOptions> {
-  const { bin, projectPrefix } = options ?? {};
+  env?: Record<string, string>;
+}): TargetConfiguration<
+  ProjectPrefixOptions & { env?: Record<string, string> }
+> {
+  const { bin, projectPrefix, env } = options ?? {};
 
   const executor = `${PACKAGE_NAME}:cli`;
-  const executorOptions = (bin || projectPrefix) && {
+  const executorOptions = (bin || projectPrefix || env) && {
     ...(bin && { bin }),
     ...(projectPrefix && { projectPrefix }),
+    ...(env && { env }),
   };
   return { executor, ...(executorOptions && { options: executorOptions }) };
 }

packages/nx-plugin/src/plugin/target/executor.target.unit.test.ts

@@ -27,4 +27,23 @@ describe('createExecutorTarget', () => {
       },
     });
   });
+
+  it('should use env if provided', () => {
+    expect(
+      createExecutorTarget({
+        env: {
+          NODE_OPTIONS: '--import tsx',
+          TSX_TSCONFIG_PATH: 'tsconfig.base.json',
+        },
+      }),
+    ).toStrictEqual({
+      executor: '@code-pushup/nx-plugin:cli',
+      options: {
+        env: {
+          NODE_OPTIONS: '--import tsx',
+          TSX_TSCONFIG_PATH: 'tsconfig.base.json',
+        },
+      },
+    });
+  });
 });

packages/nx-plugin/src/plugin/target/targets.ts

@@ -19,17 +19,17 @@ export async function createTargets(normalizedContext: CreateTargetsOptions) {
     targetName = CP_TARGET_NAME,
     bin,
     projectPrefix,
+    env,
   } = normalizedContext.createOptions;
   const rootFiles = await readdir(normalizedContext.projectRoot);
   return rootFiles.some(filename => filename.match(CODE_PUSHUP_CONFIG_REGEX))
     ? {
-        [targetName]: createExecutorTarget({ bin, projectPrefix }),
+        [targetName]: createExecutorTarget({ bin, projectPrefix, env }),
       }
     : // if NO code-pushup.config.*.(ts|js|mjs) is present return configuration target
       {
-        [`${targetName}--configuration`]: createConfigurationTarget({
+        [`${targetName}--configuration`]: await createConfigurationTarget({
           projectName: normalizedContext.projectJson.name,
-          bin,
         }),
       };
 }