chore(cli): wrap third-party errors (get-port, latest-version, inquirer, stream-json) in CliError

Made-with: Cursor

Author: FedeZara

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

@@ -74,7 +74,7 @@ export class TaskContextAdapter implements TaskContext {
     }
 
     public captureException(error: unknown, code?: CliError.Code): void {
-        const errorCode = resolveErrorCode(error, code);
+        const errorCode = resolveErrorCode(error, code) ?? "INTERNAL_ERROR";
         this.context.telemetry.captureException(error, { errorCode });
     }
 

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

@@ -439,7 +439,15 @@ export class CliContext {
      * @returns Promise<string> representing the user's input
      */
     public async getInput(config: { message: string; default?: string }): Promise<string> {
-        return await input({ message: config.message, default: config.default });
+        try {
+            return await input({ message: config.message, default: config.default });
+        } catch (error) {
+            if ((error as Error)?.name === "ExitPromptError") {
+                this.logger.info("\nCancelled by user.");
+                throw new TaskAbortSignal();
+            }
+            throw error;
+        }
     }
 }
 

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

@@ -1,4 +1,4 @@
-import { CliError} from "@fern-api/task-context";
+import { CliError } from "@fern-api/task-context";
 
 /**
  * Redirects process.stdout to process.stderr.

packages/cli/cli/src/cli-context/upgrade-utils/getFernUpgradeMessage.ts

@@ -1,4 +1,4 @@
-import { CliError} from "@fern-api/task-context";
+import { CliError } from "@fern-api/task-context";
 import { FernRegistryClient } from "@fern-fern/generators-sdk";
 import boxen from "boxen";
 import chalk from "chalk";

packages/cli/cli/src/cli-context/upgrade-utils/getLatestVersionOfCli.ts

@@ -1,3 +1,4 @@
+import { CliError } from "@fern-api/task-context";
 import latestVersion from "latest-version";
 
 import { CliEnvironment } from "../CliEnvironment.js";
@@ -14,7 +15,14 @@ export async function getLatestVersionOfCli({
     if (cliEnvironment.packageName !== "fern-api" || cliEnvironment.packageVersion === "0.0.0") {
         return cliEnvironment.packageVersion;
     }
-    return latestVersion(cliEnvironment.packageName, {
-        version: includePreReleases ? "prerelease" : "latest"
-    });
+    try {
+        return await latestVersion(cliEnvironment.packageName, {
+            version: includePreReleases ? "prerelease" : "latest"
+        });
+    } catch (error) {
+        throw new CliError({
+            message: `Failed to resolve latest CLI version: ${error instanceof Error ? error.message : String(error)}`,
+            code: CliError.Code.NetworkError
+        });
+    }
 }

packages/cli/cli/src/cli.ts

@@ -34,6 +34,7 @@ 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 } from "@fern-api/task-context";
 import getPort from "get-port";
 import { Argv } from "yargs";
 import { hideBin } from "yargs/helpers";
@@ -85,7 +86,6 @@ import { FERN_CWD_ENV_VAR } from "./cwd.js";
 import { rerunFernCliAtVersion } from "./rerunFernCliAtVersion.js";
 import { resolveGroupGithubConfig } from "./resolveGroupGithubConfig.js";
 import { RUNTIME } from "./runtime.js";
-import { CliError } from "@fern-api/task-context";
 
 void runCli();
 
@@ -375,7 +375,9 @@ function addInitCommand(cli: Argv<GlobalCliOptions>, cliContext: CliContext) {
                         const result = await loadOpenAPIFromUrl({ url: argv.openapi, logger: cliContext.logger });
 
                         if (result.status === LoadOpenAPIStatus.Failure) {
-                            cliContext.failAndThrow(result.errorMessage, undefined, { code: CliError.Code.NetworkError });
+                            cliContext.failAndThrow(result.errorMessage, undefined, {
+                                code: CliError.Code.NetworkError
+                            });
                         }
 
                         const tmpFilepath = result.filePath;
@@ -3091,7 +3093,10 @@ function parseOwnerRepo(githubRepo: string): { owner: string; repo: string } {
     const owner = parts[parts.length - 2];
     const repo = parts[parts.length - 1];
     if (owner == null || repo == null) {
-        throw new CliError({ message: `Could not parse owner/repo from: ${githubRepo}`, code: CliError.Code.ParseError });
+        throw new CliError({
+            message: `Could not parse owner/repo from: ${githubRepo}`,
+            code: CliError.Code.ParseError
+        });
     }
     return { owner, repo };
 }

packages/cli/cli/src/cliV2.ts

@@ -3,10 +3,10 @@ import {
     GENERATORS_CONFIGURATION_FILENAME,
     INCORRECT_DOCKER_ORG
 } from "@fern-api/configuration-loader";
+import { CliError } from "@fern-api/task-context";
 import { FernRegistry } from "@fern-fern/generators-sdk";
 import { writeFile } from "fs/promises";
 import { Argv } from "yargs";
-
 import { CliContext } from "./cli-context/CliContext.js";
 import { getGeneratorUpgradeMessage } from "./cli-context/upgrade-utils/getFernUpgradeMessage.js";
 import { getProjectGeneratorUpgrades } from "./cli-context/upgrade-utils/getGeneratorVersions.js";
@@ -15,7 +15,6 @@ import { GenerationModeFilter, getGeneratorList } from "./commands/generator-lis
 import { getGeneratorMetadata } from "./commands/generator-metadata/getGeneratorMetadata.js";
 import { getOrganization } from "./commands/organization/getOrganization.js";
 import { upgradeGenerator } from "./commands/upgrade/upgradeGenerator.js";
-import { CliError } from "@fern-api/task-context";
 
 /**
  * Corrects the incorrect "fern-api/" Docker org prefix to "fernapi/" and logs a warning.

packages/cli/cli/src/commands/diff/diff.ts

@@ -2,7 +2,7 @@ import { diffSemverOrThrow } from "@fern-api/core-utils";
 import { AbsoluteFilePath, cwd, doesPathExist, resolve, streamObjectFromFile } from "@fern-api/fs-utils";
 import { IntermediateRepresentation, serialization } from "@fern-api/ir-sdk";
 import { IntermediateRepresentationChangeDetector } from "@fern-api/ir-utils";
-import { TaskAbortSignal } from "@fern-api/task-context";
+import { CliError, TaskAbortSignal } from "@fern-api/task-context";
 import semver from "semver";
 
 import { CliContext } from "../../cli-context/CliContext.js";
@@ -56,7 +56,9 @@ export async function diff({
 
     const nextVersion = semver.inc(fromVersion, bump);
     if (!nextVersion) {
-        context.failWithoutThrowing(`Invalid current version: ${fromVersion}`, undefined, { code: CliError.Code.VersionError });
+        context.failWithoutThrowing(`Invalid current version: ${fromVersion}`, undefined, {
+            code: CliError.Code.VersionError
+        });
         throw new TaskAbortSignal();
     }
     return { bump, nextVersion, errors };
@@ -73,7 +75,9 @@ async function readIr({
 }): Promise<IntermediateRepresentation> {
     const absoluteFilepath = AbsoluteFilePath.of(resolve(cwd(), filepath));
     if (!(await doesPathExist(absoluteFilepath, "file"))) {
-        context.failWithoutThrowing(`File not found: ${absoluteFilepath}`, undefined, { code: CliError.Code.ConfigError });
+        context.failWithoutThrowing(`File not found: ${absoluteFilepath}`, undefined, {
+            code: CliError.Code.ConfigError
+        });
         throw new TaskAbortSignal();
     }
     let ir: unknown;

packages/cli/cli/src/commands/docs-diff/docsDiff.ts

@@ -2,7 +2,7 @@ import { FernToken } from "@fern-api/auth";
 import { AbsoluteFilePath, cwd, doesPathExist, join, RelativeFilePath } from "@fern-api/fs-utils";
 import { askToLogin } from "@fern-api/login";
 import { Project } from "@fern-api/project-loader";
-import { CliError} from "@fern-api/task-context";
+import { CliError } from "@fern-api/task-context";
 import { mkdir, readFile, writeFile } from "fs/promises";
 import { PNG } from "pngjs";
 import { Browser, launch } from "puppeteer";

packages/cli/cli/src/commands/docs-md-generate/generateLibraryDocs.ts

@@ -419,7 +419,9 @@ async function downloadIr(
     const ir = irWrapper.ir;
 
     if (ir == null) {
-        return context.failAndThrow(`IR is empty for library '${libraryName}'`, undefined, { code: CliError.Code.InternalError });
+        return context.failAndThrow(`IR is empty for library '${libraryName}'`, undefined, {
+            code: CliError.Code.InternalError
+        });
     }
 
     if (language === "CPP") {