fix: show allowed values in help text correctly when multiple `Allowe…

…dValuesAttribute` are used (natemcmaster#375)
scott-xu · Aug 28, 2020 · 497f598 · 497f598
1 parent 17476ab
commit 497f598
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 10 deletions.
diff --git a/src/CommandLineUtils/HelpText/DefaultHelpTextGenerator.cs b/src/CommandLineUtils/HelpText/DefaultHelpTextGenerator.cs
@@ -197,11 +197,13 @@ protected virtual void GenerateArguments(
                         ? $"{arg.Description}\nAllowed values are: {string.Join(", ", enumNames)}."
                         : arg.Description;
 
-                    var attributeValidator = arg.Validators.Cast<AttributeValidator>().FirstOrDefault();
-
-                    if (attributeValidator != null && attributeValidator.ValidationAttribute is AllowedValuesAttribute allowedValuesAttribute)
+                    foreach (var attributeValidator in arg.Validators.Cast<AttributeValidator>())
                     {
-                        description += $"\nAllowed values are: {string.Join(", ", allowedValuesAttribute.AllowedValues)}.";
+                        if (attributeValidator?.ValidationAttribute is AllowedValuesAttribute allowedValuesAttribute)
+                        {
+                            description += $"\nAllowed values are: {string.Join(", ", allowedValuesAttribute.AllowedValues)}.";
+                            break;
+                        }
                     }
 
                     var wrappedDescription = IndentWriter?.Write(description);
@@ -239,11 +241,13 @@ protected virtual void GenerateOptions(
                         ? $"{opt.Description}\nAllowed values are: {string.Join(", ", enumNames)}."
                         : opt.Description;
 
-                    var attributeValidator = opt.Validators.Cast<AttributeValidator>().FirstOrDefault();
-
-                    if (attributeValidator != null && attributeValidator.ValidationAttribute is AllowedValuesAttribute allowedValuesAttribute)
+                    foreach (var attributeValidator in opt.Validators.Cast<AttributeValidator>())
                     {
-                        description+= $"\nAllowed values are: {string.Join(", ", allowedValuesAttribute.AllowedValues)}.";
+                        if (attributeValidator?.ValidationAttribute is AllowedValuesAttribute allowedValuesAttribute)
+                        {
+                            description += $"\nAllowed values are: {string.Join(", ", allowedValuesAttribute.AllowedValues)}.";
+                            break;
+                        }
                     }
 
                     var wrappedDescription = IndentWriter?.Write(description);

diff --git a/test/CommandLineUtils.Tests/DefaultHelpTextGeneratorTests.cs b/test/CommandLineUtils.Tests/DefaultHelpTextGeneratorTests.cs
@@ -4,6 +4,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.ComponentModel.DataAnnotations;
 using System.IO;
 using System.Text;
 using McMaster.Extensions.CommandLineUtils.HelpText;
@@ -108,11 +109,11 @@ public void ShowHelp()
             var app = new CommandLineApplication();
             app.HelpOption();
             app.Option("--strOpt <E>", "str option desc.", CommandOptionType.SingleValue);
-            app.Option("--rStrOpt <E>", "restricted str option desc.", CommandOptionType.SingleValue, o => o.Accepts().Values("Foo", "Bar"));
+            app.Option("--rStrOpt <E>", "restricted str option desc.", CommandOptionType.SingleValue, o => o.IsRequired().Accepts().Values("Foo", "Bar"));
             app.Option<int>("--intOpt <E>", "int option desc.", CommandOptionType.SingleValue);
             app.Option<SomeEnum>("--enumOpt <E>", "enum option desc.", CommandOptionType.SingleValue);
             app.Argument("SomeStringArgument", "string arg desc.");
-            app.Argument("RestrictedStringArgument", "restricted string arg desc.", a=>a.Accepts().Values("Foo", "Bar"));
+            app.Argument("RestrictedStringArgument", "restricted string arg desc.", a => a.IsRequired().Accepts().Values("Foo", "Bar"));
             app.Argument<SomeEnum>("SomeEnumArgument", "enum arg desc.");
             var helpText = GetHelpText(app);
 
@@ -176,6 +177,7 @@ public class MyApp
             public string strOpt { get; set; }
 
             [Option(ShortName = "rStrOpt", Description = "restricted str option desc.")]
+            [Required]
             [AllowedValues("Foo", "Bar")]
             public string rStrOpt { get; set; }
 
@@ -189,6 +191,7 @@ public class MyApp
             public string SomeStringArgument { get; set; }
 
             [Argument(1, Description = "restricted string arg desc.")]
+            [Required]
             [AllowedValues("Foo", "Bar")]
             public string RestrictedStringArgument { get; set; }