Refs dotnet#1074 - Instead of "Required argument missing for command: {commandname}", should provide "Required argument {argumentname} missing for command: {commandname}" for better clarity as to which required argument is missing.

Drizin · Drizin · commit 34a198112043 · 2022-12-13T21:27:34.000-05:00
diff --git a/src/System.CommandLine.Tests/ParserTests.MultipleArguments.cs b/src/System.CommandLine.Tests/ParserTests.MultipleArguments.cs
@@ -307,7 +307,7 @@ public void When_there_are_not_enough_tokens_for_all_arguments_then_the_correct_
                 var numberOfMissingArgs =
                     result
                         .Errors
-                        .Count(e => e.Message == LocalizationResources.Instance.RequiredArgumentMissing(result.CommandResult));
+                        .Count(e => e.Message == LocalizationResources.Instance.RequiredArgumentMissing(command.Arguments.First(), result.CommandResult));
 
                 numberOfMissingArgs
                     .Should()
diff --git a/src/System.CommandLine.Tests/ParserTests.cs b/src/System.CommandLine.Tests/ParserTests.cs
@@ -1401,7 +1401,7 @@ public void When_command_arguments_are_fewer_than_minimum_arity_then_an_error_is
             result.Errors
                   .Select(e => e.Message)
                   .Should()
-                  .Contain(LocalizationResources.Instance.RequiredArgumentMissing(result.CommandResult));
+                  .Contain(LocalizationResources.Instance.RequiredArgumentMissing(command.Arguments.First(), result.CommandResult));
         }
 
         [Fact]
@@ -1489,7 +1489,7 @@ public void When_option_arguments_are_fewer_than_minimum_arity_then_an_error_is_
             result.Errors
                   .Select(e => e.Message)
                   .Should()
-                  .Contain(LocalizationResources.Instance.RequiredArgumentMissing(result.CommandResult.FindResultFor(option)));
+                  .Contain(LocalizationResources.Instance.RequiredArgumentMissing(option.Argument, result.CommandResult.FindResultFor(option)));
         }
 
         [Fact]
diff --git a/src/System.CommandLine.Tests/ResourceLocalizationTests.cs b/src/System.CommandLine.Tests/ResourceLocalizationTests.cs
@@ -62,7 +62,7 @@ public FakeLocalizationResources(string message)
 
             public override string FileDoesNotExist(string filePath) => message;
 
-            public override string RequiredArgumentMissing(SymbolResult symbolResult) => message;
+            public override string RequiredArgumentMissing(Argument argument, SymbolResult symbolResult) => message;
 
             public override string RequiredCommandWasNotProvided() => message;
 
