Add JSON error responses for --output=json mode#269
Merged
Conversation
Render errors as structured JSON to stdout when --output=json is requested. Uses pre-parse arg scanning to detect JSON mode for errors that occur before Cobra resolves the command (unknown command/flag). Adds stable error codes for scripting consumers.
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
1 participant
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.
Summary
{"ok": false, "error": {"message": "...", "code": "..."}}) to stdout when--output=jsonis requestedoutputJSONRequested) to detect JSON mode for errors that occur before Cobra resolves the command (unknown command/flag)structured_output_unsupported,unsupported_output_format,unknown_command,unknown_flag,path_conflict,invalid_arguments,command_failedSilenceErrors: true+ExecuteC()to route all errors through the new rendererTest plan
go vet ./...cleangolangci-lint run ./...cleango test ./... -count=1)dbxcli missing --output=jsonreturns JSON error withunknown_commandcodedbxcli ls --output=jsonreturns JSON error withstructured_output_unsupportedcodedbxcli ls --output=yamlreturns text error to stderr (invalid format, no JSON)dbxcli lserror still prints text to stderr as before