feat(cli): add structured output formatting (-o json/yaml) - #1925
Draft
dolliecoder wants to merge 1 commit into
Draft
feat(cli): add structured output formatting (-o json/yaml)#1925dolliecoder wants to merge 1 commit into
dolliecoder wants to merge 1 commit into
Conversation
Signed-off-by: dolliecoder <dollychahar27@gmail.com>
Collaborator
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
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.
What type of PR is this?
/kind feature
What this PR does / why we need it:
This PR introduces structured output formatting to
kmeshctl, a highly requested quality-of-life feature for DevOps engineers and CI/CD pipelines.Currently,
kmeshctlcommands output data strictly as plain-text tables or strings, making it difficult to parse programmatically. This PR:--output(or-o) persistent flag to the rootkmeshctlcommand.ctl/utils/printer.goutility to marshal internal Go structs into JSON or YAML seamlessly.authz status,log, andsecret getcommands to natively support structured output via the new printer.When the
-o jsonor-o yamlflag is omitted, the CLI gracefully falls back to the exact same human-readable table/text formats as before, ensuring 100% backward compatibility.Which issue(s) this PR fixes:
Fixes #1924
Special notes for your reviewer:
The
sigs.k8s.io/yamlandencoding/jsonlibraries are leveraged withinprinter.gofor the struct marshaling. We've ensured that internal data structures (likePodStatusin theauthzcommand) have their fields correctly exported and tagged withjson:""decorators so they serialize cleanly.Does this PR introduce a user-facing change?: