XML docs, refactoring, a couple of renames (#1339)

* R: GetValueOrDefault from extension methods to members

* R: use some C# 9, clean up

* rename ValidateSymbol to ValidateSymbolResult

* rename Option.HasAliasIgnorePrefix to HasAliasIgnoringPrefix

* add XML comments

* R: cleanup

* disable documentation warnings

* langword instead of c

* R: or instead of ||

* more XML docs, remove dotnet-suggest error loc strings

* Update src/System.CommandLine/ArgumentExtensions.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/Collections/ISymbolSet.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/Option.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/Resources.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/Resources.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/Parsing/OptionResult.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/Resources.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/Option.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/CommandExtensions.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/OptionExtensions.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/OptionExtensions.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/OptionExtensions.cs

Co-authored-by: Kevin B <[email protected]>

* Update src/System.CommandLine/Parsing/CommandResult.cs

Co-authored-by: Kevin B <[email protected]>

* PR comments

Co-authored-by: Kevin B <[email protected]>

Author: jonsequitur

src/System.CommandLine.DragonFruit/CommandLine.cs

@@ -215,7 +215,7 @@ public static CommandLineBuilder ConfigureHelpFromXmlComments(
                     {
                         var kebabCasedParameterName = parameterDescription.Key.ToKebabCase();
 
-                        var option = options.FirstOrDefault(o => o.HasAliasIgnorePrefix(kebabCasedParameterName));
+                        var option = options.FirstOrDefault(o => o.HasAliasIgnoringPrefix(kebabCasedParameterName));
 
                         if (option != null)
                         {

src/System.CommandLine.Tests/ArgumentTests.cs

@@ -9,7 +9,6 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Xunit;
-using Xunit.Abstractions;
 
 namespace System.CommandLine.Tests
 {

src/System.CommandLine.Tests/Binding/ModelBindingCommandHandlerTests.cs

@@ -418,7 +418,7 @@ public async Task Handler_method_receives_command_arguments_explicitly_bound_to_
             {
                 argument
             };
-            if (!(handler is ModelBindingCommandHandler bindingHandler))
+            if (handler is not ModelBindingCommandHandler bindingHandler)
             {
                 throw new InvalidOperationException("Cannot bind to this type of handler");
             }
@@ -470,7 +470,7 @@ public async Task Handler_method_receive_option_arguments_explicitly_bound_to_th
             {
                 option
             };
-            if (!(handler is ModelBindingCommandHandler bindingHandler))
+            if (handler is not ModelBindingCommandHandler bindingHandler)
             {
                 throw new InvalidOperationException("Cannot bind to this type of handler");
             }
@@ -515,7 +515,7 @@ public void Apply(InvocationContext context)
             }
         }
 
-        internal static readonly BindingTestSet BindingCases = new BindingTestSet
+        internal static readonly BindingTestSet BindingCases = new()
         {
               BindingTestCase.Create<int>(
                  "123",

src/System.CommandLine.Tests/Binding/TypeConversionTests.cs

@@ -2,7 +2,6 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System.Collections.Generic;
-using System.CommandLine.Invocation;
 using System.CommandLine.Parsing;
 using System.IO;
 using FluentAssertions;
@@ -644,14 +643,5 @@ public void When_getting_an_array_of_values_and_specifying_a_conversion_type_tha
                     .Should()
                     .Be("Option '-x' expects a single argument but 2 were provided.");
         }
-
-        public class MyCustomType
-        {
-            private readonly List<string> values = new List<string>();
-
-            public void Add(string value) => values.Add(value);
-
-            public string[] Values => values.ToArray();
-        }
     }
 }

src/System.CommandLine.Tests/Directory.Build.props

@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <UseBetaVersion>true</UseBetaVersion>
+    <NoWarn>IDE1006</NoWarn>
   </PropertyGroup>
 
   <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)../'))" />

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

@@ -9,10 +9,7 @@
 using System.CommandLine.Parsing;
 using System.IO;
 using System.Linq;
-using System.Security;
-using System.Text;
 using Xunit;
-using Xunit.Abstractions;
 using static System.Environment;
 
 namespace System.CommandLine.Tests.Help

src/System.CommandLine.Tests/Invocation/CommandHandlerTests.cs

@@ -14,7 +14,7 @@ namespace System.CommandLine.Tests.Invocation
 {
     public class CommandHandlerTests
     {
-        private readonly TestConsole _console = new TestConsole();
+        private readonly TestConsole _console = new();
 
         [Fact]
         public async Task Specific_invocation_behavior_can_be_specified_in_the_command()

src/System.CommandLine.Tests/OptionTests.cs

@@ -64,7 +64,7 @@ public void A_prefixed_alias_can_be_added_to_an_option()
 
             option.AddAlias("-a");
 
-            option.HasAliasIgnorePrefix("a").Should().BeTrue();
+            option.HasAliasIgnoringPrefix("a").Should().BeTrue();
             option.HasAlias("-a").Should().BeTrue();
         }
 
@@ -89,7 +89,7 @@ public void HasAliasIgnorePrefix_accepts_unprefixed_short_value()
         {
             var option = new Option(new[] { "-o", "--option" });
 
-            option.HasAliasIgnorePrefix("o").Should().BeTrue();
+            option.HasAliasIgnoringPrefix("o").Should().BeTrue();
         }
 
         [Fact]
@@ -105,7 +105,7 @@ public void HasAliasIgnorePrefix_accepts_unprefixed_long_value()
         {
             var option = new Option(new[] { "-o", "--option" });
 
-            option.HasAliasIgnorePrefix("option").Should().BeTrue();
+            option.HasAliasIgnoringPrefix("option").Should().BeTrue();
         }
 
         [Fact]

src/System.CommandLine.Tests/ParserTests.MultipleArguments.cs

@@ -2,7 +2,6 @@
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
 using System.Collections.Generic;
-using System.CommandLine.Parsing;
 using System.CommandLine.Tests.Utility;
 using FluentAssertions;
 using FluentAssertions.Execution;

src/System.CommandLine.Tests/Utility/AssertionExtensions.cs

@@ -44,7 +44,7 @@ public static AndConstraint<StringCollectionAssertions> BeEquivalentSequenceTo(
             return assertions.BeEquivalentTo(expectedValues, c => c.WithStrictOrderingFor(s => s));
         }
 
-        public static ConsoleAssertions Should(this IConsole console) => new ConsoleAssertions(console);
+        public static ConsoleAssertions Should(this IConsole console) => new(console);
 
         public static AndConstraint<ConsoleAssertions> ShowHelp(this ConsoleAssertions assertions)
         {