Removes the custom GetHashCode and Equals overrides in HelpOption and VerboseOption (#2159)

* fix #2118

This removes the custom GetHashCode and Equals overrides in HelpOption and VerboseOption.

* fix #2116

Author: jonsequitur

src/System.CommandLine.ApiCompatibility.Tests/ApiCompatibilityApprovalTests.System_CommandLine_api_is_not_changed.approved.txt

@@ -155,8 +155,6 @@ System.CommandLine
     .ctor()
     .ctor(System.String name, System.String[] aliases)
     public CliAction Action { get; set; }
-    public System.Boolean Equals(System.Object obj)
-    public System.Int32 GetHashCode()
 System.CommandLine.Completions
   public class CompletionContext
     public static CompletionContext Empty { get; }
@@ -220,8 +218,6 @@ System.CommandLine.Help
     .ctor()
     .ctor(System.String name, System.String[] aliases)
     public System.CommandLine.CliAction Action { get; set; }
-    public System.Boolean Equals(System.Object obj)
-    public System.Int32 GetHashCode()
   public class TwoColumnHelpRow, System.IEquatable<TwoColumnHelpRow>
     .ctor(System.String firstColumnText, System.String secondColumnText)
     public System.String FirstColumnText { get; }

src/System.CommandLine.Tests/Help/HelpBuilderTests.Customization.cs

@@ -405,6 +405,8 @@ public void Help_sections_can_be_supplemented()
                     Output = new StringWriter(),
                 };
 
+                var defaultHelp = GetDefaultHelp(config.RootCommand);
+
                 ParseResult parseResult = config.Parse("-h");
 
                 if (parseResult.Action is HelpAction helpAction)
@@ -415,7 +417,6 @@ public void Help_sections_can_be_supplemented()
                 parseResult.Invoke();
 
                 var output = config.Output.ToString();
-                var defaultHelp = GetDefaultHelp(config.RootCommand);
 
                 var expected = $"first{NewLine}{NewLine}{defaultHelp}last{NewLine}{NewLine}";
 

src/System.CommandLine/Help/HelpBuilder.Default.cs

@@ -181,16 +181,20 @@ public static Action<HelpContext> SubcommandsSection() =>
         public static Action<HelpContext> OptionsSection() =>
             ctx =>
             {
-                // by making this logic more complex, we were able to get some nice perf wins elsewhere
-                List<TwoColumnHelpRow> options = new();
-                HashSet<CliOption> uniqueOptions = new();
+                List<TwoColumnHelpRow> optionRows = new();
+                bool addedHelpOption = false;
+
                 if (ctx.Command.HasOptions)
                 {
                     foreach (CliOption option in ctx.Command.Options)
                     {
-                        if (!option.Hidden && uniqueOptions.Add(option))
+                        if (!option.Hidden)
                         {
-                            options.Add(ctx.HelpBuilder.GetTwoColumnRow(option, ctx));
+                            optionRows.Add(ctx.HelpBuilder.GetTwoColumnRow(option, ctx));
+                            if (option is HelpOption)
+                            {
+                                addedHelpOption = true;
+                            }
                         }
                     }
                 }
@@ -209,9 +213,12 @@ public static Action<HelpContext> OptionsSection() =>
                                 foreach (var option in parentCommand.Options)
                                 {
                                     // global help aliases may be duplicated, we just ignore them
-                                    if (option.Recursive && !option.Hidden && uniqueOptions.Add(option))
+                                    if (option is { Recursive: true, Hidden: false })
                                     {
-                                        options.Add(ctx.HelpBuilder.GetTwoColumnRow(option, ctx));
+                                        if (option is not HelpOption || !addedHelpOption)
+                                        {
+                                            optionRows.Add(ctx.HelpBuilder.GetTwoColumnRow(option, ctx));
+                                        }
                                     }
                                 }
                             }
@@ -223,14 +230,14 @@ public static Action<HelpContext> OptionsSection() =>
                     current = parentCommand;
                 }
 
-                if (options.Count <= 0)
+                if (optionRows.Count <= 0)
                 {
                     ctx.WasSectionSkipped = true;
                     return;
                 }
 
                 ctx.HelpBuilder.WriteHeading(LocalizationResources.HelpOptionsTitle(), null, ctx.Output);
-                ctx.HelpBuilder.WriteColumns(options, ctx);
+                ctx.HelpBuilder.WriteColumns(optionRows, ctx);
                 ctx.Output.WriteLine();
             };
 

src/System.CommandLine/Help/HelpBuilder.cs

@@ -48,11 +48,6 @@ public virtual void Write(HelpContext context)
                 return;
             }
 
-            if (OnCustomize is {})
-            {
-                OnCustomize(context);
-            }
-
             foreach (var writeSection in GetLayout(context))
             {
                 writeSection(context);
@@ -66,8 +61,6 @@ public virtual void Write(HelpContext context)
             context.Output.WriteLine();
         }
 
-        internal Action<HelpContext>? OnCustomize { get; set; }
-
         /// <summary>
         /// Specifies custom help details for a specific symbol.
         /// </summary>

src/System.CommandLine/Help/HelpOption.cs

@@ -37,11 +37,5 @@ public override CliAction? Action
             get => _action ??= new HelpAction(); 
             set => _action = value ?? throw new ArgumentNullException(nameof(value));
         }
-
-        internal override bool Greedy => false;
-
-        public override bool Equals(object? obj) => obj is HelpOption;
-
-        public override int GetHashCode() => typeof(HelpOption).GetHashCode();
     }
 }

src/System.CommandLine/VersionOption.cs

@@ -61,10 +61,6 @@ private static bool NotImplicit(SymbolResult symbolResult)
 
         internal override bool Greedy => false;
 
-        public override bool Equals(object? obj) => obj is VersionOption;
-
-        public override int GetHashCode() => typeof(VersionOption).GetHashCode();
-
         private sealed class VersionOptionAction : CliAction
         {
             public override int Invoke(ParseResult parseResult)