diff --git a/src/System.CommandLine.Tests/Utility/NonWindowsOnlyFactAttribute.cs b/src/System.CommandLine.Tests/Utility/NonWindowsOnlyFactAttribute.cs
@@ -10,7 +10,7 @@ public class NonWindowsOnlyFactAttribute : FactAttribute
     {
         public NonWindowsOnlyFactAttribute()
         {
-            if (RuntimeEnvironment.OperatingSystemPlatform == Platform.Windows)
+            if (RuntimeEnvironment.OperatingSystemPlatform == Microsoft.DotNet.PlatformAbstractions.Platform.Windows)
             {
                 Skip = "This test requires non-Windows to run";
             }
diff --git a/src/System.CommandLine.Tests/Utility/WindowsOnlyFactAttribute.cs b/src/System.CommandLine.Tests/Utility/WindowsOnlyFactAttribute.cs
@@ -10,7 +10,7 @@ public class WindowsOnlyFactAttribute : FactAttribute
     {
         public WindowsOnlyFactAttribute()
         {
-            if (RuntimeEnvironment.OperatingSystemPlatform != Platform.Windows)
+            if (RuntimeEnvironment.OperatingSystemPlatform != Microsoft.DotNet.PlatformAbstractions.Platform.Windows)
             {
                 Skip = "This test requires Windows to run";
             }
diff --git a/src/System.CommandLine/ArgumentArity.cs b/src/System.CommandLine/ArgumentArity.cs
@@ -95,7 +95,7 @@ public override int GetHashCode()
 
                 return ArgumentConversionResult.Failure(
                     argument,
-                    symbolResult.LocalizationResources.RequiredArgumentMissing(symbolResult),
+                    symbolResult.LocalizationResources.RequiredArgumentMissing(argument, symbolResult),
                     ArgumentConversionResultType.FailedMissingArgument);
             }
 
diff --git a/src/System.CommandLine/Binding/ArgumentConverter.cs b/src/System.CommandLine/Binding/ArgumentConverter.cs
@@ -195,7 +195,7 @@ internal static ArgumentConversionResult ConvertIfNeeded(
                 ArgumentConversionResultType.NoArgument when conversionResult.Argument.Arity.MinimumNumberOfValues > 0 =>
                     ArgumentConversionResult.Failure(
                         conversionResult.Argument,
-                        symbolResult.LocalizationResources.RequiredArgumentMissing(symbolResult),
+                        symbolResult.LocalizationResources.RequiredArgumentMissing(conversionResult.Argument, symbolResult),
                         ArgumentConversionResultType.FailedMissingArgument),
                         
                 _ => conversionResult
diff --git a/src/System.CommandLine/LocalizationResources.cs b/src/System.CommandLine/LocalizationResources.cs
@@ -85,11 +85,25 @@ public virtual string InvalidCharactersInFileName(char invalidChar) =>
             GetResourceString(Properties.Resources.InvalidCharactersInFileName, invalidChar);
 
         /// <summary>
-        ///   Interpolates values into a localized string similar to Required argument missing for command: {0}.
+        ///   Interpolates values into a localized string similar to 
+        ///   Required argument {0} missing for command: {1}.
+        ///   or
+        ///   Required argument missing for option: {0}.
+        /// </summary>
+        public virtual string RequiredArgumentMissing(Argument argument, SymbolResult symbolResult) =>
+            symbolResult is CommandResult
+                ? GetResourceString(Properties.Resources.CommandRequiredArgumentMissing, argument.Name, symbolResult.Token().Value)
+                : GetResourceString(Properties.Resources.OptionRequiredArgumentMissing, symbolResult.Token().Value);
+
+        /// <summary>
+        ///   Interpolates values into a localized string similar to 
+        ///   Required argument {0} missing for command: {1}.
+        ///   or
+        ///   Required argument missing for option: {0}.
         /// </summary>
         public virtual string RequiredArgumentMissing(SymbolResult symbolResult) =>
             symbolResult is CommandResult
-                ? GetResourceString(Properties.Resources.CommandRequiredArgumentMissing, symbolResult.Token().Value)
+                ? GetResourceString(Properties.Resources.CommandRequiredArgumentMissing, "(unknown)", symbolResult.Token().Value)
                 : GetResourceString(Properties.Resources.OptionRequiredArgumentMissing, symbolResult.Token().Value);
 
         /// <summary>
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
@@ -148,7 +148,7 @@
     <value>Character not allowed in a path: '{0}'.</value>
   </data>
   <data name="CommandRequiredArgumentMissing" xml:space="preserve">
-    <value>Required argument missing for command: '{0}'.</value>
+    <value>Required argument '{0}' missing for command: '{1}'.</value>
   </data>
   <data name="OptionRequiredArgumentMissing" xml:space="preserve">
     <value>Required argument missing for option: '{0}'.</value>
diff --git a/src/System.CommandLine/Properties/xlf/Resources.cs.xlf b/src/System.CommandLine/Properties/xlf/Resources.cs.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.de.xlf b/src/System.CommandLine/Properties/xlf/Resources.de.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.es.xlf b/src/System.CommandLine/Properties/xlf/Resources.es.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.fr.xlf b/src/System.CommandLine/Properties/xlf/Resources.fr.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.it.xlf b/src/System.CommandLine/Properties/xlf/Resources.it.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.ja.xlf b/src/System.CommandLine/Properties/xlf/Resources.ja.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.ko.xlf b/src/System.CommandLine/Properties/xlf/Resources.ko.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.pl.xlf b/src/System.CommandLine/Properties/xlf/Resources.pl.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.pt-BR.xlf b/src/System.CommandLine/Properties/xlf/Resources.pt-BR.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.ru.xlf b/src/System.CommandLine/Properties/xlf/Resources.ru.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.tr.xlf b/src/System.CommandLine/Properties/xlf/Resources.tr.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.zh-Hans.xlf b/src/System.CommandLine/Properties/xlf/Resources.zh-Hans.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/Properties/xlf/Resources.zh-Hant.xlf b/src/System.CommandLine/Properties/xlf/Resources.zh-Hant.xlf
@@ -33,8 +33,8 @@
         <note />
       </trans-unit>
       <trans-unit id="CommandRequiredArgumentMissing">
-        <source>Required argument missing for command: '{0}'.</source>
-        <target state="new">Required argument missing for command: '{0}'.</target>
+        <source>Required argument '{0}' missing for command: '{1}'.</source>
+        <target state="new">Required argument '{0}' missing for command: '{1}'.</target>
         <note />
       </trans-unit>
       <trans-unit id="DirectoryDoesNotExist">
diff --git a/src/System.CommandLine/System.CommandLine.csproj b/src/System.CommandLine/System.CommandLine.csproj
@@ -52,6 +52,7 @@
 
   <ItemGroup>
     <InternalsVisibleTo Include="System.CommandLine.NamingConventionBinder" />
+    <InternalsVisibleTo Include="System.CommandLine.Tests" />
   </ItemGroup>
 
 </Project>

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ public class NonWindowsOnlyFactAttribute : FactAttribute`
`10`	`10`	`{`
`11`	`11`	`public NonWindowsOnlyFactAttribute()`
`12`	`12`	`{`
`13`		`- if (RuntimeEnvironment.OperatingSystemPlatform == Platform.Windows)`
	`13`	`+ if (RuntimeEnvironment.OperatingSystemPlatform == Microsoft.DotNet.PlatformAbstractions.Platform.Windows)`
`14`	`14`	`{`
`15`	`15`	`Skip = "This test requires non-Windows to run";`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ public class WindowsOnlyFactAttribute : FactAttribute`
`10`	`10`	`{`
`11`	`11`	`public WindowsOnlyFactAttribute()`
`12`	`12`	`{`
`13`		`- if (RuntimeEnvironment.OperatingSystemPlatform != Platform.Windows)`
	`13`	`+ if (RuntimeEnvironment.OperatingSystemPlatform != Microsoft.DotNet.PlatformAbstractions.Platform.Windows)`
`14`	`14`	`{`
`15`	`15`	`Skip = "This test requires Windows to run";`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public override int GetHashCode()`
`95`	`95`
`96`	`96`	`return ArgumentConversionResult.Failure(`
`97`	`97`	`argument,`
`98`		`- symbolResult.LocalizationResources.RequiredArgumentMissing(symbolResult),`
	`98`	`+ symbolResult.LocalizationResources.RequiredArgumentMissing(argument, symbolResult),`
`99`	`99`	`ArgumentConversionResultType.FailedMissingArgument);`
`100`	`100`	`}`
`101`	`101`