refactor(cli): make ValidationError, SourcedValidationError, and KeyringUnavailableError extend CliError

Each subclass now carries a default error code (VALIDATION_ERROR / AUTH_ERROR),
eliminating the need for the separate extractErrorCode and local
shouldReportToSentry functions in withContext.ts. reportError now relies
entirely on resolveErrorCode and the shared shouldReportToSentry from
@fern-api/task-context.

Made-with: Cursor

Author: FedeZara

packages/cli/cli-v2/src/auth/errors/KeyringUnavailableError.ts

@@ -1,12 +1,18 @@
+import { CliError } from "@fern-api/task-context";
+
 /**
  * Error thrown when the system keyring is unavailable.
  */
-export class KeyringUnavailableError extends Error {
+export class KeyringUnavailableError extends CliError {
     public readonly platform: NodeJS.Platform;
-    public readonly cause?: Error;
+    public override readonly cause?: Error;
 
     constructor(platform: NodeJS.Platform, cause?: Error) {
-        super(getKeyringErrorMessage(platform));
+        super({
+            message: getKeyringErrorMessage(platform),
+            code: "AUTH_ERROR"
+        });
+        Object.setPrototypeOf(this, KeyringUnavailableError.prototype);
         this.platform = platform;
         this.cause = cause;
     }

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

@@ -1,10 +1,5 @@
 import { LogLevel } from "@fern-api/logger";
-import {
-    CliError,
-    resolveErrorCode,
-    shouldReportToSentry as shouldReportCodeToSentry,
-    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";
@@ -108,44 +103,17 @@ function handleError(context: Context, error: unknown): void {
     process.stderr.write(`${chalk.red(String(error))}\n`);
 }
 
-function shouldReportToSentry(error: unknown): boolean {
-    if (error instanceof TaskAbortSignal) {
-        return false;
-    }
-    if (error instanceof CliError) {
-        return shouldReportCodeToSentry(error.code);
-    }
-    if (
-        error instanceof ValidationError ||
-        error instanceof SourcedValidationError ||
-        error instanceof KeyringUnavailableError
-    ) {
-        return false;
-    }
-    return true;
-}
-
-function extractErrorCode(error: unknown): string {
-    if (error instanceof CliError) {
-        return error.code;
-    }
-    if (error instanceof ValidationError || error instanceof SourcedValidationError) {
-        return "VALIDATION_ERROR";
-    }
-    if (error instanceof KeyringUnavailableError) {
-        return "AUTH_ERROR";
-    }
-    return "INTERNAL_ERROR";
-}
-
 /**
  * Reports an error to Sentry (conditionally) and PostHog.
  * Called from the top-level catch in withContext and from
  * TaskContextAdapter.failWithoutThrowing.
  */
 export function reportError(context: Context, error: unknown, options?: { code?: CliError.Code }): void {
-    const code = resolveErrorCode(error, options?.code) ?? extractErrorCode(error);
-    if (shouldReportToSentry(error)) {
+    if (error instanceof TaskAbortSignal) {
+        return;
+    }
+    const code = resolveErrorCode(error, options?.code) ?? "INTERNAL_ERROR";
+    if (shouldReportToSentry(code)) {
         context.telemetry.captureException(error);
     }
     context.telemetry.sendLifecycleEvent({

packages/cli/cli-v2/src/errors/SourcedValidationError.ts

@@ -1,3 +1,4 @@
+import { CliError } from "@fern-api/task-context";
 import { ValidationIssue } from "@fern-api/yaml-loader";
 
 /**
@@ -6,11 +7,15 @@ import { ValidationIssue } from "@fern-api/yaml-loader";
  * Used for fern.yml schema validation where each issue has a precise SourceLocation.
  * When displayed, each issue is shown on its own line with file:line:col prefix.
  */
-export class SourcedValidationError extends Error {
+export class SourcedValidationError extends CliError {
     public readonly issues: ValidationIssue[];
 
     constructor(issues: ValidationIssue[]) {
-        super(issues.map((issue) => issue.toString()).join("\n"));
+        super({
+            message: issues.map((issue) => issue.toString()).join("\n"),
+            code: "VALIDATION_ERROR"
+        });
+        Object.setPrototypeOf(this, SourcedValidationError.prototype);
         this.issues = issues;
     }
 }

packages/cli/cli-v2/src/errors/ValidationError.ts

@@ -1,3 +1,5 @@
+import { CliError } from "@fern-api/task-context";
+
 import type { ValidationViolation } from "./ValidationViolation.js";
 
 /**
@@ -6,11 +8,15 @@ import type { ValidationViolation } from "./ValidationViolation.js";
  * When displayed, each violation is shown on its own line with filepath prefix
  * and severity-appropriate coloring.
  */
-export class ValidationError extends Error {
+export class ValidationError extends CliError {
     public readonly violations: ValidationViolation[];
 
     constructor(violations: ValidationViolation[]) {
-        super(violations.map((v) => `${v.relativeFilepath}: ${v.message}`).join("\n"));
+        super({
+            message: violations.map((v) => `${v.relativeFilepath}: ${v.message}`).join("\n"),
+            code: "VALIDATION_ERROR"
+        });
+        Object.setPrototypeOf(this, ValidationError.prototype);
         this.violations = violations;
     }
 }