Machine readable output for dotnet list package #7752
Description
Details about Problem
It is difficult to parse the output of dotnet list package. We have requirements in our organization to audit packages that we are using in our projects. Without having a good way to parse the output of this command, it makes it difficult to structure the list of packages in a way that can be fed into another auditing system.
Running the following command produces the following output:
dotnet list package --include-transitive
Project 'UniversalDashboard' has the following package references
[net472]:
Top-level Package Requested Resolved
> Microsoft.AspNetCore 2.1.3 2.1.3
> Microsoft.AspNetCore.Authentication.Cookies 2.1.2 2.1.2
> Microsoft.AspNetCore.Authentication.Facebook 2.1.2 2.1.2
> Microsoft.AspNetCore.Authentication.Google 2.1.2 2.1.2
> Microsoft.AspNetCore.Authentication.JwtBearer 2.1.2 2.1.2
> Microsoft.AspNetCore.Authentication.MicrosoftAccount 2.1.2 2.1.2
> Microsoft.AspNetCore.Authentication.Twitter 2.1.2 2.1.2
> Microsoft.AspNetCore.Mvc 2.1.2 2.1.2
> Microsoft.AspNetCore.ResponseCompression 2.1.1 2.1.1
> Microsoft.AspNetCore.Routing 2.1.1 2.1.1
> Microsoft.AspNetCore.Server.Kestrel.Https 2.1.3 2.1.3
> Microsoft.AspNetCore.Server.Kestrel.Transport.Libuv 2.1.3 2.1.3
> Microsoft.AspNetCore.Session 2.1.1 2.1.1
> Microsoft.AspNetCore.SignalR 1.0.3 1.0.3
> Microsoft.AspNetCore.StaticFiles 2.1.1 2.1.1
> Microsoft.AspNetCore.WebSockets 2.1.1 2.1.1
> Microsoft.DotNet.PlatformAbstractions 2.1.0 2.1.0
> Microsoft.Extensions.Caching.Memory 2.1.2 2.1.2
> Microsoft.Extensions.Logging.Debug 2.1.1 2.1.1
> Microsoft.Extensions.Logging.Filter 1.1.2 1.1.2
> Newtonsoft.Json 11.0.2 11.0.2
> NLog 4.5.8 4.5.8
> NLog.Web.AspNetCore 4.6.0 4.6.0
> PowerShellStandard.Library 5.1.0-preview-06 5.1.0-preview-06
> Quartz 3.0.6 3.0.6
> System.Net.NameResolution 4.3.0 4.3.0
> System.Reflection.Emit 4.3.0 4.3.0
> System.Runtime.Loader 4.3.0 4.3.0
> System.Security.Principal 4.3.0 4.3.0
Transitive Package Resolved
> Libuv 1.10.0
> Microsoft.AspNetCore.Antiforgery 2.1.1
> Microsoft.AspNetCore.Authentication 2.1.2
> Microsoft.AspNetCore.Authentication.Abstractions 2.1.1
> Microsoft.AspNetCore.Authentication.Core 2.1.1
> Microsoft.AspNetCore.Authentication.OAuth 2.1.2
> Microsoft.AspNetCore.Authorization 2.1.1
> Microsoft.AspNetCore.Authorization.Policy 2.1.1
> Microsoft.AspNetCore.Connections.Abstractions 2.1.3
> Microsoft.AspNetCore.Cors 2.1.1
> Microsoft.AspNetCore.Cryptography.Internal 2.1.1
> Microsoft.AspNetCore.DataProtection 2.1.1
> Microsoft.AspNetCore.DataProtection.Abstractions 2.1.1
> Microsoft.AspNetCore.Diagnostics 2.1.1
> Microsoft.AspNetCore.Diagnostics.Abstractions 2.1.1
> Microsoft.AspNetCore.HostFiltering 2.1.1
> Microsoft.AspNetCore.Hosting 2.1.1
> Microsoft.AspNetCore.Hosting.Abstractions 2.1.1
> Microsoft.AspNetCore.Hosting.Server.Abstractions 2.1.1
> Microsoft.AspNetCore.Html.Abstractions 2.1.1
> Microsoft.AspNetCore.Http 2.1.1
> Microsoft.AspNetCore.Http.Abstractions 2.1.1
> Microsoft.AspNetCore.Http.Connections 1.0.3
> Microsoft.AspNetCore.Http.Connections.Common 1.0.3
> Microsoft.AspNetCore.Http.Extensions 2.1.1
> Microsoft.AspNetCore.Http.Features 2.1.1
> Microsoft.AspNetCore.HttpOverrides 2.1.1
> Microsoft.AspNetCore.JsonPatch 2.1.1
> Microsoft.AspNetCore.Localization 2.1.1
> Microsoft.AspNetCore.Mvc.Abstractions 2.1.2
> Microsoft.AspNetCore.Mvc.ApiExplorer 2.1.2
> Microsoft.AspNetCore.Mvc.Core 2.1.2
> Microsoft.AspNetCore.Mvc.Cors 2.1.2
> Microsoft.AspNetCore.Mvc.DataAnnotations 2.1.2
> Microsoft.AspNetCore.Mvc.Formatters.Json 2.1.2
> Microsoft.AspNetCore.Mvc.Localization 2.1.2
> Microsoft.AspNetCore.Mvc.Razor 2.1.2
> Microsoft.AspNetCore.Mvc.Razor.Extensions 2.1.1
> Microsoft.AspNetCore.Mvc.RazorPages 2.1.2
> Microsoft.AspNetCore.Mvc.TagHelpers 2.1.2
> Microsoft.AspNetCore.Mvc.ViewFeatures 2.1.2
> Microsoft.AspNetCore.Razor 2.1.1
> Microsoft.AspNetCore.Razor.Design 2.1.1
> Microsoft.AspNetCore.Razor.Language 2.1.1
> Microsoft.AspNetCore.Razor.Runtime 2.1.1
> Microsoft.AspNetCore.ResponseCaching.Abstractions 2.1.1
> Microsoft.AspNetCore.Routing.Abstractions 2.1.1
> Microsoft.AspNetCore.Server.IISIntegration 2.1.1
> Microsoft.AspNetCore.Server.Kestrel 2.1.3
> Microsoft.AspNetCore.Server.Kestrel.Core 2.1.3
> Microsoft.AspNetCore.Server.Kestrel.Transport.Abstractions 2.1.3
> Microsoft.AspNetCore.Server.Kestrel.Transport.Sockets 2.1.3
> Microsoft.AspNetCore.SignalR.Common 1.0.3
> Microsoft.AspNetCore.SignalR.Core 1.0.3
> Microsoft.AspNetCore.SignalR.Protocols.Json 1.0.3
> Microsoft.AspNetCore.WebUtilities 2.1.1
> Microsoft.CodeAnalysis.Analyzers 1.1.0
> Microsoft.CodeAnalysis.Common 2.8.0
> Microsoft.CodeAnalysis.CSharp 2.8.0
> Microsoft.CodeAnalysis.Razor 2.1.1
> Microsoft.CSharp 4.5.0
> Microsoft.DiaSymReader.Native 1.7.0
The problem with this type of output is that it is difficult to parse. npm provides two options that make this easier when listing packages. They include both a -parsable and a -json parameter. I think dotnet list package should provide something similar.
I think that dotnet list package should do something similar.
F:\universal-dashboard\src\UniversalDashboard>dotnet --version
2.2.102
I'm happy to work on a PR for this. I've found the responsible code and could implement a "parse-friendly" version but wanted feedback from the community\team before doing anything.
Update 12/10/2021:
After diving into this issue, it's quite large issue, it looks none of dotnet command implemented it, this is 1st time. Let's divide and conquer this issue, here're sub issues:
- Machine readable json output for dotnet list package: Create spec for machine readable json output for "dotnet list package" #11449
Spec proposal PR: Spec for machine readable json output for dotnet list package #11446