Merge pull request #324 from CreepyGnome/Issue263

nemec · web-flow · commit 6acf8e60a7a4 · 2016-07-27T14:16:56.000-05:00
Implemented Hidden Verbs, Options and Values
diff --git a/src/CommandLine/BaseAttribute.cs b/src/CommandLine/BaseAttribute.cs
@@ -123,5 +123,14 @@ public string MetaValue
                 metaValue = value;
             }
         }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether a command line option is visible in the help text.
+        /// </summary>
+        public bool Hidden
+        {
+            get;
+            set;
+        }
     }
 }
diff --git a/src/CommandLine/Core/OptionSpecification.cs b/src/CommandLine/Core/OptionSpecification.cs
@@ -16,8 +16,8 @@ sealed class OptionSpecification : Specification
 
         public OptionSpecification(string shortName, string longName, bool required, string setName, Maybe<int> min, Maybe<int> max,
             char separator, Maybe<object> defaultValue, string helpText, string metaValue, IEnumerable<string> enumValues,
-            Type conversionType, TargetType targetType)
-            : base(SpecificationType.Option, required, min, max, defaultValue, helpText, metaValue, enumValues, conversionType, targetType)
+            Type conversionType, TargetType targetType, bool hidden = false)
+            : base(SpecificationType.Option, required, min, max, defaultValue, helpText, metaValue, enumValues, conversionType, targetType, hidden)
         {
             this.shortName = shortName;
             this.longName = longName;
@@ -40,13 +40,14 @@ public static OptionSpecification FromAttribute(OptionAttribute attribute, Type
                 attribute.MetaValue,
                 enumValues,
                 conversionType,
-                conversionType.ToTargetType());
+                conversionType.ToTargetType(),
+                attribute.Hidden);
         }
 
-        public static OptionSpecification NewSwitch(string shortName, string longName, bool required, string helpText, string metaValue)
+        public static OptionSpecification NewSwitch(string shortName, string longName, bool required, string helpText, string metaValue, bool hidden = false)
         {
             return new OptionSpecification(shortName, longName, required, string.Empty, Maybe.Nothing<int>(), Maybe.Nothing<int>(),
-                '\0', Maybe.Nothing<object>(), helpText, metaValue, Enumerable.Empty<string>(), typeof(bool), TargetType.Switch);
+                '\0', Maybe.Nothing<object>(), helpText, metaValue, Enumerable.Empty<string>(), typeof(bool), TargetType.Switch, hidden);
         }
 
         public string ShortName
diff --git a/src/CommandLine/Core/Specification.cs b/src/CommandLine/Core/Specification.cs
@@ -25,6 +25,7 @@ abstract class Specification
     {
         private readonly SpecificationType tag;
         private readonly bool required;
+        private readonly bool hidden;
         private readonly Maybe<int> min;
         private readonly Maybe<int> max;
         private readonly Maybe<object> defaultValue;
@@ -37,7 +38,7 @@ abstract class Specification
 
         protected Specification(SpecificationType tag, bool required, Maybe<int> min, Maybe<int> max,
             Maybe<object> defaultValue, string helpText, string metaValue, IEnumerable<string> enumValues,
-            Type conversionType, TargetType targetType)
+            Type conversionType, TargetType targetType, bool hidden = false)
         {
             this.tag = tag;
             this.required = required;
@@ -49,6 +50,7 @@ protected Specification(SpecificationType tag, bool required, Maybe<int> min, Ma
             this.helpText = helpText;
             this.metaValue = metaValue;
             this.enumValues = enumValues;
+            this.hidden = hidden;
         }
 
         public SpecificationType Tag 
@@ -101,6 +103,11 @@ public TargetType TargetType
             get { return targetType; }
         }
 
+        public bool Hidden
+        {
+            get { return hidden; }
+        }
+
         public static Specification FromProperty(PropertyInfo property)
         {       
             var attrs = property.GetCustomAttributes(true);
diff --git a/src/CommandLine/Core/SpecificationExtensions.cs b/src/CommandLine/Core/SpecificationExtensions.cs
@@ -33,7 +33,8 @@ public static OptionSpecification WithLongName(this OptionSpecification specific
                 specification.MetaValue,
                 specification.EnumValues,
                 specification.ConversionType,
-                specification.TargetType);
+                specification.TargetType,
+                specification.Hidden);
         }
 
         public static string UniqueName(this OptionSpecification specification)
