sln-list: Add format options #47618
Open
sln-list: Add format options #47618
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
ghost
added
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces a new output format option for the "dotnet sln list" command to improve parseability for tools. Key changes include:
- Adding the SlnListOutputFormat enum with Text, Raw, and Json options.
- Updating the command parser and help text to incorporate the new --format option.
- Modifying the list project execution to output data in the selected format.
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Cli/dotnet/commands/dotnet-sln/list/SlnListOutputFormat.cs | Adds a new enum for output formats. |
| src/Cli/dotnet/commands/dotnet-sln/list/SlnListParser.cs | Introduces and adds the new --format CLI option. |
| test/dotnet-sln.Tests/GivenDotnetSlnList.cs | Updates help text to include the --format option details. |
| src/Cli/dotnet/commands/dotnet-sln/list/Program.cs | Implements format-specific output behavior and adjusts project file retrieval. |
Comments suppressed due to low confidence (2)
src/Cli/dotnet/commands/dotnet-sln/list/Program.cs:30
- The removal of the 'includeSolutionFilterFiles: true' parameter may alter solution file detection behavior. Please verify that this change is intentional and update unit tests if needed.
string solutionFileFullPath = SlnFileFactory.GetSolutionFileFullPath(_fileOrDirectory);
src/Cli/dotnet/commands/dotnet-sln/list/Program.cs:52
- When no projects are found, outputting a plain text message may be inconsistent with the JSON output format. Consider outputting an empty JSON array ("[]") when the --format option is set to Json.
return;
edvilme
commented
Mar 14, 2025
| using Microsoft.DotNet.Cli; | ||
| using Microsoft.DotNet.Cli.Utils; | ||
|
|
||
| namespace Microsoft.DotNet.Cli; |
There was a problem hiding this comment.
Hopefully this avoids conflicts with the current namespaces efforts ;)
edvilme
commented
Mar 14, 2025
|
|
||
| public enum SlnListOutputFormat | ||
| { | ||
| Text, |
There was a problem hiding this comment.
Can be renamed Table?
Forgind
reviewed
Mar 27, 2025
| @@ -19,8 +19,9 @@ dotnet solution <SLN_FILE> list [options] | |||
| <SLN_FILE> The solution file to operate on. If not specified, the command will search the current directory for one. [default: {PathUtility.EnsureTrailingSlash(defaultVal)}] | |||
|
|
|||
| Options: | |||
| --solution-folders Display solution folder paths. | |||
| -?, -h, --help Show command line help."; | |||
| --solution-folders Display solution folder paths. | |||
|
|
||
| public enum SlnListOutputFormat | ||
| { | ||
| Text, |
| @@ -27,6 +32,7 @@ private static CliCommand ConstructCommand() | |||
| CliCommand command = new("list", LocalizableStrings.ListAppFullName); | |||
|
|
|||
| command.Options.Add(SolutionFolderOption); | |||
| command.Options.Add(OutputFormatOption); | |||
There was a problem hiding this comment.
What happens if the user passes in something invalid? And is this case-sensitive or insensitive?
| } | ||
|
|
||
| public override int Execute() | ||
| { | ||
| string solutionFileFullPath = SlnFileFactory.GetSolutionFileFullPath(_fileOrDirectory, includeSolutionFilterFiles: true); | ||
| string solutionFileFullPath = SlnFileFactory.GetSolutionFileFullPath(_fileOrDirectory); |
| .ToArray(); | ||
| } | ||
| string[] paths = _displaySolutionFolders | ||
| ? solution.SolutionFolders.Select(folder => Path.GetDirectoryName(folder.Path.TrimStart('/'))).ToArray() // VS-SolutionPersistence does not return a path object, so there might be issues with forward/backward slashes on different platforms |
There was a problem hiding this comment.
Suggested change
| ? solution.SolutionFolders.Select(folder => Path.GetDirectoryName(folder.Path.TrimStart('/'))).ToArray() // VS-SolutionPersistence does not return a path object, so there might be issues with forward/backward slashes on different platforms | |
| // VS-SolutionPersistence does not return a path object, so there might be issues with forward/backward slashes on different platforms | |
| ? solution.SolutionFolders.Select(folder => Path.GetDirectoryName(folder.Path.TrimStart('/'))).ToArray() |
| case SlnListOutputFormat.Json: | ||
| Reporter.Output.WriteLine(JsonSerializer.Serialize(paths)); | ||
| break; | ||
| } |
There was a problem hiding this comment.
default? Same as Text, right?
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.
The current output for
dotnet sln listmight not be easily parseable by other programs.This adds the
--formatoption (following other commands on the cli) with values:text(Default): Displays a header and a list of projects/folders.raw: Displays no header and a list of projects/folders. This can be useful for piping to other commands.json: Displays a json array with the projects/folders.