remove WithHelpDescription and the reason why it existed

dotnet · adamsitnik · Jun 3, 2025 · May 28, 2025 · May 28, 2025 · May 28, 2025
commit d95f6172165db36ba2343a7af9bce872d871ae48
diff --git a/src/Cli/dotnet/Commands/Tool/Common/ToolAppliedOption.cs b/src/Cli/dotnet/Commands/Tool/Common/ToolAppliedOption.cs
@@ -13,16 +13,20 @@ internal class ToolAppliedOption
 {
     private const string GlobalOptionName = "--global";
     private const string GlobalOptionAlias = "-g";
+    private const string LocalOptionName = "--local";
+    private const string ToolPathName = "--tool-path";
+    private const string ToolManifestName = "--tool-manifest";
 
     public static Option<bool> GlobalOption(string description) => new(GlobalOptionName, GlobalOptionAlias)
     {
         Arity = ArgumentArity.Zero,
         Description = description
     };
 
-    public static Option<bool> LocalOption = new("--local")
+    public static Option<bool> LocalOption(string description) => new(LocalOptionName)
     {
-        Arity = ArgumentArity.Zero
+        Arity = ArgumentArity.Zero,
+        Description = description,
     };
 
     public static Option<bool> UpdateAllOption = new("--all")
@@ -35,15 +39,17 @@ public static readonly Option<string> VersionOption
         = ToolInstallCommandParser.VersionOption
           ?? new("--version"); // Workaround for Mono runtime (https://github.com/dotnet/sdk/issues/41672)
 
-    public static Option<string> ToolPathOption = new("--tool-path")
+    public static Option<string> ToolPathOption(string description) => new(ToolPathName)
     {
-        HelpName = CliCommandStrings.ToolInstallToolPathOptionName
+        HelpName = CliCommandStrings.ToolInstallToolPathOptionName,
+        Description = description,
     };
 
-    public static Option<string> ToolManifestOption = new("--tool-manifest")
+    public static Option<string> ToolManifestOption(string description) => new(ToolManifestName)
     {
         HelpName = CliCommandStrings.ToolInstallManifestPathOptionName,
-        Arity = ArgumentArity.ZeroOrOne
+        Arity = ArgumentArity.ZeroOrOne,
+        Description = description,
     };
 
     internal static void EnsureNoConflictGlobalLocalToolPathOption(
@@ -56,14 +62,14 @@ internal static void EnsureNoConflictGlobalLocalToolPathOption(
             options.Add(GlobalOptionName);
         }
 
-        if (parseResult.GetResult(LocalOption) is not null)
+        if (parseResult.RootCommandResult.GetResult(LocalOptionName) is not null)
         {
-            options.Add(LocalOption.Name);
+            options.Add(LocalOptionName);
         }
 
-        if (!string.IsNullOrWhiteSpace(parseResult.GetValue(ToolPathOption)))
+        if (!string.IsNullOrWhiteSpace(parseResult.GetValue<string>(ToolPathName)))
         {
-            options.Add(ToolPathOption.Name);
+            options.Add(ToolPathName);
         }
 
         if (options.Count > 1)
@@ -102,7 +108,7 @@ internal static void EnsureNoConflictUpdateAllVersionOption(
     internal static void EnsureToolManifestAndOnlyLocalFlagCombination(ParseResult parseResult)
     {
         if (GlobalOrToolPath(parseResult) &&
-            !string.IsNullOrWhiteSpace(parseResult.GetValue(ToolManifestOption)))
+            !string.IsNullOrWhiteSpace(parseResult.GetValue<string>(ToolManifestName)))
         {
             throw new GracefulException(
                 string.Format(
@@ -113,7 +119,7 @@ internal static void EnsureToolManifestAndOnlyLocalFlagCombination(ParseResult p
     private static bool GlobalOrToolPath(ParseResult parseResult)
     {
         return GlobalOptionWasProvided(parseResult) ||
-               !string.IsNullOrWhiteSpace(parseResult.GetValue(ToolPathOption));
+               !string.IsNullOrWhiteSpace(parseResult.GetValue<string>(ToolPathName));
     }
 
     private static bool GlobalOptionWasProvided(ParseResult parseResult)

diff --git a/src/Cli/dotnet/Commands/Tool/Install/ToolInstallCommand.cs b/src/Cli/dotnet/Commands/Tool/Install/ToolInstallCommand.cs
@@ -17,7 +17,7 @@ internal class ToolInstallCommand(
     private readonly ToolInstallLocalCommand _toolInstallLocalCommand = toolInstallLocalCommand;
     private readonly ToolInstallGlobalOrToolPathCommand _toolInstallGlobalOrToolPathCommand = toolInstallGlobalOrToolPathCommand;
     private readonly bool _global = parseResult.GetValue(ToolInstallCommandParser.GlobalOption);
-    private readonly string _toolPath = parseResult.GetValue(ToolAppliedOption.ToolPathOption);
+    private readonly string _toolPath = parseResult.GetValue(ToolInstallCommandParser.ToolPathOption);
     private readonly string _framework = parseResult.GetValue(ToolInstallCommandParser.FrameworkOption);
 
 

diff --git a/src/Cli/dotnet/Commands/Tool/Install/ToolInstallCommandParser.cs b/src/Cli/dotnet/Commands/Tool/Install/ToolInstallCommandParser.cs
@@ -74,11 +74,11 @@ internal static class ToolInstallCommandParser
 
     public static readonly Option<bool> GlobalOption = ToolAppliedOption.GlobalOption(CliCommandStrings.ToolInstallGlobalOptionDescription);
 
-    public static readonly Option<bool> LocalOption = ToolAppliedOption.LocalOption;
+    public static readonly Option<bool> LocalOption = ToolAppliedOption.LocalOption(CliCommandStrings.ToolInstallLocalOptionDescription);
 
-    public static readonly Option<string> ToolPath
ED48
Option = ToolAppliedOption.ToolPathOption;
+    public static readonly Option<string> ToolPathOption = ToolAppliedOption.ToolPathOption(CliCommandStrings.ToolInstallToolPathOptionDescription);
 
-    public static readonly Option<string> ToolManifestOption = ToolAppliedOption.ToolManifestOption;
+    public static readonly Option<string> ToolManifestOption = ToolAppliedOption.ToolManifestOption(CliCommandStrings.ToolInstallManifestPathOptionDescription);
 
     private static readonly Command Command = ConstructCommand();
 
@@ -107,11 +107,11 @@ private static Command ConstructCommand()
     public static Command AddCommandOptions(Command command)
     {
         command.Options.Add(GlobalOption);
-        command.Options.Add(LocalOption.WithHelpDescription(command, CliCommandStrings.ToolInstallLocalOptionDescription));
-        command.Options.Add(ToolPathOption.WithHelpDescription(command, CliCommandStrings.ToolInstallToolPathOptionDescription));
+        command.Options.Add(LocalOption);
+        command.Options.Add(ToolPathOption);
         command.Options.Add(VersionOption);
         command.Options.Add(ConfigOption);
-        command.Options.Add(ToolManifestOption.WithHelpDescription(command, CliCommandStrings.ToolInstallManifestPathOptionDescription));
+        command.Options.Add(ToolManifestOption);
         command.Options.Add(AddSourceOption);
         command.Options.Add(SourceOption);
         command.Options.Add(FrameworkOption);

diff --git a/src/Cli/dotnet/Commands/Tool/Install/ToolInstallGlobalOrToolPathCommand.cs b/src/Cli/dotnet/Commands/Tool/Install/ToolInstallGlobalOrToolPathCommand.cs
@@ -80,7 +80,7 @@ public ToolInstallGlobalOrToolPathCommand(
         _addSource = parseResult.GetValue(ToolInstallCommandParser.AddSourceOption);
         _global = parseResult.GetValue(ToolInstallCommandParser.GlobalOption);
         _verbosity = GetValueOrDefault(ToolInstallCommandParser.VerbosityOption, VerbosityOptions.minimal, parseResult);
-        _toolPath = parseResult.GetValue(ToolAppliedOption.ToolPathOption);
+        _toolPath = parseResult.GetValue(ToolInstallCommandParser.ToolPathOption);
         _architectureOption = parseResult.GetValue(ToolInstallCommandParser.ArchitectureOption);
 
         _forwardRestoreArguments = parseResult.OptionValuesToBeForwarded(ToolInstallCommandParser.GetCommand());

diff --git a/src/Cli/dotnet/Commands/Tool/Install/ToolInstallLocalCommand.cs b/src/Cli/dotnet/Commands/Tool/Install/ToolInstallLocalCommand.cs
@@ -48,7 +48,7 @@ public ToolInstallLocalCommand(
         _updateAll = parseResult.GetValue(ToolUpdateCommandParser.UpdateAllOption);
         var packageIdArgument = parseResult.GetValue(ToolInstallCommandParser.PackageIdentityArgument)?.Id;
         _packageId = packageId ?? (packageIdArgument is not null ? new PackageId(packageIdArgument) : null);
-        _explicitManifestFile = parseResult.GetValue(ToolAppliedOption.ToolManifestOption);
+        _explicitManifestFile = parseResult.GetValue(ToolInstallCommandParser.ToolManifestOption);
 
         _createManifestIfNeeded = parseResult.GetValue(ToolInstallCommandParser.CreateManifestIfNeededOption);
 

diff --git a/src/Cli/dotnet/Commands/Tool/List/ToolListCommandParser.cs b/src/Cli/dotnet/Commands/Tool/List/ToolListCommandParser.cs
@@ -20,14 +20,15 @@ internal static class ToolListCommandParser
 
     public static readonly Option<bool> GlobalOption = ToolAppliedOption.GlobalOption(CliCommandStrings.ToolListGlobalOptionDescription);
 
-    public static readonly Option<bool> LocalOption = ToolAppliedOption.LocalOption;
+    public static readonly Option<bool> LocalOption = ToolAppliedOption.LocalOption(CliCommandStrings.ToolListLocalOptionDescription);
 
-    public static readonly Option<string> ToolPathOption = ToolAppliedOption.ToolPathOption;
+    public static readonly Option<string> ToolPathOption = ToolAppliedOption.ToolPathOption(CliCommandStrings.ToolListToolPathOptionDescription);
 
     public static readonly Option<ToolListOutputFormat> ToolListFormatOption = new("--format")
     {
         Arity = ArgumentArity.ZeroOrOne,
         DefaultValueFactory = _ => ToolListOutputFormat.table,
+        Description = CliCommandStrings.ToolListFormatOptionDescription
     };
 
     private static readonly Command Command = ConstructCommand();
@@ -43,9 +44,9 @@ private static Command ConstructCommand()
 
         command.Arguments.Add(PackageIdArgument);
         command.Options.Add(GlobalOption);
-        command.Options.Add(LocalOption.WithHelpDescription(command, CliCommandStrings.ToolListLocalOptionDescription));
-        command.Options.Add(ToolPathOption.WithHelpDescription(command, CliCommandStrings.ToolListToolPathOptionDescription));
-        command.Options.Add(ToolListFormatOption.WithHelpDescription(command, CliCommandStrings.ToolListFormatOptionDescription));
+        command.Options.Add(LocalOption);
+        command.Options.Add(ToolPathOption);
+        command.Options.Add(ToolListFormatOption);
 
         command.SetAction((parseResult) => new ToolListCommand(parseResult).Execute());
 

diff --git a/src/Cli/dotnet/Commands/Tool/Restore/ToolRestoreCommandParser.cs b/src/Cli/dotnet/Commands/Tool/Restore/ToolRestoreCommandParser.cs
@@ -16,7 +16,7 @@ internal static class ToolRestoreCommandParser
 
     public static readonly Option<string[]> AddSourceOption = ToolInstallCommandParser.AddSourceOption;
 
-    public static readonly Option<string> ToolManifestOption = ToolAppliedOption.ToolManifestOption;
+    public static readonly Option<string> ToolManifestOption = ToolAppliedOption.ToolManifestOption(CliCommandStrings.ToolRestoreManifestPathOptionDescription);
 
     public static readonly Option<VerbosityOptions> VerbosityOption = ToolInstallCommandParser.VerbosityOption;
 
@@ -33,7 +33,7 @@ private static Command ConstructCommand()
 
         command.Options.Add(ConfigOption);
         command.Options.Add(AddSourceOption);
-        command.Options.Add(ToolManifestOption.WithHelpDescription(command, CliCommandStrings.ToolRestoreManifestPathOptionDescription));
+        command.Options.Add(ToolManifestOption);
         command.Options.Add(ToolCommandRestorePassThroughOptions.DisableParallelOption);
         command.Options.Add(ToolCommandRestorePassThroughOptions.IgnoreFailedSourcesOption);
         command.Options.Add(ToolCommandRestorePassThroughOptions.NoCacheOption);

diff --git a/src/Cli/dotnet/Commands/Tool/Uninstall/ToolUninstallCommandParser.cs b/src/Cli/dotnet/Commands/Tool/Uninstall/ToolUninstallCommandParser.cs
@@ -22,11 +22,11 @@ internal static class ToolUninstallCommandParser
 
     public static readonly Option<bool> GlobalOption = ToolAppliedOption.GlobalOption(CliCommandStrings.ToolUninstallGlobalOptionDescription);
 
-    public static readonly Option<bool> LocalOption = ToolAppliedOption.LocalOption;
+    public static readonly Option<bool> LocalOption = ToolAppliedOption.LocalOption(CliCommandStrings.ToolUninstallLocalOptionDescription);
 
-    public static readonly Option<string> ToolPathOption = ToolAppliedOption.ToolPathOption;
+    public static readonly Option<string> ToolPathOption = ToolAppliedOption.ToolPathOption(CliCommandStrings.ToolUninstallToolPathOptionDescription);
 
-    public static readonly Option<string> ToolManifestOption = ToolAppliedOption.ToolManifestOption;
+    public static readonly Option<string> ToolManifestOption = ToolAppliedOption.ToolManifestOption(CliCommandStrings.ToolUninstallManifestPathOptionDescription);
 
     private static readonly Command Command = ConstructCommand();
 
@@ -41,9 +41,9 @@ private static Command ConstructCommand()
 
         command.Arguments.Add(PackageIdArgument);
         command.Options.Add(GlobalOption);
-        command.Options.Add(LocalOption.WithHelpDescription(command, CliCommandStrings.ToolUninstallLocalOptionDescription));
-        command.Options.Add(ToolPathOption.WithHelpDescription(command, CliCommandStrings.ToolUninstallToolPathOptionDescription));
-        command.Options.Add(ToolManifestOption.WithHelpDescription(command, CliCommandStrings.ToolUninstallManifestPathOptionDescription));
+        command.Options.Add(LocalOption);
+        command.Options.Add(ToolPathOption);
+        command.Options.Add(ToolManifestOption);
 
         command.SetAction((parseResult) => new ToolUninstallCommand(parseResult).Execute());
 

diff --git a/src/Cli/dotnet/Commands/Tool/Uninstall/ToolUninstallGlobalOrToolPathCommand.cs b/src/Cli/dotnet/Commands/Tool/Uninstall/ToolUninstallGlobalOrToolPathCommand.cs
@@ -32,7 +32,7 @@ internal class ToolUninstallGlobalOrToolPathCommand(
     public override int Execute()
     {
         var global = _parseResult.GetValue(ToolUninstallCommandParser.GlobalOption);
-        var toolPath = _parseResult.GetValue(ToolAppliedOption.ToolPathOption);
+        var toolPath = _parseResult.GetValue(ToolUninstallCommandParser.ToolPathOption);
 
         DirectoryPath? toolDirectoryPath = null;
         if (!string.IsNullOrWhiteSpace(toolPath))

diff --git a/src/Cli/dotnet/Extensions/OptionForwardingExtensions.cs b/src/Cli/dotnet/Extensions/OptionForwardingExtensions.cs
@@ -86,22 +86,6 @@ public static Option<T> Hide<T>(this Option<T> option)
         return option;
     }
 
-    internal static Dictionary<Option, Dictionary<Command, string>> HelpDescriptionCustomizations = [];
-
-    public static Option<T> WithHelpDescription<T>(this Option<T> option, Command command, string helpText)
-    {
-        if (HelpDescriptionCustomizations.ContainsKey(option))
-        {
-            HelpDescriptionCustomizations[option].Add(command, helpText);
-        }
-        else
-        {
-            HelpDescriptionCustomizations.Add(option, new Dictionary<Command, string>() { { command, helpText } });
-        }
-
-        return option;
-    }
-
     private static IEnumerable<string> ForwardedArguments(string alias, IEnumerable<string>? arguments)
     {
         foreach (string arg in arguments ?? [])

diff --git a/src/Cli/dotnet/Parser.cs b/src/Cli/dotnet/Parser.cs
@@ -280,22 +280,6 @@ private DotnetHelpBuilder(int maxWidth = int.MaxValue) : base(maxWidth) { }
 
         private static void SetHelpCustomizations(HelpBuilder builder)
         {
-            foreach (var option in OptionForwardingExtensions.HelpDescriptionCustomizations.Keys)
-            {
-                Func<HelpContext, string> descriptionCallback = (HelpContext context) =>
-                {
-                    foreach (var (command, helpText) in OptionForwardingExtensions.HelpDescriptionCustomizations[option])
-                    {
-                        if (context.ParseResult.CommandResult.Command.Equals(command))
-                        {
-                            return helpText;
-                        }
-                    }
-                    return null;
-                };
-                builder.CustomizeSymbol(option, secondColumnText: descriptionCallback);
-            }
-
             builder.CustomizeSymbol(WorkloadSearchVersionsCommandParser.GetCommand(), secondColumnText: CliStrings.ShortWorkloadSearchVersionDescription);
         }