feat(nx-plugin): add support for local code execution

Author: BioPhoton

nx.json

@@ -344,6 +344,17 @@
     "releaseTagPattern": "v{version}"
   },
   "plugins": [
+    {
+      "plugin": "@code-pushup/nx-plugin",
+      "options": {
+        "pluginBin": "packages/nx-plugin/dist",
+        "cliBin": "packages/cli/src/index.ts",
+        "env": {
+          "NODE_OPTIONS": "--import tsx",
+          "TSX_TSCONFIG_PATH": "tsconfig.base.json"
+        }
+      }
+    },
     {
       "plugin": "@push-based/nx-verdaccio",
       "options": {

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

@@ -72,6 +72,7 @@ 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. |
-| **bin**           | `string`  | Path to Code PushUp CLI                                            |
+| **cliBin**        | `string`  | Path to Code PushUp CLI                                            |
+| **pluginBin**     | `string`  | Path to Code PushUp Nx Plugin                                      |
 
 For all other options see the [CLI autorun documentation](../../../../cli/README.md#autorun-command).

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

@@ -19,7 +19,7 @@ export default async function runAutorunExecutor(
   context: ExecutorContext,
 ): Promise<ExecutorOutput> {
   const normalizedContext = normalizeContext(context);
-  const mergedOptions = mergeExecutorOptions(
+  const { env, ...mergedOptions } = mergeExecutorOptions(
     context.target?.options,
     terminalAndExecutorOptions,
   );
@@ -43,6 +43,7 @@ export default async function runAutorunExecutor(
       await executeProcess({
         ...createCliCommandObject({ command, args: cliArgumentObject }),
         ...(context.cwd ? { cwd: context.cwd } : {}),
+        env,
       });
     } catch (error) {
       logger.error(error);

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

@@ -21,6 +21,13 @@
       "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/types.ts

@@ -30,6 +30,7 @@ export type Command =
 export type GlobalExecutorOptions = {
   command?: Command;
   bin?: string;
+  env?: Record<string, string>;
   verbose?: boolean;
   progress?: boolean;
   config?: string;

packages/nx-plugin/src/internal/execute-process.ts

@@ -86,6 +86,7 @@ export type ProcessConfig = {
   command: string;
   args?: string[];
   cwd?: string;
+  env?: Record<string, string>;
   observer?: ProcessObserver;
   ignoreExitCode?: boolean;
 };
@@ -138,7 +139,7 @@ export type ProcessObserver = {
  * @param cfg - see {@link ProcessConfig}
  */
 export function executeProcess(cfg: ProcessConfig): Promise<ProcessResult> {
-  const { observer, cwd, command, args, ignoreExitCode = false } = cfg;
+  const { observer, cwd, command, args, ignoreExitCode = false, env } = cfg;
   const { onStdout, onError, onComplete } = observer ?? {};
   const date = new Date().toISOString();
   const start = performance.now();
@@ -152,7 +153,7 @@ export function executeProcess(cfg: ProcessConfig): Promise<ProcessResult> {
 
   return new Promise((resolve, reject) => {
     // shell:true tells Windows to use shell command for spawning a child process
-    const process = spawn(command, args, { cwd, shell: true });
+    const process = spawn(command, args, { cwd, shell: true, env });
     // eslint-disable-next-line functional/no-let
     let stdout = '';
     // eslint-disable-next-line functional/no-let

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

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

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

@@ -7,15 +7,15 @@ import { CP_TARGET_NAME } from '../constants.js';
 export function createConfigurationTarget(options?: {
   targetName?: string;
   projectName?: string;
-  bin?: string;
+  pluginBin?: string;
 }): TargetConfiguration<RunCommandsOptions> {
   const {
     projectName,
-    bin = PACKAGE_NAME,
+    pluginBin = PACKAGE_NAME,
     targetName = CP_TARGET_NAME,
   } = options ?? {};
   return {
-    command: `nx g ${bin}:configuration ${objectToCliArgs({
+    command: `nx g ${pluginBin}:configuration ${objectToCliArgs({
       skipTarget: true,
       targetName,
       ...(projectName ? { project: projectName } : {}),

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

@@ -1,18 +1,25 @@
 import type { TargetConfiguration } from '@nx/devkit';
+import type { AutorunCommandExecutorOptions } from '../../executors/cli/schema.js';
 import { PACKAGE_NAME } from '../../internal/constants.js';
-import type { ProjectPrefixOptions } from '../types.js';
+import type { CreateNodesOptions } from '../types.js';
 
-export function createExecutorTarget(options?: {
-  bin?: string;
-  projectPrefix?: string;
-}): TargetConfiguration<ProjectPrefixOptions> {
-  const { bin = PACKAGE_NAME, projectPrefix } = options ?? {};
+export function createExecutorTarget(
+  options?: CreateNodesOptions,
+): TargetConfiguration<AutorunCommandExecutorOptions> {
+  const {
+    pluginBin = PACKAGE_NAME,
+    projectPrefix,
+    cliBin,
+    env,
+  } = options ?? {};
   return {
-    executor: `${bin}:cli`,
+    executor: `${pluginBin}:cli`,
     ...(projectPrefix
       ? {
           options: {
             projectPrefix,
+            ...(cliBin ? { bin: cliBin } : {}),
+            ...(env ? { env } : {}),
           },
         }
       : {}),

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

@@ -9,7 +9,7 @@ describe('createExecutorTarget', () => {
   });
 
   it('should use bin if provides', () => {
-    expect(createExecutorTarget({ bin: 'xyz' })).toStrictEqual({
+    expect(createExecutorTarget({ pluginBin: 'xyz' })).toStrictEqual({
       executor: 'xyz:cli',
     });
   });