dotnet CLI: Add --cli-schema option for CLI structure JSON #49118
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
…utput the structure of that command in JSON. This still has work to be done to refine the output.
MiYanni
commented
May 22, 2025
src/Cli/dotnet/CommandLineInfo.cs
Outdated
Comment on lines
92
to
112
| writer.WriteStartObject(nameof(command.Arguments).ToCamelCase()); | ||
| foreach (var argument in command.Arguments.OrderBy(a => a.Name)) | ||
| { | ||
| // TODO: Check these | ||
| writer.WriteStartObject(argument.Name); | ||
|
|
||
| writer.WriteString(nameof(argument.Description).ToCamelCase(), argument.Description); | ||
| writer.WriteBoolean(nameof(argument.Hidden).ToCamelCase(), argument.Hidden); | ||
| writer.WriteBoolean("hasValidators", argument.GetHasValidators() ?? false); | ||
| writer.WriteString(nameof(argument.HelpName).ToCamelCase(), argument.HelpName); | ||
| writer.WriteString(nameof(argument.ValueType).ToCamelCase(), argument.ValueType.FullName); | ||
| writer.WriteBoolean(nameof(argument.HasDefaultValue).ToCamelCase(), argument.HasDefaultValue); | ||
|
|
||
| writer.WriteStartObject(nameof(argument.Arity).ToCamelCase()); | ||
| writer.WriteNumber(nameof(argument.Arity.MinimumNumberOfValues).ToCamelCase(), argument.Arity.MinimumNumberOfValues); | ||
| writer.WriteNumber(nameof(argument.Arity.MaximumNumberOfValues).ToCamelCase(), argument.Arity.MaximumNumberOfValues); | ||
| writer.WriteEndObject(); | ||
|
|
||
| writer.WriteEndObject(); | ||
| } | ||
| writer.WriteEndObject(); |
There was a problem hiding this comment.
TODO: Local functions might make sense for each of these sub-sections.
MiYanni
commented
May 22, 2025
Comment on lines
+8
to
+10
| #pragma warning disable IDE0065 // Misplaced using directive | ||
| using Command = System.CommandLine.Command; | ||
| #pragma warning restore IDE0065 // Misplaced using directive |
There was a problem hiding this comment.
This is bizarre but necessary since declaring the using above the namespace means that anything in the namespace scope will override it. Meaning, System.DotNet.Cli.Utils.Command will be used even if an alias is declared. So, you put the alias inside the namespace to have it be used properly.
There was a problem hiding this comment.
TODO: We should just change that Command class to not be called Command since CliCommand from S.CL was changed back to Command, which causes situations like this to happen.
MiYanni
commented
May 22, 2025
src/Cli/dotnet/Program.cs
Outdated
Comment on lines
143
to
147
| if (parseResult.GetValue(Parser.CliSchemaOption)) | ||
| { | ||
| CommandLineInfo.PrintCliSchema(parseResult.CommandResult.Command); | ||
| return 0; | ||
| } |
There was a problem hiding this comment.
This is now the highest priority option since every other option is irrelevant if this one is present.
…ded name for root command. Cleaned up type output. Added default value output. Removed ordering for arguments. Added relaxed JSON encoding.
… in-person discussion. Added version to the root. Shared json serialization options. Created strings for the --cli-schema description.
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.
Resolves: #46345
Summary
TODO