chore(cli): migrate @fern-api/cli-v2 to use CliError#14992
Open
chore(cli): migrate @fern-api/cli-v2 to use CliError#14992
Conversation
351512a to
caecd6f
Compare
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.
Tip: disable this comment in your organization's Code Review settings.
caecd6f to
0043b24
Compare
Comment on lines
+29
to
+34
| throw new CliError({ | ||
| message: | ||
| `Could not determine API type for "${reference}". ` + | ||
| `File must contain a top-level "openapi" or "asyncapi" key.`, | ||
| code: CliError.Code.InternalError | ||
| }); |
Contributor
There was a problem hiding this comment.
Error code should be ParseError or ConfigError, not InternalError. This error occurs when a user provides an invalid API spec file without the required top-level keys. Using InternalError suggests a bug in the CLI rather than a user configuration issue.
throw new CliError({
message:
`Could not determine API type for "${reference}". ` +
`File must contain a top-level "openapi" or "asyncapi" key.`,
code: CliError.Code.ParseError
});
Suggested change
| throw new CliError({ | |
| message: | |
| `Could not determine API type for "${reference}". ` + | |
| `File must contain a top-level "openapi" or "asyncapi" key.`, | |
| code: CliError.Code.InternalError | |
| }); | |
| throw new CliError({ | |
| message: | |
| `Could not determine API type for "${reference}". ` + | |
| `File must contain a top-level "openapi" or "asyncapi" key.`, | |
| code: CliError.Code.ParseError | |
| }); | |
Spotted by Graphite
Is this helpful? React 👍 or 👎 to let us know.
628d1ba to
397ce0b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Description
Migrates
@fern-api/cli-v2(the next-generation CLI package) to use explicitCliErrorerror codes on everyfailAndThrow/failWithoutThrowingcall site.This is one of the package migration PRs that follow the error classification system introduced in #14749.
Changes Made
Assigned typed error codes across 48+ call sites in
packages/cli/cli-v2/src/, covering every command handler and shared utility. Also fixed test files to match the asynccreateTestContextsignature and theTaskAbortSignalthrow type for validation errors.Error codes used
CONFIG_ERRORAUTH_ERRORNETWORK_ERRORVALIDATION_ERRORPARSE_ERRORVERSION_ERRORENVIRONMENT_ERRORINTERNAL_ERRORFiles touched (grouped by area)
api/check/,api/compile/,api/merge/,api/split/,api/utils/loadSpec.tsauth/login/,auth/logout/,auth/switch/,auth/token/,auth/whoami/docs/check/,docs/dev/,docs/preview/,docs/preview/delete/,docs/publish/sdk/add/,sdk/check/,sdk/generate/,sdk/preview/,sdk/update/check/,config/migrate/,init/,org/create/,org/list/Context.ts,withContext.ts,TaskContextAdapter.ts,FernYmlEditor.ts,DocsChecker.tsTelemetryClient.ts,LifecycleEvent.tserrors/CliError.ts(replaced by shared@fern-api/task-contextCliError), updatedValidationError.ts,SourcedValidationError.ts,KeyringUnavailableError.tsGeneratorPipeline.test.ts,compile.test.ts,TelemetryClient.test.ts, and all test context utilitiesTesting