fix(cli): keep help and schema examples consistent#71
Draft
jo-hnny wants to merge 1 commit into
Draft
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.
Summary
Exampleblocks back into command examples and use them to populateCommandSchema.Examples.helpcommand when building the schema catalog.Related to #46.
Root cause
Command examples could come from generated descriptors, handwritten Cobra commands,
Longhelp text, or the default example fallback. Text help used the final Cobra command tree, while the schema catalog only copied examples from selected descriptor metadata. As a result, examples visible in help were missing from machine-readable schema output.External impact
--help,agr help, and text-modeagr schemaoutput are unchanged.agr schema ... -o jsonand--help -o jsonnow expose existing help examples for 37 additional commands.Examplesfield inagr.v1; it does not introduce a new schema field. Consumers using exact JSON snapshots will observe the additional values.Benefits
Validation
go test ./... -count=1go run ./cmd/internal/cobragen checkgit diff --checkExamplesvalues differ in JSON schema/help output.