Rename Option/CommandResult.Token to IdentifierToken (#2122)

* rename Option.Token to IdentifierToken, fixes #2015

* do the same for CommandResult

Author: adamsitnik

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

@@ -245,16 +245,16 @@ System.CommandLine.Parsing
   public class CommandResult : SymbolResult
     public System.Collections.Generic.IEnumerable<SymbolResult> Children { get; }
     public System.CommandLine.Command Command { get; }
-    public Token Token { get; }
+    public Token IdentifierToken { get; }
     public System.String ToString()
   public class DirectiveResult : SymbolResult
     public System.CommandLine.Directive Directive { get; }
     public Token Token { get; }
     public System.Collections.Generic.IReadOnlyList<System.String> Values { get; }
   public class OptionResult : SymbolResult
+    public Token IdentifierToken { get; }
     public System.Boolean IsImplicit { get; }
     public System.CommandLine.Option Option { get; }
-    public Token Token { get; }
     public T GetValueOrDefault<T>()
     public System.String ToString()
   public class ParseError

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

@@ -79,7 +79,7 @@ public void When_parsing_an_unsplit_string_then_input_a_full_path_to_an_executab
 
             var result2 = command.Parse($"\"{RootCommand.ExecutablePath}\" inner -x hello");
 
-            result2.RootCommandResult.Token.Value.Should().Be(RootCommand.ExecutablePath);
+            result2.RootCommandResult.IdentifierToken.Value.Should().Be(RootCommand.ExecutablePath);
         }
 
         [Fact]

src/System.CommandLine.Tests/ParserTests.cs

@@ -888,7 +888,7 @@ public void When_an_option_with_a_default_value_is_not_matched_then_there_are_no
             var result = command.Parse("command");
 
             result.FindResultFor(option)
-                  .Token
+                  .IdentifierToken
                   .Should()
                   .BeEquivalentTo(default(Token));
         }

src/System.CommandLine.Tests/ParsingValidationTests.cs

@@ -369,7 +369,7 @@ public void A_custom_validator_can_be_added_to_an_option()
             {
                 var value = r.GetValueOrDefault<int>();
 
-                r.AddError($"Option {r.Token.Value} cannot be set to {value}");
+                r.AddError($"Option {r.IdentifierToken.Value} cannot be set to {value}");
             });
 
             var command = new RootCommand { option };

src/System.CommandLine/Help/VersionOption.cs

@@ -44,7 +44,7 @@ private void AddValidators()
                     parent.Children.Where(r => !(r is OptionResult optionResult && optionResult.Option is VersionOption))
                           .Any(IsNotImplicit))
                 {
-                    result.AddError(LocalizationResources.VersionOptionCannotBeCombinedWithOtherArguments(result.Token?.Value ?? result.Option.Name));
+                    result.AddError(LocalizationResources.VersionOptionCannotBeCombinedWithOtherArguments(result.IdentifierToken?.Value ?? result.Option.Name));
                 }
             });
         }

src/System.CommandLine/LocalizationResources.cs

@@ -54,7 +54,7 @@ internal static string InvalidCharactersInFileName(char invalidChar) =>
         /// </summary>
         internal static string RequiredArgumentMissing(ArgumentResult argumentResult) =>
             argumentResult.Parent is CommandResult commandResult
-                ? GetResourceString(Properties.Resources.CommandRequiredArgumentMissing, commandResult.Token.Value)
+                ? GetResourceString(Properties.Resources.CommandRequiredArgumentMissing, commandResult.IdentifierToken.Value)
                 : RequiredArgumentMissing((OptionResult)argumentResult.Parent!);
 
         /// <summary>
@@ -252,6 +252,6 @@ private static string GetResourceString(string resourceString, params object[] f
             return resourceString;
         }
 
-        private static string GetOptionName(OptionResult optionResult) => optionResult.Token?.Value ?? optionResult.Option.Name;
+        private static string GetOptionName(OptionResult optionResult) => optionResult.IdentifierToken?.Value ?? optionResult.Option.Name;
     }
 }

src/System.CommandLine/Parsing/CommandResult.cs

@@ -20,7 +20,7 @@ internal CommandResult(
             base(symbolResultTree, parent)
         {
             Command = command ?? throw new ArgumentNullException(nameof(command));
-            Token = token ?? throw new ArgumentNullException(nameof(token));
+            IdentifierToken = token ?? throw new ArgumentNullException(nameof(token));
         }
 
         /// <summary>
@@ -31,15 +31,15 @@ internal CommandResult(
         /// <summary>
         /// The token that was parsed to specify the command.
         /// </summary>
-        public Token Token { get; }
+        public Token IdentifierToken { get; }
 
         /// <summary>
         /// Child symbol results in the parse tree.
         /// </summary>
         public IEnumerable<SymbolResult> Children => SymbolResultTree.GetChildren(this);
 
         /// <inheritdoc/>
-        public override string ToString() => $"{nameof(CommandResult)}: {Token.Value} {string.Join(" ", Tokens.Select(t => t.Value))}";
+        public override string ToString() => $"{nameof(CommandResult)}: {IdentifierToken.Value} {string.Join(" ", Tokens.Select(t => t.Value))}";
 
         internal override bool UseDefaultValueFor(ArgumentResult argumentResult)
             => argumentResult.Argument.HasDefaultValue && argumentResult.Tokens.Count == 0;

src/System.CommandLine/Parsing/OptionResult.cs

@@ -22,7 +22,7 @@ internal OptionResult(
             base(symbolResultTree, parent)
         {
             Option = option ?? throw new ArgumentNullException(nameof(option));
-            Token = token;
+            IdentifierToken = token;
         }
 
         /// <summary>
@@ -34,15 +34,15 @@ internal OptionResult(
         /// Indicates whether the result was created implicitly and not due to the option being specified on the command line.
         /// </summary>
         /// <remarks>Implicit results commonly result from options having a default value.</remarks>
-        public bool IsImplicit => Token is null || Token.IsImplicit;
+        public bool IsImplicit => IdentifierToken is null || IdentifierToken.IsImplicit;
 
         /// <summary>
         /// The token that was parsed to specify the option.
         /// </summary>
-        public Token? Token { get; }
+        public Token? IdentifierToken { get; }
 
         /// <inheritdoc/>
-        public override string ToString() => $"{nameof(OptionResult)}: {Token?.Value ?? Option.Name} {string.Join(" ", Tokens.Select(t => t.Value))}";
+        public override string ToString() => $"{nameof(OptionResult)}: {IdentifierToken?.Value ?? Option.Name} {string.Join(" ", Tokens.Select(t => t.Value))}";
 
         /// <summary>
         /// Gets the parsed value or the default value for <see cref="Option"/>.

src/System.CommandLine/Parsing/ParseResultExtensions.cs

@@ -128,11 +128,11 @@ private static void Diagram(
 
                     if (optionResult is not null)
                     {
-                        builder.Append(optionResult.Token?.Value ?? optionResult.Option.Name);
+                        builder.Append(optionResult.IdentifierToken?.Value ?? optionResult.Option.Name);
                     }
                     else
                     {
-                        builder.Append(((CommandResult)symbolResult).Token.Value);
+                        builder.Append(((CommandResult)symbolResult).IdentifierToken.Value);
                     }