stop using System.CommandLine types that aren't public anymore #49181
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
…ption that is being used by many commands, just create a dedicated copy for each of them
…alOption that is being used by many commands, just create a dedicated copy for each of them
…t the description to desired text
77f255f to
0bbd5dc
Compare
adamsitnik
commented
May 28, 2025
src/Cli/dotnet/Commands/Workload/Search/WorkloadSearchVersionsCommandParser.cs
Outdated
Show resolved
Hide resolved
0bbd5dc to
d955427
Compare
3 tasks
adamsitnik
commented
May 29, 2025
| /// </summary> | ||
| internal static class LocalizationResources | ||
| { | ||
| private static Lazy<ResourceManager> _resourceManager = new( |
There was a problem hiding this comment.
This is not something new, rather a re-use of a workaround from the past:
…sion command when asked for parent command
MiYanni
approved these changes
Jun 2, 2025
Comment on lines
+98
to
+106
| public static IEnumerable<Func<HelpContext, bool>> GetLayout() | ||
| { | ||
| yield return SynopsisSection(); | ||
| yield return CommandUsageSection(); | ||
| yield return CommandArgumentsSection(); | ||
| yield return OptionsSection(); | ||
| yield return SubcommandsSection(); | ||
| yield return AdditionalArgumentsSection(); | ||
| } |
There was a problem hiding this comment.
So, this is a bit odd...
A func is a method delegate. Why do you return a method call that creates a delegate? Just return a method itself. Meaning:
Suggested change
| public static IEnumerable<Func<HelpContext, bool>> GetLayout() | |
| { | |
| yield return SynopsisSection(); | |
| yield return CommandUsageSection(); | |
| yield return CommandArgumentsSection(); | |
| yield return OptionsSection(); | |
| yield return SubcommandsSection(); | |
| yield return AdditionalArgumentsSection(); | |
| } | |
| public static IEnumerable<Func<HelpContext, bool>> GetLayout() | |
| { | |
| yield return SynopsisSection; | |
| yield return CommandUsageSection; | |
| yield return CommandArgumentsSection; | |
| yield return OptionsSection; | |
| yield return SubcommandsSection; | |
| yield return AdditionalArgumentsSection; | |
| } |
And change them to be the method signature. For example:
public static Func<HelpContext, bool> SynopsisSection() =>
ctx =>
{
ctx.HelpBuilder.WriteHeading(LocalizationResources.HelpDescriptionTitle(), ctx.Command.Description, ctx.Output);
return true;
};Becomes:
public static bool SynopsisSection(HelpContext context)
{
context.HelpBuilder.WriteHeading(LocalizationResources.HelpDescriptionTitle(), context.Command.Description, ctx.Output);
return true;
};There was a problem hiding this comment.
I agree that it's far from perfect, but it's a copy of System.CommandLine source code and I would prefer to introduce as few changes as possible (in order to make it easier to sync changes if needed in the future)
Comment on lines
196
to
207
| if (symbol is Option or Command) | ||
| { | ||
| return GetOptionOrCommandRow(); | ||
| } | ||
| else if (symbol is Argument argument) | ||
| { | ||
| return GetCommandArgumentRow(argument); | ||
| } | ||
| else | ||
| { | ||
| throw new NotSupportedException($"Symbol type {symbol.GetType()} is not supported."); | ||
| } |
There was a problem hiding this comment.
nit: If-Else is redundant.
Suggested change
| if (symbol is Option or Command) | |
| { | |
| return GetOptionOrCommandRow(); | |
| } | |
| else if (symbol is Argument argument) | |
| { | |
| return GetCommandArgumentRow(argument); | |
| } | |
| else | |
| { | |
| throw new NotSupportedException($"Symbol type {symbol.GetType()} is not supported."); | |
| } | |
| if (symbol is Option or Command) | |
| { | |
| return GetOptionOrCommandRow(); | |
| } | |
| if (symbol is Argument argument) | |
| { | |
| return GetCommandArgumentRow(argument); | |
| } | |
| throw new NotSupportedException($"Symbol type {symbol.GetType()} is not supported."); |
src/Cli/Microsoft.TemplateEngine.Cli/Help/HelpBuilderExtensions.cs
Outdated
Show resolved
Hide resolved
| { | ||
| return ("/", rawAlias.Substring(1)); | ||
| } | ||
| else if (rawAlias[0] == '-') |
src/Cli/Microsoft.TemplateEngine.Cli/Help/LocalizationResources.cs
Outdated
Show resolved
Hide resolved
Comment on lines
40
to
43
| int hashCode = -244751520; | ||
| hashCode = hashCode * -1521134295 + EqualityComparer<string>.Default.GetHashCode(FirstColumnText); | ||
| hashCode = hashCode * -1521134295 + EqualityComparer<string>.Default.GetHashCode(SecondColumnText); | ||
| return hashCode; |
This was referenced Jun 3, 2025
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.
First of all, I've tried to eliminate the need of using the Help APIs that were made internal. For example, for options that were shared between multiple commands, we were using
WithHelpDescriptionto set a custom description. The fix was to simply have a dedicated copy of given option for every command, with a unique description. This had a side effect of generating completions with descriptions that are more accurate (hence the test file update).When I got to the point where it was not worth the effort, I've followed the plan we have established offline: just copy pasting the internal types here. I've added them to the
Microsoft.TemplateEngine.Cli, as it defines an interface that is usingHelpContextand is being used by the other projects that customize help. That was quite straightforward, all I needed was to update the license header, namespaces and fix some code analysis issues like leading whitespace etc.Context: dotnet/command-line-api#2563