Repository navigation
feat(cli): --json output and one exit-code table - #107
Merged
Merged
Conversation
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.
Adds a global
--jsonflag so agents and scripts can driveapicwithout scraping text, and gives every command one exit-code table in both modes.With
--json, every command prints exactly one JSON document on stdout: its result, or{"error": {"kind", "message"}}. Warnings stay as text on stderr.sendgetting any HTTP statususage,not_initialized,errorremove --jsonwithout--yesnot_found,ambiguousinvalidvalidatefound failuresnetworksrc/output.rsholds the switch,CliError { kind, message }and the table. Handlers returnResult<(), CliError>, andrun()is the only place that prints an error and exits.read --jsonprints the stored contract (filtered by--status).send --jsonembeds a JSON body as a value, keeps text as a string and base64-encodes binary.remove --jsondeletes only with--yes.Behavior that changes in text mode too:
readwith no match exits 2 (it printed "No contract found" and exited 0),validatefailures exit 3,sendnetwork errors exit 4, clap parse errors exit 1 (clap's default was 2), andconfigoutside a project now fails.Checked locally on Rust 1.99:
cargo test --workspace,cargo clippy --workspace --all-targets -- -D warnings,cargo fmt --checkandcargo build --workspaceall pass. CI's MSRV job is the first check on Rust 1.92.The apic-web docs follow in a separate PR.