diff --git a/src/CommandLine/Core/ValueSpecification.cs b/src/CommandLine/Core/ValueSpecification.cs
@@ -13,8 +13,8 @@ sealed class ValueSpecification : Specification
 
         public ValueSpecification(int index, string metaName, bool required, Maybe<int> min, Maybe<int> max, Maybe<object> defaultValue,
             string helpText, string metaValue, IEnumerable<string> enumValues,
-            Type conversionType, TargetType targetType)
-            : base(SpecificationType.Value, required, min, max, defaultValue, helpText, metaValue, enumValues, conversionType, targetType)
+            Type conversionType, TargetType targetType, bool hidden = false)
+            : base(SpecificationType.Value, required, min, max, defaultValue, helpText, metaValue, enumValues, conversionType, targetType, hidden)
         {
             this.index = index;
             this.metaName = metaName;
@@ -33,7 +33,8 @@ public static ValueSpecification FromAttribute(ValueAttribute attribute, Type co
                 attribute.MetaValue,
                 enumValues,
                 conversionType,
-                conversionType.ToTargetType());
+                conversionType.ToTargetType(),
+                attribute.Hidden);
         }
 
         public int Index
diff --git a/src/CommandLine/Core/Verb.cs b/src/CommandLine/Core/Verb.cs
@@ -10,14 +10,16 @@ sealed class Verb
     {
         private readonly string name;
         private readonly string helpText;
+        private readonly bool hidden;
 
-        public Verb(string name, string helpText)
+        public Verb(string name, string helpText, bool hidden = false)
         {
             if (name == null) throw new ArgumentNullException("name");
             if (helpText == null) throw new ArgumentNullException("helpText");
 
             this.name = name;
             this.helpText = helpText;
+            this.hidden = hidden;
         }
 
         public string Name
@@ -30,11 +32,17 @@ public string HelpText
             get { return helpText; }
         }
 
+        public bool Hidden
+        {
+            get { return hidden; }
+        }
+
         public static Verb FromAttribute(VerbAttribute attribute)
         {
             return new Verb(
                 attribute.Name,
-                attribute.HelpText
+                attribute.HelpText,
+                attribute.Hidden
                 );
         }
 
diff --git a/src/CommandLine/Text/HelpText.cs b/src/CommandLine/Text/HelpText.cs
@@ -683,7 +683,8 @@ private IEnumerable<Specification> AdaptVerbsToSpecifications(IEnumerable<Type>
                             verbTuple.Item1.Name,
                             false,
                             verbTuple.Item1.HelpText,
-                            string.Empty)).Concat(new[] { MakeHelpEntry(), MakeVersionEntry() });
+                            string.Empty,
+                            verbTuple.Item1.Hidden)).Concat(new[] { MakeHelpEntry(), MakeVersionEntry() });
         }
 
         private HelpText AddOptionsImpl(
@@ -711,7 +712,8 @@ private OptionSpecification MakeHelpEntry()
                 "help",
                 false,
                 sentenceBuilder.HelpCommandText(AddDashesToOption),
-                string.Empty);
+                string.Empty,
+                false);
         }
 
         private OptionSpecification MakeVersionEntry()
@@ -721,7 +723,8 @@ private OptionSpecification MakeVersionEntry()
                 "version",
                 false,
                 sentenceBuilder.VersionCommandText(AddDashesToOption),
-                string.Empty);
+                string.Empty,
+                false);
         }
 
         private HelpText AddPreOptionsLine(string value, int maximumLength)
@@ -733,6 +736,9 @@ private HelpText AddPreOptionsLine(string value, int maximumLength)
 
         private HelpText AddOption(string requiredWord, int maxLength, Specification specification, int widthOfHelpText)
         {
+            if (specification.Hidden)
+                return this;
+
             optionsHelp.Append("  ");
             var name = new StringBuilder(maxLength)
                 .BimapIf(
@@ -841,13 +847,15 @@ private int GetMaxLength(IEnumerable<Specification> specifications)
         {
             return specifications.Aggregate(0,
                 (length, spec) =>
-                    {
-                        var specLength = spec.Tag == SpecificationType.Option
+                {
+                    if (spec.Hidden)
+                        return length;
+                    var specLength = spec.Tag == SpecificationType.Option
                             ? GetMaxOptionLength((OptionSpecification)spec)
                             : GetMaxValueLength((ValueSpecification)spec);
 
-                        return Math.Max(length, specLength);
-                    });
+                    return Math.Max(length, specLength);
+                });
         }
 
 
diff --git a/src/CommandLine/VerbAttribute.cs b/src/CommandLine/VerbAttribute.cs
@@ -34,6 +34,15 @@ public string Name
             get { return name; }
         }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether a command line verb is visible in the help text.
