Don't show hints for hidden args (#66)

Author: reubeno

src/NClap/Parser/ArgumentSetDefinition.cs

@@ -91,7 +91,26 @@ private ArgumentSetDefinition(ArgumentSetDefinition template) : this(template.At
         /// Enumerates all names of named arguments (of all name types).
         /// </summary>
         /// <returns>Enumeration.</returns>
-        public IEnumerable<string> GetAllArgumentNames() => _namedArgumentsByName.Keys;
+        public IEnumerable<string> GetAllArgumentNames() => GetAllArgumentNames(includeHiddenArguments: true);
+
+        /// <summary>
+        /// Enumerates all names of named arguments (of all name types), possibly excluding
+        /// hidden arguments.
+        /// </summary>
+        /// <param name="includeHiddenArguments">true to include names for hidden arguments; false to
+        /// exclude them.</param>
+        /// <returns>Enumeration.</returns>
+        internal IEnumerable<string> GetAllArgumentNames(bool includeHiddenArguments)
+        {
+            IEnumerable<KeyValuePair<string, ArgumentDefinition>> namePairs = _namedArgumentsByName;
+
+            if (!includeHiddenArguments)
+            {
+                namePairs = namePairs.Where(keyValue => !keyValue.Value.Hidden);
+            }
+
+            return namePairs.Select(keyValue => keyValue.Key);
+        }
 
         /// <summary>
         /// Enumerates named arguments of the given type.

src/NClap/Parser/ArgumentSetParser.cs

@@ -707,9 +707,9 @@ private void ReportLine(string message, params object[] args)
                 }));
         }
 
-        private IEnumerable<string> GetSimilarNamedArguments(ArgumentNameType? type, string name)
+        private IEnumerable<string> GetSimilarNamedArguments(ArgumentNameType? type, string name, bool includeHiddenArguments = false)
         {
-            var candidates = ArgumentSet.GetAllArgumentNames();
+            var candidates = ArgumentSet.GetAllArgumentNames(includeHiddenArguments: includeHiddenArguments);
             var prefix = string.Empty;
 
             if (type.HasValue)

src/Tests/UnitTests/Parser/ArgumentSetDefinitionTests.cs

@@ -38,15 +38,18 @@ public void TestThatArgumentNamesAreRetrievableFromSet()
             var set = DefineArgSet(new ArgumentBaseAttribute[]
                 {
                     new NamedArgumentAttribute { ShortName = "short", LongName = "foo" },
-                    new NamedArgumentAttribute { ShortName = "S", LongName = "LONG" }
+                    new NamedArgumentAttribute { ShortName = "S", LongName = "LONG" },
+                    new NamedArgumentAttribute { ShortName = "h", LongName = "Hidden", Hidden = true }
                 });
 
-            set.GetArgumentNames(ArgumentNameType.ShortName).Should().BeEquivalentTo("short", "S");
-            set.GetArgumentNames(ArgumentNameType.LongName).Should().BeEquivalentTo("foo", "LONG");
+            set.GetArgumentNames(ArgumentNameType.ShortName).Should().BeEquivalentTo("short", "S", "h");
+            set.GetArgumentNames(ArgumentNameType.LongName).Should().BeEquivalentTo("foo", "LONG", "Hidden");
             set.Invoking(s => s.GetArgumentNames((ArgumentNameType)0x1000))
                 .Should().Throw<ArgumentOutOfRangeException>();
 
-            set.GetAllArgumentNames().Should().BeEquivalentTo("short", "S", "foo", "LONG");
+            set.GetAllArgumentNames().Should().BeEquivalentTo("short", "S", "h", "foo", "LONG", "Hidden");
+            set.GetAllArgumentNames(includeHiddenArguments: true).Should().BeEquivalentTo("short", "S", "h", "foo", "LONG", "Hidden");
+            set.GetAllArgumentNames(includeHiddenArguments: false).Should().BeEquivalentTo("short", "S", "foo", "LONG");
         }
 
         private ArgumentDefinition DefineArg(ArgumentSetDefinition set, ArgumentBaseAttribute argAttrib) =>