refactor(cli): rename clashing runtime detector -> cli runtime detector

Author: cabljac

genkit-tools/cli/src/commands/ui-start.ts

@@ -31,7 +31,7 @@ import fs from 'fs/promises';
 import getPort, { makeRange } from 'get-port';
 import open from 'open';
 import path from 'path';
-import { detectRuntime } from '../utils/runtime-detector';
+import { detectCLIRuntime } from '../utils/runtime-detector';
 import {
   buildServerHarnessSpawnConfig,
   validateExecutablePath,
@@ -133,15 +133,17 @@ async function startAndWaitUntilHealthy(
   serversDir: string
 ): Promise<ChildProcess> {
   // Detect runtime environment
-  const runtime = detectRuntime();
-  logger.debug(`Detected runtime: ${runtime.type} at ${runtime.execPath}`);
-  if (runtime.scriptPath) {
-    logger.debug(`Script path: ${runtime.scriptPath}`);
+  const cliRuntime = detectCLIRuntime();
+  logger.debug(
+    `Detected CLI runtime: ${cliRuntime.type} at ${cliRuntime.execPath}`
+  );
+  if (cliRuntime.scriptPath) {
+    logger.debug(`Script path: ${cliRuntime.scriptPath}`);
   }
 
   // Build spawn configuration
   const logPath = path.join(serversDir, 'devui.log');
-  const spawnConfig = buildServerHarnessSpawnConfig(runtime, port, logPath);
+  const spawnConfig = buildServerHarnessSpawnConfig(cliRuntime, port, logPath);
 
   // Validate executable path
   const isExecutable = await validateExecutablePath(spawnConfig.command);

genkit-tools/cli/src/utils/runtime-detector.ts

@@ -27,16 +27,16 @@ const BUN_PATTERNS = ['bun'];
 const SCRIPT_EXTENSIONS = ['.js', '.mjs', '.cjs', '.ts', '.tsx', '.jsx'];
 
 /**
- * Runtime types supported by the detector
+ * CLI runtime types supported by the detector
  */
-export type RuntimeType = 'node' | 'bun' | 'compiled-binary';
+export type CLIRuntimeType = 'node' | 'bun' | 'compiled-binary';
 
 /**
- * Information about the runtime environment
+ * Information about the CLI runtime environment
  */
-export interface RuntimeInfo {
-  /** Type of runtime or execution mode */
-  type: RuntimeType;
+export interface CLIRuntimeInfo {
+  /** Type of CLI runtime or execution mode */
+  type: CLIRuntimeType;
   /** Path to the executable (node, bun, or the compiled binary itself) */
   execPath: string;
   /** Path to the script being executed (undefined for compiled binaries) */
@@ -85,18 +85,18 @@ function matchesPatterns(execName: string, patterns: string[]): boolean {
 }
 
 /**
- * Detects the current runtime environment and execution context.
+ * Detects the current CLI runtime environment and execution context.
  * This helps determine how to properly spawn child processes.
  *
- * @returns Runtime information including type, paths, and platform
- * @throws Error if unable to determine executable path
+ * @returns CLI runtime information including type, paths, and platform
+ * @throws Error if unable to determine CLI runtime executable path
  */
-export function detectRuntime(): RuntimeInfo {
+export function detectCLIRuntime(): CLIRuntimeInfo {
   const platform = process.platform;
   const execPath = process.execPath;
 
   if (!execPath || execPath.trim() === '') {
-    throw new Error('Unable to determine executable path');
+    throw new Error('Unable to determine CLI runtime executable path');
   }
 
   const argv0 = process.argv[0];
@@ -116,7 +116,7 @@ export function detectRuntime(): RuntimeInfo {
   const hasScriptArg = !!argv1;
   const scriptExists = hasScriptArg && safeExistsSync(argv1);
 
-  let type: RuntimeType;
+  let type: CLIRuntimeType;
   let scriptPath: string | undefined;
   let isCompiledBinary: boolean;
 

genkit-tools/cli/src/utils/spawn-config.ts

@@ -17,7 +17,7 @@
 import { type SpawnOptions } from 'child_process';
 import { access, constants } from 'fs/promises';
 import { SERVER_HARNESS_COMMAND } from '../commands/server-harness';
-import { type RuntimeInfo } from './runtime-detector';
+import { type CLIRuntimeInfo } from './runtime-detector';
 
 /**
  * Configuration for spawning a child process
@@ -60,30 +60,30 @@ function isValidPort(port: number): boolean {
 /**
  * Builds spawn configuration for the server harness based on runtime info
  *
- * @param runtime - Runtime information from detector
+ * @param cliRuntime - CLI runtime information from detector
  * @param port - Port number for the server (must be valid port 0-65535)
  * @param logPath - Path to the log file
  * @returns Spawn configuration for child_process.spawn
  * @throws Error if port is invalid or runtime info is missing required fields
  *
  * @example
  * ```typescript
- * const runtime = detectRuntime();
- * const config = buildServerHarnessSpawnConfig(runtime, 4000, '/path/to/log');
+ * const cliRuntime = detectRuntime();
+ * const config = buildServerHarnessSpawnConfig(cliRuntime, 4000, '/path/to/log');
  * const child = spawn(config.command, config.args, config.options);
  * ```
  */
 export function buildServerHarnessSpawnConfig(
-  runtime: RuntimeInfo,
+  cliRuntime: CLIRuntimeInfo,
   port: number,
   logPath: string
 ): SpawnConfig {
   // Validate inputs
-  if (!runtime) {
-    throw new Error('Runtime info is required');
+  if (!cliRuntime) {
+    throw new Error('CLI runtime info is required');
   }
-  if (!runtime.execPath) {
-    throw new Error('Runtime execPath is required');
+  if (!cliRuntime.execPath) {
+    throw new Error('CLI runtime execPath is required');
   }
   if (!isValidPort(port)) {
     throw new Error(
@@ -94,16 +94,21 @@ export function buildServerHarnessSpawnConfig(
     throw new Error('Log path is required');
   }
 
-  let command = runtime.execPath;
+  let command = cliRuntime.execPath;
   let args: string[];
 
-  if (runtime.type === 'compiled-binary') {
+  if (cliRuntime.type === 'compiled-binary') {
     // For compiled binaries, execute directly with arguments
     args = [SERVER_HARNESS_COMMAND, port.toString(), logPath];
   } else {
     // For interpreted runtimes (Node.js, Bun), include script path if available
-    args = runtime.scriptPath
-      ? [runtime.scriptPath, SERVER_HARNESS_COMMAND, port.toString(), logPath]
+    args = cliRuntime.scriptPath
+      ? [
+          cliRuntime.scriptPath,
+          SERVER_HARNESS_COMMAND,
+          port.toString(),
+          logPath,
+        ]
       : [SERVER_HARNESS_COMMAND, port.toString(), logPath];
   }
 
@@ -112,11 +117,11 @@ export function buildServerHarnessSpawnConfig(
     stdio: ['ignore', 'ignore', 'ignore'] as const,
     detached: false,
     // Use shell on Windows for better compatibility with paths containing spaces
-    shell: runtime.platform === 'win32',
+    shell: cliRuntime.platform === 'win32',
   };
 
   // Handles spaces in the command and arguments on Windows
-  if (runtime.platform === 'win32') {
+  if (cliRuntime.platform === 'win32') {
     command = `"${command}"`;
     args = args.map((arg) => `"${arg}"`);
   }