+        /// </summary>
+        public bool Hidden
+        {
+            get;
+            set;
+        }
+
         /// <summary>
         /// Gets or sets a short description of this command line option. Usually a sentence summary. 
         /// </summary>
diff --git a/tests/CommandLine.Tests/Fakes/Help_Fakes.cs b/tests/CommandLine.Tests/Fakes/Help_Fakes.cs
@@ -2,6 +2,7 @@
 
 using System.Collections.Generic;
 using CommandLine.Text;
+using Microsoft.FSharp.Collections;
 
 namespace CommandLine.Tests.Fakes
 {
@@ -12,6 +13,9 @@ class Simple_Options_Without_HelpText
 
         [Option("input-file")]
         public string FileName { get; set; }
+
+        [Option("secert-option", Hidden = true, HelpText = "This is a description for a secert hidden option that should never be visibile to the user via help text.")]
+        public string SecertOption { get; set; }
     }
 
     class Simple_Options_With_HelpText_Set
@@ -21,6 +25,9 @@ class Simple_Options_With_HelpText_Set
 
         [Option('i', "input-file", Required = true, HelpText = "Specify input file to be processed.")]
         public string FileName { get; set; }
+
+        [Option("secert-option", Hidden = true, HelpText = "This is a description for a secert hidden option that should never be visibile to the user via help text.")]
+        public string SecertOption { get; set; }
     }
 
     class Simple_Options_With_HelpText_Set_To_Long_Description
@@ -30,6 +37,9 @@ class Simple_Options_With_HelpText_Set_To_Long_Description
 
         [Option("input-file", HelpText = "This is a very long description of the Input File argument that gets passed in.  It should  be passed in as a string.")]
         public string FileName { get; set; }
+
+        [Option("secert-option", Hidden =  true, HelpText = "This is a description for a secert hidden option that should never be visibile to the user via help text.")]
+        public string SecertOption { get; set; }
     }
 
     class Simple_Options_With_HelpText_Set_To_Long_Description_Without_Spaces
@@ -39,6 +49,9 @@ class Simple_Options_With_HelpText_Set_To_Long_Description_Without_Spaces
 
         [Option("input-file", HelpText = "Before 012345678901234567890123456789 After")]
         public string FileName { get; set; }
+
+        [Option("secert-option", Hidden = true, HelpText = "This is a description for a secert hidden option that should never be visibile to the user via help text.")]
+        public string SecertOption { get; set; }
     }
 
     class Options_With_Usage_Attribute
@@ -64,6 +77,9 @@ class Options_With_Usage_Attribute
         [Value(0, HelpText = "Value.")]
         public string Value { get; set; }
 
+        [Option("secert-option", Hidden = true, HelpText = "This is a description for a secert hidden option that should never be visibile to the user via help text.")]
+        public string SecertOption { get; set; }
+
         [Usage(ApplicationAlias = "mono testapp.exe")]
         public static IEnumerable<Example> Examples
         {
@@ -78,6 +94,16 @@ public static IEnumerable<Example> Examples
         }
     }
 
