Making HelpOption localizable (#1170)

Keboo · web-flow · commit fd3cf0cdd7c3 · 2021-02-03T11:31:49.000-08:00
* Making HelpOption localizable

Renamed ValidationMessages to Resources

* Adding other resource dictionaries
diff --git a/src/System.CommandLine.Tests/ParserTests.cs b/src/System.CommandLine.Tests/ParserTests.cs
@@ -155,7 +155,7 @@ public void When_a_token_is_just_a_prefix_then_an_error_is_returned(string prefi
             result.Errors
                   .Select(e => e.Message)
                   .Should()
-                  .Contain(ValidationMessages.Instance.UnrecognizedCommandOrArgument(prefix));
+                  .Contain(Resources.Instance.UnrecognizedCommandOrArgument(prefix));
         }
 
         [Fact]
@@ -1804,7 +1804,7 @@ public void When_command_arguments_are_fewer_than_minimum_arity_then_an_error_is
             result.Errors
                   .Select(e => e.Message)
                   .Should()
-                  .Contain(ValidationMessages.Instance.RequiredArgumentMissing(result.CommandResult));
+                  .Contain(Resources.Instance.RequiredArgumentMissing(result.CommandResult));
         }
 
         [Fact]
@@ -1824,7 +1824,7 @@ public void When_command_arguments_are_greater_than_maximum_arity_then_an_error_
                    .Errors
                    .Select(e => e.Message)
                    .Should()
-                   .Contain(ValidationMessages.Instance.UnrecognizedCommandOrArgument("4"));
+                   .Contain(Resources.Instance.UnrecognizedCommandOrArgument("4"));
         }
 
         [Fact]
@@ -1910,7 +1910,7 @@ public void When_option_arguments_are_fewer_than_minimum_arity_then_an_error_is_
             result.Errors
                   .Select(e => e.Message)
                   .Should()
-                  .Contain(ValidationMessages.Instance.RequiredArgumentMissing(result.CommandResult.FindResultFor(option)));
+                  .Contain(Resources.Instance.RequiredArgumentMissing(result.CommandResult.FindResultFor(option)));
         }
 
         [Fact]
@@ -1931,7 +1931,7 @@ public void When_option_arguments_are_greater_than_maximum_arity_then_an_error_i
                    .Errors
                    .Select(e => e.Message)
                    .Should()
-                   .Contain(ValidationMessages.Instance.UnrecognizedCommandOrArgument("4"));
+                   .Contain(Resources.Instance.UnrecognizedCommandOrArgument("4"));
         }
 
 
diff --git a/src/System.CommandLine.Tests/ParsingValidationTests.cs b/src/System.CommandLine.Tests/ParsingValidationTests.cs
@@ -762,7 +762,7 @@ public void A_command_with_subcommands_is_invalid_to_invoke_if_it_has_no_handler
             result.Errors
                   .Should()
                   .ContainSingle(
-                      e => e.Message.Equals(ValidationMessages.Instance.RequiredCommandWasNotProvided()) &&
+                      e => e.Message.Equals(Resources.Instance.RequiredCommandWasNotProvided()) &&
                            e.SymbolResult.Symbol.Name.Equals("inner"));
         }
 
@@ -778,7 +778,7 @@ public void A_root_command_is_invalid_if_it_has_no_handler()
             result.Errors
                   .Should()
                   .ContainSingle(
-                      e => e.Message.Equals(ValidationMessages.Instance.RequiredCommandWasNotProvided()) &&
+                      e => e.Message.Equals(Resources.Instance.RequiredCommandWasNotProvided()) &&
                            e.SymbolResult.Symbol == rootCommand);
         }
 
diff --git a/src/System.CommandLine.Tests/ValidationMessageLocalizationTests.cs b/src/System.CommandLine.Tests/ValidationMessageLocalizationTests.cs
@@ -56,7 +56,7 @@ public void Default_validation_messages_can_be_replaced_using_CommandLineBuilder
                   .Contain("the-message");
         }
 
