Add JSON format for list outputs#6346
Open
PrzemyslawKlys wants to merge 9 commits into
Open
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.
📖 Description
Adds
--format jsonsupport for package listing output.This enables machine-readable output for:
winget list --format jsonwinget upgrade --format jsonwhen used in list-only modeThe default table output is unchanged.
The JSON output includes installed package fields that match the existing list and upgrade table data, including package name, id, installed version, available version, and source. It also keeps JSON parseable for empty results and common error paths such as source-open failures, WinGet policy blocks, and generic execution failures.
winget upgrade --format jsonis intentionally limited to non-mutating upgrade listing. Commands such aswinget upgrade --all --format jsonare rejected so package installation progress is not mixed with structured output.🔗 References
Related to #1753.
🔍 Validation
Added focused test coverage for:
--format json --help--detailswith JSON list outputRan the focused
AppInstallerCLITestsscenarios for the JSON list and upgrade flows locally.✅ Checklist
📋 Issue Type
Microsoft Reviewers: Open in CodeFlow