+    [Verb("secert", Hidden = true, HelpText = "This is a secert hidden verb that should never be visible to the user via help text.")]
+    public class Secert_Verb
+    {
+        [Option('f', "force", SetName = "mode-f", HelpText = "Allow adding otherwise ignored files.")]
+        public bool Force { get; set; }
+
+        [Option("secert-option", Hidden = true, HelpText = "This is a description for a secert hidden option that should never be visibile to the user via help text.")]
+        public string SecertOption { get; set; }
+    }
+
     [Verb("add", HelpText = "Add file contents to the index.")]
     public class Add_Verb_With_Usage_Attribute
     {
@@ -92,6 +118,9 @@ public class Add_Verb_With_Usage_Attribute
         [Value(0)]
         public string FileName { get; set; }
 
+        [Option("secert-option", Hidden = true, HelpText = "This is a description for a secert hidden option that should never be visibile to the user via help text.")]
+        public string SecertOption { get; set; }
+
         [Usage(ApplicationAlias = "git")]
         public static IEnumerable<Example> Examples
         {
@@ -112,6 +141,9 @@ public class Commit_Verb_With_Usage_Attribute
         [Option("amend", HelpText = "Used to amend the tip of the current branch.")]
         public bool Amend { get; set; }
 
+        [Option("secert-option", Hidden = true, HelpText = "This is a description for a secert hidden option that should never be visibile to the user via help text.")]
+        public string SecertOption { get; set; }
+
         [Usage(ApplicationAlias = "git")]
         public static IEnumerable<Example> Examples
         {
@@ -133,6 +165,9 @@ public class Clone_Verb_With_Usage_Attribute
             HelpText = "Suppress summary message.")]
         public bool Quiet { get; set; }
 
+        [Option("secert-option", Hidden = true, HelpText = "This is a description for a secert hidden option that should never be visibile to the user via help text.")]
+        public string SecertOption { get; set; }
+
         [Value(0, MetaName = "URLS",
             HelpText = "A list of url(s) to clone.")]
         public IEnumerable<string> Urls { get; set; }
diff --git a/tests/CommandLine.Tests/Unit/ParserTests.cs b/tests/CommandLine.Tests/Unit/ParserTests.cs
diff --git a/tests/CommandLine.Tests/Unit/Text/HelpTextTests.cs b/tests/CommandLine.Tests/Unit/Text/HelpTextTests.cs

Original file line number	Diff line number	Diff line change
`@@ -123,5 +123,14 @@ public string MetaValue`
`123`	`123`	`metaValue = value;`
`124`	`124`	`}`
`125`	`125`	`}`
	`126`	`+`
	`127`	`+ /// <summary>`
	`128`	`+ /// Gets or sets a value indicating whether a command line option is visible in the help text.`
	`129`	`+ /// </summary>`
	`130`	`+ public bool Hidden`
	`131`	`+ {`
	`132`	`+ get;`
	`133`	`+ set;`
	`134`	`+ }`
`126`	`135`	`}`
`127`	`136`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,8 @@ public static OptionSpecification WithLongName(this OptionSpecification specific`
`33`	`33`	`specification.MetaValue,`
`34`	`34`	`specification.EnumValues,`
`35`	`35`	`specification.ConversionType,`
`36`		`- specification.TargetType);`
	`36`	`+ specification.TargetType,`
	`37`	`+ specification.Hidden);`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`public static string UniqueName(this OptionSpecification specification)`
Original file line number	Diff line number	Diff line change
`@@ -10,14 +10,16 @@ sealed class Verb`
`10`	`10`	`{`
`11`	`11`	`private readonly string name;`
`12`	`12`	`private readonly string helpText;`
	`13`	`+ private readonly bool hidden;`
`13`	`14`
`14`		`- public Verb(string name, string helpText)`
	`15`	`+ public Verb(string name, string helpText, bool hidden = false)`
`15`	`16`	`{`
`16`	`17`	`if (name == null) throw new ArgumentNullException("name");`
`17`	`18`	`if (helpText == null) throw new ArgumentNullException("helpText");`
`18`	`19`
`19`	`20`	`this.name = name;`
`20`	`21`	`this.helpText = helpText;`
	`22`	`+ this.hidden = hidden;`
`21`	`23`	`}`
`22`	`24`
`23`	`25`	`public string Name`
`@@ -30,11 +32,17 @@ public string HelpText`
`30`	`32`	`get { return helpText; }`
`31`	`33`	`}`
`32`	`34`
	`35`	`+ public bool Hidden`
	`36`	`+ {`
	`37`	`+ get { return hidden; }`
	`38`	`+ }`
	`39`	`+`
`33`	`40`	`public static Verb FromAttribute(VerbAttribute attribute)`
`34`	`41`	`{`
`35`	`42`	`return new Verb(`
`36`	`43`	`attribute.Name,`
`37`		`- attribute.HelpText`
	`44`	`+ attribute.HelpText,`
	`45`	`+ attribute.Hidden`
`38`	`46`	`);`
`39`	`47`	`}`
`40`	`48`