Add option for specifying the version of machine-readable output of dotnet list package command #29367
Conversation
This file contains 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
erdembayar
commented
Dec 2, 2022
| @@ -63,6 +63,9 @@ internal static class ListPackageReferencesCommandParser | |||
| public static readonly Option FormatOption = new ForwardedOption<ReportOutputFormat>("--format", LocalizableStrings.CmdFormatDescription) | |||
| { }.ForwardAsSingle(o => $"--format:{o}"); | |||
|
|
|||
| public static readonly Option OutputVersiontOption = new ForwardedOption<int>("--output-version", LocalizableStrings.CmdOutputVersionDescription) | |||
There was a problem hiding this comment.
@baronfel
It's currently just 1 or nothing option. I found it's bit challenging to add 1 as enum without changing other codes on how enum is parsed. So, I'm just using int here.
| @@ -171,4 +171,7 @@ | |||
| <data name="CmdFormatDescription" xml:space="preserve"> | |||
| <value>Specifies the output format type for the list packages command.</value> | |||
| </data> | |||
| <data name="CmdOutputVersionDescription" xml:space="preserve"> | |||
| <value>Specifies the output version for the machine readable list packages command output.</value> | |||
There was a problem hiding this comment.
- From the title of the PR, I initially thought this option makes the output include the versions of the referenced packages, and wondered why they wouldn't be included by default.
- Is it necessary to mention "list packages command" in the option descriptions? I'd expect these descriptions to be displayed only when the user already specified that command.
I'd prefer something like "Specifies the version of machine-readable output", to make it clear that this doesn't refer to versions of packages. Perhaps also mention that this is for --format=json.
There was a problem hiding this comment.
I addressed your concerns, please check.
erdembayar
changed the title
erdembayar
changed the title
erdembayar
changed the title
erdembayar
changed the title
dsplaisted
approved these changes
Dec 6, 2022
src/Cli/dotnet/commands/dotnet-list/dotnet-list-package/ListPackageReferencesCommandParser.cs
Outdated
Show resolved
Hide resolved
…ckageReferencesCommandParser.cs Co-authored-by: Daniel Plaisted <daplaist@microsoft.com>
erdembayar
commented
Dec 6, 2022
| @@ -171,4 +171,7 @@ | |||
| <data name="CmdFormatDescription" xml:space="preserve"> | |||
| <value>Specifies the output format type for the list packages command.</value> | |||
| </data> | |||
| <data name="CmdOutputVersionDescription" xml:space="preserve"> | |||
There was a problem hiding this comment.
@dominoFire @nkolev92 @JonDouglas
Does wording look ok for you?
dominoFire
reviewed
Dec 7, 2022
src/Cli/dotnet/commands/dotnet-list/dotnet-list-package/LocalizableStrings.resx
Outdated
Show resolved
Hide resolved
erdembayar
deleted the
dev-eryondon-dotnetlistpackage-outputversion-option
branch
|
@dsplaisted |
It will flow to main eventually. Once this PR is merged then there should be another one generated which will include these changes. |
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.
Related to: NuGet/NuGet.Client#4855
Add new
--output-versionoption for machine readable output ofdotnet list packagecommand. I forgot to include in #29017It would be used like below:
dotnet list package --format json --output-version 1