refactor(cli): remove LoggableFernCliError in favor of CliError

Replace all LoggableFernCliError throw sites with CliError.internalError()
and remove the dedicated catch branches since CliError is already handled
upstream. Deletes the now-unused LoggableFernCliError class.

Made-with: Cursor

Author: FedeZara

packages/cli/cli-v2/src/context/adapter/TaskContextAdapter.ts

@@ -1,6 +1,6 @@
 import { createLogger, LOG_LEVELS, Logger, LogLevel } from "@fern-api/logger";
 import {
-    type CliErrorCode,
+    type CliError,
     type CreateInteractiveTaskParams,
     type Finishable,
     type InteractiveTaskContext,
@@ -55,12 +55,12 @@ export class TaskContextAdapter implements TaskContext {
         await run();
     }
 
-    public failAndThrow(message?: string, error?: unknown, options?: { code?: CliErrorCode }): never {
+    public failAndThrow(message?: string, error?: unknown, options?: { code?: CliError.Code }): never {
         this.failWithoutThrowing(message, error, options);
         throw new TaskAbortSignal();
     }
 
-    public failWithoutThrowing(message?: string, error?: unknown, options?: { code?: CliErrorCode }): void {
+    public failWithoutThrowing(message?: string, error?: unknown, options?: { code?: CliError.Code }): void {
         this.result = TaskResult.Failure;
         if (error instanceof TaskAbortSignal) {
             return;
@@ -73,8 +73,8 @@ export class TaskContextAdapter implements TaskContext {
         reportError(this.context, error, { ...options, message });
     }
 
-    public captureException(error: unknown, code?: CliErrorCode): void {
-        const errorCode = resolveErrorCode(error, code) ?? "INTERNAL_ERROR";
+    public captureException(error: unknown, code?: CliError.Code): void {
+        const errorCode = resolveErrorCode(error, code);
         this.context.telemetry.captureException(error, { errorCode });
     }
 

packages/cli/cli-v2/src/context/withContext.ts

@@ -1,11 +1,5 @@
 import { LogLevel } from "@fern-api/logger";
-import {
-    CliError,
-    type CliErrorCode,
-    resolveErrorCode,
-    shouldReportToSentry,
-    TaskAbortSignal
-} from "@fern-api/task-context";
+import { CliError, resolveErrorCode, shouldReportToSentry, TaskAbortSignal } from "@fern-api/task-context";
 
 import chalk from "chalk";
 import { KeyringUnavailableError } from "../auth/errors/KeyringUnavailableError.js";
@@ -117,7 +111,7 @@ function handleError(context: Context, error: unknown): void {
 export function reportError(
     context: Context,
     error: unknown,
-    options?: { message?: string; code?: CliErrorCode }
+    options?: { message?: string; code?: CliError.Code }
 ): void {
     if (error instanceof TaskAbortSignal) {
         return;

packages/cli/cli-v2/src/sdk/generator/GeneratorPipeline.ts

@@ -123,7 +123,8 @@ export class GeneratorPipeline {
                 throw new CliError({
                     message:
                         `Custom image configurations are only supported with local generation (--local). ` +
-                        `Target "${args.target.name}" uses a custom image registry.`
+                        `Target "${args.target.name}" uses a custom image registry.`,
+                    code: CliError.Code.ConfigError
                 });
             }
             return await this.runRemoteGeneration(args);

packages/cli/cli/src/cli-context/CliContext.ts

@@ -5,7 +5,6 @@ import { Project } from "@fern-api/project-loader";
 import { isVersionAhead } from "@fern-api/semver-utils";
 import {
     CliError,
-    type CliErrorCode,
     Finishable,
     PosthogEvent,
     resolveErrorCode,
@@ -120,12 +119,12 @@ export class CliContext {
         );
     }
 
-    public failAndThrow(message?: string, error?: unknown, options?: { code?: CliErrorCode }): never {
+    public failAndThrow(message?: string, error?: unknown, options?: { code?: CliError.Code }): never {
         this.failWithoutThrowing(message, error, options);
         throw new TaskAbortSignal();
     }
 
-    public failWithoutThrowing(message?: string, error?: unknown, options?: { code?: CliErrorCode }): void {
+    public failWithoutThrowing(message?: string, error?: unknown, options?: { code?: CliError.Code }): void {
         this.didSucceed = false;
         if (error instanceof TaskAbortSignal) {
             // We already tracked the true error, so we can just return.
@@ -286,7 +285,7 @@ export class CliContext {
         }
     }
 
-    public async captureException(error: unknown, code?: CliErrorCode): Promise<void> {
+    public async captureException(error: unknown, code?: CliError.Code): Promise<void> {
         await this.sentryClient.captureException(error, code);
     }
 

packages/cli/cli/src/cli-context/TaskContextImpl.ts

@@ -3,7 +3,6 @@ import { addPrefixToString } from "@fern-api/core-utils";
 import { createLogger, LogLevel } from "@fern-api/logger";
 import {
     CliError,
-    type CliErrorCode,
     CreateInteractiveTaskParams,
     Finishable,
     InteractiveTaskContext,
@@ -29,7 +28,7 @@ export declare namespace TaskContextImpl {
         onResult?: (result: TaskResult) => void;
         shouldBufferLogs: boolean;
         instrumentPostHogEvent: (event: PosthogEvent) => void;
-        captureException?: (error: unknown, code?: CliErrorCode) => void;
+        captureException?: (error: unknown, code?: CliError.Code) => void;
     }
 }
 
@@ -43,7 +42,7 @@ export class TaskContextImpl implements Startable<TaskContext>, Finishable, Task
     protected status: "notStarted" | "running" | "finished" = "notStarted";
     private onResult: ((result: TaskResult) => void) | undefined;
     private instrumentPostHogEventImpl: (event: PosthogEvent) => void;
-    private captureExceptionImpl?: (error: unknown, code?: CliErrorCode) => void;
+    private captureExceptionImpl?: (error: unknown, code?: CliError.Code) => void;
     public constructor({
         logImmediately,
         logPrefix,
@@ -83,13 +82,13 @@ export class TaskContextImpl implements Startable<TaskContext>, Finishable, Task
 
     public takeOverTerminal: (run: () => void | Promise<void>) => Promise<void>;
 
-    public failAndThrow(message?: string, error?: unknown, options?: { code?: CliErrorCode }): never {
+    public failAndThrow(message?: string, error?: unknown, options?: { code?: CliError.Code }): never {
         this.failWithoutThrowing(message, error, options);
         this.finish();
         throw new TaskAbortSignal();
     }
 
-    public failWithoutThrowing(message?: string, error?: unknown, options?: { code?: CliErrorCode }): void {
+    public failWithoutThrowing(message?: string, error?: unknown, options?: { code?: CliError.Code }): void {
         this.result = TaskResult.Failure;
 
         if (error instanceof TaskAbortSignal) {
@@ -116,7 +115,7 @@ export class TaskContextImpl implements Startable<TaskContext>, Finishable, Task
         }
     }
 
-    public captureException(error: unknown, code?: CliErrorCode): void {
+    public captureException(error: unknown, code?: CliError.Code): void {
         this.captureExceptionImpl?.(error, code);
     }
 

packages/cli/cli/src/cli.ts

@@ -33,7 +33,6 @@ import {
 import { LOG_LEVELS, LogLevel } from "@fern-api/logger";
 import { askToLogin, login, logout } from "@fern-api/login";
 import { protocGenFern } from "@fern-api/protoc-gen-fern";
-import { CliError, LoggableFernCliError, TaskAbortSignal } from "@fern-api/task-context";
 import getPort from "get-port";
 import { Argv } from "yargs";
 import { hideBin } from "yargs/helpers";
@@ -88,8 +87,6 @@ import { RUNTIME } from "./runtime.js";
 
 void runCli();
 
-const USE_NODE_18_OR_ABOVE_MESSAGE = "The Fern CLI requires Node 18+ or above.";
-
 async function runCli() {
     getOrCreateFernRunId();
 
@@ -134,25 +131,7 @@ async function runCli() {
             });
         }
     } catch (error) {
-        cliContext.instrumentPostHogEvent({
-            command: process.argv.join(" "),
-            properties: {
-                failed: true,
-                error
-            }
-        });
-        if (error instanceof CliError) {
-            cliContext.failWithoutThrowing(error.message, error);
-        } else if ((error as Error)?.message?.includes("globalThis")) {
-            cliContext.logger.error(USE_NODE_18_OR_ABOVE_MESSAGE);
-            cliContext.failWithoutThrowing(undefined, error, { code: "ENVIRONMENT_ERROR" });
-        } else if (error instanceof TaskAbortSignal) {
-            cliContext.failWithoutThrowing();
-        } else if (error instanceof LoggableFernCliError) {
-            cliContext.logger.error(`Failed. ${error.log}`);
-        } else {
-            cliContext.failWithoutThrowing("Failed.", error, { code: "INTERNAL_ERROR" });
-        }
+        cliContext.failWithoutThrowing(undefined, error);
     }
 
     await exit();

packages/cli/generation/ir-generator/src/extended-properties/addExtendedPropertiesToIr.ts

@@ -6,7 +6,7 @@ import {
     ObjectTypeDeclaration,
     TypeDeclaration
 } from "@fern-api/ir-sdk";
-import { LoggableFernCliError } from "@fern-api/task-context";
+import { CliError } from "@fern-api/task-context";
 
 import { getTypeDeclaration } from "../utils/getTypeDeclaration.js";
 
@@ -96,9 +96,7 @@ function getObjectTypeDeclarationFromTypeId(typeId: string, ir: TypesAndServices
         }
     }
 
-    throw new LoggableFernCliError(
-        `Unexpected error: ${typeId} is extended but has shape ${typeDeclaration.shape.type}`
-    );
+    throw CliError.internalError(`Unexpected error: ${typeId} is extended but has shape ${typeDeclaration.shape.type}`);
 }
 
 function getAllPropertiesForObject({

packages/cli/generation/ir-generator/src/utils/getTypeDeclaration.ts

@@ -1,10 +1,10 @@
 import { TypeDeclaration } from "@fern-api/ir-sdk";
-import { LoggableFernCliError } from "@fern-api/task-context";
+import { CliError } from "@fern-api/task-context";
 
 export function getTypeDeclaration(typeId: string, types: Record<string, TypeDeclaration>): TypeDeclaration {
     const maybeTypeDeclaration = types[typeId];
     if (maybeTypeDeclaration == null) {
-        throw new LoggableFernCliError(`Illegal Error: Failed to load type declaration for type ${typeId}`);
+        throw CliError.internalError(`Failed to load type declaration for type ${typeId}`);
     }
     return maybeTypeDeclaration;
 }

packages/cli/generation/local-generation/local-workspace-runner/src/GenerationRunner.ts

@@ -4,7 +4,7 @@ import { generatorsYml, SNIPPET_JSON_FILENAME } from "@fern-api/configuration";
 import { AbsoluteFilePath, join, RelativeFilePath } from "@fern-api/fs-utils";
 import { generateIntermediateRepresentation } from "@fern-api/ir-generator";
 import { IntermediateRepresentation } from "@fern-api/ir-sdk";
-import { LoggableFernCliError, TaskAbortSignal, TaskContext } from "@fern-api/task-context";
+import { TaskAbortSignal, TaskContext } from "@fern-api/task-context";
 import { FernGeneratorExec } from "@fern-fern/generator-exec-sdk";
 import chalk from "chalk";
 import { generateDynamicSnippetTests } from "./dynamic-snippets/generateDynamicSnippetTests.js";
@@ -101,8 +101,6 @@ export class GenerationRunner {
                         } catch (error) {
                             if (error instanceof TaskAbortSignal) {
                                 // already logged by failAndThrow, nothing to do
-                            } else if (error instanceof LoggableFernCliError) {
-                                interactiveTaskContext.failWithoutThrowing(`Generation failed: ${error.log}`, error);
                             } else {
                                 interactiveTaskContext.failWithoutThrowing(
                                     `Generation failed: ${error instanceof Error ? error.message : "Unknown error"}`,