astral-sh/uv

Add support for a JSON output format for machine readable output throughout uv

Open

#411 opened on Nov 13, 2023

View on GitHub
 (9 comments) (40 reactions) (0 assignees)Rust (84,934 stars) (3,111 forks)batch import
clienhancementhelp wantedtracking

Description

Our main commands should have a json output format that can be in downstream applications such as auditing, dependabot-like application and our own testing.

See the linked issues for support in a specific command.

Contributor guide

Tech stack
rust
Domain
clideveloper experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Rust knowledgeUnderstanding of uv's CLI structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate existing output formats in uv by examining the command implementations in relevant source files. Look at linked issues (e.g., #412, #413) for specific JSON output requirements for each command. Implement a json flag that uses serde to serialize the command's output, ensuring it includes all necessary fields. Test with several commands and update documentation.
Add support for a JSON output format for machine readable output throughout uv · astral-sh/uv#411 | Good First Issue