-        public class FakeValidationMessages : ValidationMessages
+        public class FakeValidationMessages : Resources
         {
             private readonly string message;
 
diff --git a/src/System.CommandLine/Binding/ArgumentConverter.cs b/src/System.CommandLine/Binding/ArgumentConverter.cs
@@ -316,7 +316,7 @@ internal static ArgumentConversionResult ConvertIfNeeded(
                 case NoArgumentConversionResult _ when conversionResult.Argument.Arity.MinimumNumberOfValues > 0:
                     return new MissingArgumentConversionResult(
                         conversionResult.Argument,
-                        ValidationMessages.Instance.RequiredArgumentMissing(symbolResult));
+                        Resources.Instance.RequiredArgumentMissing(symbolResult));
 
                 case NoArgumentConversionResult _ when conversionResult.Argument.Arity.MaximumNumberOfValues > 1:
                     return Success(
diff --git a/src/System.CommandLine/Builder/CommandLineBuilder.cs b/src/System.CommandLine/Builder/CommandLineBuilder.cs
@@ -29,7 +29,7 @@ public CommandLineBuilder(Command? rootCommand = null)
 
         internal HelpOption? HelpOption { get; set; }
 
-        internal ValidationMessages? ValidationMessages { get; set; }
+        internal Resources? ValidationMessages { get; set; }
 
         public Parser Build()
         {
diff --git a/src/System.CommandLine/Builder/CommandLineBuilderExtensions.cs b/src/System.CommandLine/Builder/CommandLineBuilderExtensions.cs
@@ -484,7 +484,7 @@ public static CommandLineBuilder UseTypoCorrections(
 
         public static CommandLineBuilder UseValidationMessages(
             this CommandLineBuilder builder,
-            ValidationMessages validationMessages)
+            Resources validationMessages)
         {
             builder.ValidationMessages = validationMessages;
             return builder;
diff --git a/src/System.CommandLine/CommandLineConfiguration.cs b/src/System.CommandLine/CommandLineConfiguration.cs
@@ -34,7 +34,7 @@ public CommandLineConfiguration(
             IReadOnlyList<Symbol> symbols,
             bool enablePosixBundling = true,
             bool enableDirectives = true,
-            ValidationMessages? validationMessages = null,
+            Resources? validationMessages = null,
             ResponseFileHandling responseFileHandling = ResponseFileHandling.ParseArgsAsLineSeparated,
             IReadOnlyCollection<InvocationMiddleware>? middlewarePipeline = null,
             Func<BindingContext, IHelpBuilder>? helpBuilderFactory = null)
@@ -81,7 +81,7 @@ public CommandLineConfiguration(
 
             EnablePosixBundling = enablePosixBundling;
             EnableDirectives = enableDirectives;
-            ValidationMessages = validationMessages ?? ValidationMessages.Instance;
+            ValidationMessages = validationMessages ?? Resources.Instance;
             ResponseFileHandling = responseFileHandling;
             Middleware = middlewarePipeline ?? new List<InvocationMiddleware>();
             HelpBuilderFactory = helpBuilderFactory ?? (context => new HelpBuilder(context.Console));
@@ -128,7 +128,7 @@ private void AddGlobalOptionsToChildren(Command parentCommand)
         /// <summary>
         /// Gets the validation messages.
         /// </summary>
-        public ValidationMessages ValidationMessages { get; }
+        public Resources ValidationMessages { get; }
 
         internal Func<BindingContext, IHelpBuilder> HelpBuilderFactory { get; }
 
diff --git a/src/System.CommandLine/Help/HelpOption.cs b/src/System.CommandLine/Help/HelpOption.cs
@@ -12,7 +12,7 @@ public HelpOption() : base(new[]
             "--help",
             "-?",
             "/?"
-        }, "Show help and usage information")
+        }, Resources.Instance.HelpOptionDescription() )
         {
         }
 
diff --git a/src/System.CommandLine/Parsing/SymbolResult.cs b/src/System.CommandLine/Parsing/SymbolResult.cs
@@ -8,7 +8,7 @@ namespace System.CommandLine.Parsing
     public abstract class SymbolResult
     {
         private protected readonly List<Token> _tokens = new List<Token>();
-        private ValidationMessages? _validationMessages;
+        private Resources? _validationMessages;
         private readonly Dictionary<IArgument, ArgumentResult> _defaultArgumentValues = new Dictionary<IArgument, ArgumentResult>();
 
         private protected SymbolResult(
@@ -53,9 +53,9 @@ internal int MaximumArgumentCapacity()
             return value;
         }
 
-        protected internal ValidationMessages ValidationMessages
+        protected internal Resources ValidationMessages
         {
-            get => _validationMessages ??= Parent?.ValidationMessages ?? ValidationMessages.Instance;
+            get => _validationMessages ??= Parent?.ValidationMessages ?? Resources.Instance;
             set => _validationMessages = value;
         }
 
diff --git a/src/System.CommandLine/Properties/Resources.Designer.cs b/src/System.CommandLine/Properties/Resources.Designer.cs
diff --git a/src/System.CommandLine/Properties/Resources.resx b/src/System.CommandLine/Properties/Resources.resx
@@ -168,4 +168,7 @@
   <data name="ErrorReadingResponseFile" xml:space="preserve">
     <value>Error reading response file '{0}': {1}</value>
   </data>
+  <data name="HelpOptionDescription" xml:space="preserve">
+    <value>Show help and usage information</value>
+  </data>
 </root>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.cs.xlf b/src/System.CommandLine/Properties/xlf/Resources.cs.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.de.xlf b/src/System.CommandLine/Properties/xlf/Resources.de.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.es.xlf b/src/System.CommandLine/Properties/xlf/Resources.es.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.fr.xlf b/src/System.CommandLine/Properties/xlf/Resources.fr.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.it.xlf b/src/System.CommandLine/Properties/xlf/Resources.it.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.ja.xlf b/src/System.CommandLine/Properties/xlf/Resources.ja.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.ko.xlf b/src/System.CommandLine/Properties/xlf/Resources.ko.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.pl.xlf b/src/System.CommandLine/Properties/xlf/Resources.pl.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.pt-BR.xlf b/src/System.CommandLine/Properties/xlf/Resources.pt-BR.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.ru.xlf b/src/System.CommandLine/Properties/xlf/Resources.ru.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.tr.xlf b/src/System.CommandLine/Properties/xlf/Resources.tr.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.zh-Hans.xlf b/src/System.CommandLine/Properties/xlf/Resources.zh-Hans.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.zh-Hant.xlf b/src/System.CommandLine/Properties/xlf/Resources.zh-Hant.xlf
@@ -42,6 +42,11 @@
         <target state="new">File or directory does not exist: {0}</target>
         <note />
       </trans-unit>
+      <trans-unit id="HelpOptionDescription">
+        <source>Show help and usage information</source>
+        <target state="new">Show help and usage information</target>
+        <note />
+      </trans-unit>
       <trans-unit id="InvalidCharactersInPath">
         <source>Character not allowed in a path: {0}</source>
         <target state="new">Character not allowed in a path: {0}</target>
diff --git a/src/System.CommandLine/Resources.cs b/src/System.CommandLine/Resources.cs
@@ -8,11 +8,11 @@
 
 namespace System.CommandLine
 {
-    public class ValidationMessages
+    public class Resources
     {
-        public static ValidationMessages Instance { get; } = new ValidationMessages();
+        public static Resources Instance { get; } = new Resources();
 
-        protected ValidationMessages()
+        protected Resources()
         {
         }
 
@@ -66,6 +66,9 @@ public virtual string ResponseFileNotFound(string filePath) =>
         public virtual string ErrorReadingResponseFile(string filePath, IOException e) =>
             GetResourceString(Properties.Resources.ErrorReadingResponseFile, filePath, e.Message);
 
+        public virtual string HelpOptionDescription() =>
+            GetResourceString(Properties.Resources.HelpOptionDescription);
+
         protected virtual string GetResourceString(string resourceString, params object[] formatArguments)
         {
             if (resourceString is null)

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public void Default_validation_messages_can_be_replaced_using_CommandLineBuilder`
`56`	`56`	`.Contain("the-message");`
`57`	`57`	`}`
`58`	`58`
`59`		`- public class FakeValidationMessages : ValidationMessages`
	`59`	`+ public class FakeValidationMessages : Resources`
`60`	`60`	`{`
`61`	`61`	`private readonly string message;`
`62`	`62`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public CommandLineBuilder(Command? rootCommand = null)`
`29`	`29`
`30`	`30`	`internal HelpOption? HelpOption { get; set; }`
`31`	`31`
`32`		`- internal ValidationMessages? ValidationMessages { get; set; }`
	`32`	`+ internal Resources? ValidationMessages { get; set; }`
`33`	`33`
`34`	`34`	`public Parser Build()`
`35`	`35`	`{`
Original file line number	Diff line number	Diff line change
`@@ -484,7 +484,7 @@ public static CommandLineBuilder UseTypoCorrections(`
`484`	`484`
`485`	`485`	`public static CommandLineBuilder UseValidationMessages(`
`486`	`486`	`this CommandLineBuilder builder,`
`487`		`- ValidationMessages validationMessages)`
	`487`	`+ Resources validationMessages)`
`488`	`488`	`{`
`489`	`489`	`builder.ValidationMessages = validationMessages;`
`490`	`490`	`return builder;`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public HelpOption() : base(new[]`
`12`	`12`	`"--help",`
`13`	`13`	`"-?",`
`14`	`14`	`"/?"`
`15`		`- }, "Show help and usage information")`
	`15`	`+ }, Resources.Instance.HelpOptionDescription() )`
`16`	`16`	`{`
`17`	`17`	`}`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ namespace System.CommandLine.Parsing`
`8`	`8`	`public abstract class SymbolResult`
`9`	`9`	`{`
`10`	`10`	`private protected readonly List<Token> _tokens = new List<Token>();`
`11`		`- private ValidationMessages? _validationMessages;`
	`11`	`+ private Resources? _validationMessages;`
`12`	`12`	`private readonly Dictionary<IArgument, ArgumentResult> _defaultArgumentValues = new Dictionary<IArgument, ArgumentResult>();`
`13`	`13`
`14`	`14`	`private protected SymbolResult(`
`@@ -53,9 +53,9 @@ internal int MaximumArgumentCapacity()`
`53`	`53`	`return value;`
`54`	`54`	`}`
`55`	`55`
`56`		`- protected internal ValidationMessages ValidationMessages`
	`56`	`+ protected internal Resources ValidationMessages`
`57`	`57`	`{`
`58`		`- get => _validationMessages ??= Parent?.ValidationMessages ?? ValidationMessages.Instance;`
	`58`	`+ get => _validationMessages ??= Parent?.ValidationMessages ?? Resources.Instance;`
`59`	`59`	`set => _validationMessages = value;`
`60`	`60`	`}`
`61`	`61`