NuGet/Home

JSON output for dotnet nuget why command

Open

#13,927 opened on Nov 14, 2024

View on GitHub
 (0 comments) (2 reactions) (0 assignees)HTML (1,459 stars) (292 forks)batch import
Priority:3Type:Featurehelp wanted

Description

NuGet Product(s) Involved

NuGet.exe

The Elevator Pitch

The output of dotnet nuget why command is incredibly useful for problems like component governance. Right now, it only supports printing output to the terminal. It would very useful to have a mode that supports putting the output to a JSON file, and, if possible, having a set of public classes that we can deserialize that output to.

Additional Context and Details

As my team works on problems like Component Governance, being able to analyze how transitive packages are introduced (as well as how those dependencies shake out between projects) is a key part of the puzzle and I think the output of this command can help a ton.

Contributor guide

Tech stack
csharp
Domain
cli
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-3 hours
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.
clear
Prerequisites
Basic knowledge of .NETFamiliarity with NuGet CLI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Investigate the existing implementation of the 'dotnet nuget why' command in the NuGet client repository. Look at how output formatting is currently handled and identify where a JSON output mode can be added. Provide a design for serializing the output to JSON using System.Text.Json or Newtonsoft.Json.