rename rename ISuggestionSource.Suggest -> GetSuggestions (#721)

Author: jonsequitur

src/System.CommandLine.Benchmarks/CommandLine/Perf_Suggestions.cs

@@ -50,7 +50,7 @@ public void Setup_FromSymbol()
         [Benchmark]
         public void SuggestionsFromSymbol()
         {
-            _testSymbol.Suggest().Consume(new Consumer());
+            _testSymbol.GetSuggestions().Consume(new Consumer());
         }
 
         [GlobalSetup(Target = nameof(SuggestionsFromParseResult))]

src/System.CommandLine.Tests/SuggestionTests.cs

@@ -33,7 +33,7 @@ public void Option_Suggest_returns_argument_suggestions_if_configured()
                     .WithSuggestions("one", "two", "three")
             };
 
-            var suggestions = option.Suggest();
+            var suggestions = option.GetSuggestions();
 
             suggestions.Should().BeEquivalentTo("one", "two", "three");
         }
@@ -58,7 +58,7 @@ public void Command_Suggest_returns_available_option_aliases()
 
             var command = command1;
 
-            var suggestions = command.Suggest();
+            var suggestions = command.GetSuggestions();
 
             suggestions.Should().BeEquivalentTo("--one", "--two", "--three");
         }
@@ -73,7 +73,7 @@ public void Command_Suggest_returns_available_subcommands()
                 new Command("three")
             };
 
-            var suggestions = command.Suggest();
+            var suggestions = command.GetSuggestions();
 
             suggestions.Should().BeEquivalentTo("one", "two", "three");
         }
@@ -87,7 +87,7 @@ public void Command_Suggest_returns_available_subcommands_and_option_aliases()
                 new Option("--option")
             };
 
-            var suggestions = command.Suggest();
+            var suggestions = command.GetSuggestions();
 
             suggestions.Should().BeEquivalentTo("subcommand", "--option");
         }
@@ -106,7 +106,7 @@ public void Command_Suggest_returns_available_subcommands_and_option_aliases_and
                     .WithSuggestions("command-argument")
             };
 
-            var suggestions = command.Suggest();
+            var suggestions = command.GetSuggestions();
 
             suggestions.Should()
                        .BeEquivalentTo("subcommand", "--option", "command-argument");

src/System.CommandLine/Argument.cs

@@ -164,15 +164,15 @@ internal void AddAllowedValues(IEnumerable<string> values)
             AllowedValues.UnionWith(values);
         }
 
-        public override IEnumerable<string> Suggest(string textToMatch)
+        public override IEnumerable<string> GetSuggestions(string textToMatch)
         {
             var fixedSuggestions = _suggestions;
 
             var dynamicSuggestions = _suggestionSources
-                .SelectMany(source => source.Suggest(textToMatch));
+                .SelectMany(source => source.GetSuggestions(textToMatch));
 
             var typeSuggestions = SuggestionSource.ForType(ArgumentType)
-                                                  .Suggest(textToMatch);
+                                                  .GetSuggestions(textToMatch);
 
             return fixedSuggestions
                    .Concat(dynamicSuggestions)

src/System.CommandLine/Help/HelpBuilder.cs

@@ -315,7 +315,7 @@ protected virtual string ArgumentDescriptor(IArgument argument)
                 return "";
             }
 
-            var suggestions = argument.Suggest().ToArray();
+            var suggestions = argument.GetSuggestions().ToArray();
             if (suggestions.Length > 0)
             {
                 return string.Join("|", suggestions);

src/System.CommandLine/Parsing/ParseResultExtensions.cs

@@ -199,7 +199,7 @@ public static IEnumerable<string> Suggestions(
 
             var currentSymbolSuggestions =
                 currentSymbol is ISuggestionSource currentSuggestionSource
-                    ? currentSuggestionSource.Suggest(textToMatch)
+                    ? currentSuggestionSource.GetSuggestions(textToMatch)
                     : Array.Empty<string>();
 
             IEnumerable<string> siblingSuggestions;
@@ -213,7 +213,7 @@ currentSymbol is ISuggestionSource currentSuggestionSource
             else
             {
                 siblingSuggestions = parentSymbol
-                                     .Suggest(textToMatch)
+                                     .GetSuggestions(textToMatch)
                                      .Except(parentSymbol
                                              .Children
                                              .OfType<ICommand>()

src/System.CommandLine/Suggestions/AnonymousSuggestionSource.cs

@@ -14,7 +14,7 @@ public AnonymousSuggestionSource(Suggest suggest)
             this.suggest = suggest;
         }
 
-        public IEnumerable<string> Suggest(string textToMatch = null)
+        public IEnumerable<string> GetSuggestions(string textToMatch = null)
         {
             return suggest(textToMatch);
         }

src/System.CommandLine/Suggestions/ISuggestionSource.cs

@@ -7,6 +7,6 @@ namespace System.CommandLine.Suggestions
 {
     public interface ISuggestionSource
     {
-        IEnumerable<string> Suggest(string textToMatch = null);
+        IEnumerable<string> GetSuggestions(string textToMatch = null);
     }
 }

src/System.CommandLine/Symbol.cs

@@ -146,12 +146,12 @@ public bool HasAlias(string alias)
 
         public bool IsHidden { get; set; }
 
-        public virtual IEnumerable<string> Suggest(string textToMatch = null)
+        public virtual IEnumerable<string> GetSuggestions(string textToMatch = null)
         {
             var argumentSuggestions =
                 Children
                     .OfType<IArgument>()
-                    .SelectMany(a => a.Suggest(textToMatch))
+                    .SelectMany(a => a.GetSuggestions(textToMatch))
                     .ToArray();
 
             return this.ChildSymbolAliases()