fix: Correctly handle dash count for built-in arguments

MichaeIDietrich · MichaeIDietrich · commit 10432f13f593 · 2022-09-12T10:46:55.000+02:00
diff --git a/src/CommandLine/Core/InstanceBuilder.cs b/src/CommandLine/Core/InstanceBuilder.cs
@@ -22,6 +22,7 @@ public static ParserResult<T> Build<T>(
             CultureInfo parsingCulture,
             bool autoHelp,
             bool autoVersion,
+            OptionsParseMode optionsParseMode,
             IEnumerable<ErrorType> nonFatalErrors)
         {
             return Build(
@@ -34,6 +35,7 @@ public static ParserResult<T> Build<T>(
                 autoHelp,
                 autoVersion,
                 false,
+                optionsParseMode,
                 nonFatalErrors);
         }
 
@@ -47,6 +49,7 @@ public static ParserResult<T> Build<T>(
             bool autoHelp,
             bool autoVersion,
             bool allowMultiInstance,
+            OptionsParseMode optionsParseMode,
             IEnumerable<ErrorType> nonFatalErrors)        {
             var typeInfo = factory.MapValueOrDefault(f => f().GetType(), typeof(T));
 
@@ -137,7 +140,7 @@ public static ParserResult<T> Build<T>(
 
             var preprocessorErrors = (
                     argumentsList.Any()
-                    ? arguments.Preprocess(PreprocessorGuards.Lookup(nameComparer, autoHelp, autoVersion))
+                    ? arguments.Preprocess(PreprocessorGuards.Lookup(nameComparer, autoHelp, autoVersion, optionsParseMode))
                     : Enumerable.Empty<Error>()
                 ).Memoize();
 
diff --git a/src/CommandLine/Core/InstanceChooser.cs b/src/CommandLine/Core/InstanceChooser.cs
@@ -21,6 +21,7 @@ public static ParserResult<object> Choose(
             CultureInfo parsingCulture,
             bool autoHelp,
             bool autoVersion,
+            OptionsParseMode optionsParseMode,
             IEnumerable<ErrorType> nonFatalErrors)
         {
             return Choose(
@@ -33,6 +34,7 @@ public static ParserResult<object> Choose(
                 autoHelp,
                 autoVersion,
                 false,
+                optionsParseMode,
                 nonFatalErrors);
         }
 
@@ -46,6 +48,7 @@ public static ParserResult<object> Choose(
             bool autoHelp,
             bool autoVersion,
             bool allowMultiInstance,
+            OptionsParseMode optionsParseMode,
             IEnumerable<ErrorType> nonFatalErrors)
         {
             var verbs = Verb.SelectFromTypes(types);
@@ -62,22 +65,23 @@ ParserResult<object> choose()
                 var firstArg = arguments.First();
 
                 bool preprocCompare(string command) =>
-                        nameComparer.Equals(command, firstArg) ||
-                        nameComparer.Equals(string.Concat("--", command), firstArg);
+                        nameComparer.Equals(command, firstArg) 
+                        || optionsParseMode != OptionsParseMode.SingleDashOnly && nameComparer.Equals(string.Concat("--", command), firstArg)
+                        || optionsParseMode != OptionsParseMode.Default && nameComparer.Equals(string.Concat("-", command), firstArg);
 
                 return (autoHelp && preprocCompare("help"))
                     ? MakeNotParsed(types,
                         MakeHelpVerbRequestedError(verbs,
                             arguments.Skip(1).FirstOrDefault() ?? string.Empty, nameComparer))
                     : (autoVersion && preprocCompare("version"))
                         ? MakeNotParsed(types, new VersionRequestedError())
-                        : MatchVerb(tokenizer, verbs, defaultVerb, arguments, nameComparer, ignoreValueCase, parsingCulture, autoHelp, autoVersion, allowMultiInstance, nonFatalErrors);
+                        : MatchVerb(tokenizer, verbs, defaultVerb, arguments, nameComparer, ignoreValueCase, parsingCulture, autoHelp, autoVersion, allowMultiInstance, optionsParseMode, nonFatalErrors);
             }
 
             return arguments.Any()
                 ? choose()
                 : (defaultVerbCount == 1
-                    ? MatchDefaultVerb(tokenizer, verbs, defaultVerb, arguments, nameComparer, ignoreValueCase, parsingCulture, autoHelp, autoVersion, nonFatalErrors)
+                    ? MatchDefaultVerb(tokenizer, verbs, defaultVerb, arguments, nameComparer, ignoreValueCase, parsingCulture, autoHelp, autoVersion, optionsParseMode, nonFatalErrors)
                     : MakeNotParsed(types, new NoVerbSelectedError()));
         }
 
@@ -91,6 +95,7 @@ private static ParserResult<object> MatchDefaultVerb(
             CultureInfo parsingCulture,
             bool autoHelp,
             bool autoVersion,
+            OptionsParseMode optionsParseMode,
             IEnumerable<ErrorType> nonFatalErrors)
         {
             return !(defaultVerb is null)
@@ -103,6 +108,7 @@ private static ParserResult<object> MatchDefaultVerb(
                     parsingCulture,
                     autoHelp,
                     autoVersion,
+                    optionsParseMode,
                     nonFatalErrors)
                 : MakeNotParsed(verbs.Select(v => v.Item2), new BadVerbSelectedError(arguments.First()));
         }
@@ -118,6 +124,7 @@ private static ParserResult<object> MatchVerb(
             bool autoHelp,
             bool autoVersion,
             bool allowMultiInstance,
+            OptionsParseMode optionsParseMode,
             IEnumerable<ErrorType> nonFatalErrors)
         {
             string firstArg = arguments.First();
@@ -129,7 +136,7 @@ private static ParserResult<object> MatchVerb(
 
             if (verbUsed == default)
             {
-                return MatchDefaultVerb(tokenizer, verbs, defaultVerb, arguments, nameComparer, ignoreValueCase, parsingCulture, autoHelp, autoVersion, nonFatalErrors);
+                return MatchDefaultVerb(tokenizer, verbs, defaultVerb, arguments, nameComparer, ignoreValueCase, parsingCulture, autoHelp, autoVersion, optionsParseMode, nonFatalErrors);
             }
             return InstanceBuilder.Build(
                 Maybe.Just<Func<object>>(
@@ -141,7 +148,8 @@ private static ParserResult<object> MatchVerb(
                 parsingCulture,
                 autoHelp,
                 autoVersion,
-                allowMultiInstance,                
+                allowMultiInstance,
+                optionsParseMode,
                 nonFatalErrors);
         }
 
diff --git a/src/CommandLine/Core/PreprocessorGuards.cs b/src/CommandLine/Core/PreprocessorGuards.cs
@@ -9,30 +9,31 @@ namespace CommandLine.Core
     static class PreprocessorGuards
     {
         public static IEnumerable<Func<IEnumerable<string>, IEnumerable<Error>>>
-            Lookup(StringComparer nameComparer, bool autoHelp, bool autoVersion)
+            Lookup(StringComparer nameComparer, bool autoHelp, bool autoVersion, OptionsParseMode optionsParseMode)
         {
             var list = new List<Func<IEnumerable<string>, IEnumerable<Error>>>();
             if (autoHelp)
-                list.Add(HelpCommand(nameComparer));
+                list.Add(HelpCommand(nameComparer, optionsParseMode));
             if (autoVersion)
-                list.Add(VersionCommand(nameComparer));
+                list.Add(VersionCommand(nameComparer, optionsParseMode));
             return list;
         }
-
-        public static Func<IEnumerable<string>, IEnumerable<Error>> HelpCommand(StringComparer nameComparer)
+        public static Func<IEnumerable<string>, IEnumerable<Error>> HelpCommand(StringComparer nameComparer, OptionsParseMode optionsParseMode)
         {
             return
                 arguments =>
-                    nameComparer.Equals("--help", arguments.First())
+                    optionsParseMode != OptionsParseMode.SingleDashOnly && nameComparer.Equals("--help", arguments.First())
+                    || optionsParseMode != OptionsParseMode.Default && nameComparer.Equals("-help", arguments.First())
                         ? new Error[] { new HelpRequestedError() }
                         : Enumerable.Empty<Error>();
         }
 
-        public static Func<IEnumerable<string>, IEnumerable<Error>> VersionCommand(StringComparer nameComparer)
+        public static Func<IEnumerable<string>, IEnumerable<Error>> VersionCommand(StringComparer nameComparer, OptionsParseMode optionsParseMode)
         {
             return
                 arguments =>
-                    nameComparer.Equals("--version", arguments.First())
+                    optionsParseMode != OptionsParseMode.SingleDashOnly && nameComparer.Equals("--version", arguments.First())
+                    || optionsParseMode != OptionsParseMode.Default && nameComparer.Equals("-version", arguments.First())
                         ? new Error[] { new VersionRequestedError() }
                         : Enumerable.Empty<Error>();
         }
diff --git a/src/CommandLine/Parser.cs b/src/CommandLine/Parser.cs
@@ -102,6 +102,7 @@ public ParserResult<T> ParseArguments<T>(IEnumerable<string> args)
                     settings.AutoHelp,
                     settings.AutoVersion,
                     settings.AllowMultiInstance,
+                    settings.OptionsParseMode,
                     HandleUnknownArguments(settings.IgnoreUnknownArguments)),
                 settings);
         }
@@ -133,6 +134,7 @@ public ParserResult<T> ParseArguments<T>(Func<T> factory, IEnumerable<string> ar
                     settings.AutoHelp,
                     settings.AutoVersion,
                     settings.AllowMultiInstance,
+                    settings.OptionsParseMode,
                     HandleUnknownArguments(settings.IgnoreUnknownArguments)),
                 settings);
         }
@@ -166,6 +168,7 @@ public ParserResult<object> ParseArguments(IEnumerable<string> args, params Type
                     settings.AutoHelp,
                     settings.AutoVersion,
                     settings.AllowMultiInstance,
+                    settings.OptionsParseMode,
                     HandleUnknownArguments(settings.IgnoreUnknownArguments)),
                 settings);
         }
diff --git a/tests/CommandLine.Tests/Unit/Core/InstanceBuilderTests.cs b/tests/CommandLine.Tests/Unit/Core/InstanceBuilderTests.cs
@@ -19,7 +19,7 @@ namespace CommandLine.Tests.Unit.Core
 {
     public class InstanceBuilderTests
     {
-        private static ParserResult<T> InvokeBuild<T>(string[] arguments, bool autoHelp = true, bool autoVersion = true, bool multiInstance = false)
+        private static ParserResult<T> InvokeBuild<T>(string[] arguments, bool autoHelp = true, bool autoVersion = true, bool multiInstance = false, OptionsParseMode optionsParseMode = OptionsParseMode.Default)
             where T : new()
         {
             return InstanceBuilder.Build(
@@ -32,6 +32,7 @@ private static ParserResult<T> InvokeBuild<T>(string[] arguments, bool autoHelp
                 autoHelp,
                 autoVersion,
                 multiInstance,
+                optionsParseMode,
                 Enumerable.Empty<ErrorType>());
         }
 
@@ -47,6 +48,7 @@ private static ParserResult<T> InvokeBuildEnumValuesCaseIgnore<T>(string[] argum
                 CultureInfo.InvariantCulture,
                 true,
                 true,
+                OptionsParseMode.Default,
                 Enumerable.Empty<ErrorType>());
         }
 
@@ -61,6 +63,7 @@ private static ParserResult<T> InvokeBuildImmutable<T>(string[] arguments)
                 CultureInfo.InvariantCulture,
                 true,
                 true,
+                OptionsParseMode.Default,
                 Enumerable.Empty<ErrorType>());
         }
 
@@ -421,6 +424,7 @@ public void Double_dash_force_subsequent_arguments_as_values()
                 CultureInfo.InvariantCulture,
                 true,
                 true,
+                OptionsParseMode.Default,
                 Enumerable.Empty<ErrorType>());
 
             // Verify outcome
@@ -1263,6 +1267,43 @@ public void Parse_int_sequence_with_multi_instance()
 
             ((Parsed<Options_With_Sequence>)result).Value.IntSequence.Should().BeEquivalentTo(expected);
         }
+        
+        [Theory]
+        [InlineData("-help", OptionsParseMode.SingleDashOnly)]
+        [InlineData("-help", OptionsParseMode.SingleOrDoubleDash)]
+        [InlineData("--help", OptionsParseMode.Default)]
+        [InlineData("--help", OptionsParseMode.SingleOrDoubleDash)]
+        public void Parse_Built_In_Help_Argument(string argument, OptionsParseMode optionsParseMode)
+        {
+            var result = InvokeBuild<Simple_Options>(new[] { argument }, optionsParseMode: optionsParseMode);
+
+            result.Errors.Single().Should().BeOfType<HelpRequestedError>();
+        }
+
+        [Theory]
+        [InlineData("-version", OptionsParseMode.SingleDashOnly)]
+        [InlineData("-version", OptionsParseMode.SingleOrDoubleDash)]
+        [InlineData("--version", OptionsParseMode.Default)]
+        [InlineData("--version", OptionsParseMode.SingleOrDoubleDash)]
+        public void Parse_Built_In_Version_Argument(string argument, OptionsParseMode optionsParseMode)
+        {
+            var result = InvokeBuild<Simple_Options>(new[] { argument }, optionsParseMode: optionsParseMode);
+
+            result.Errors.Single().Should().BeOfType<VersionRequestedError>();
+        }
+
+        [Theory]
+        [InlineData("-help", OptionsParseMode.Default)]
+        [InlineData("--help", OptionsParseMode.SingleDashOnly)]
+        [InlineData("-version", OptionsParseMode.Default)]
+        [InlineData("--version", OptionsParseMode.SingleDashOnly)]
+        public void Parse_Invalid_Built_In_Argument(string argument, OptionsParseMode optionsParseMode)
+        {
+            var result = InvokeBuild<Simple_Options>(new[] { argument }, optionsParseMode: optionsParseMode);
+
+            result.Errors.Should().NotBeOfType<HelpVerbRequestedError>()
+                .And.Should().NotBeOfType<VersionRequestedError>();
+        }
 
         #region custom types 
        
diff --git a/tests/CommandLine.Tests/Unit/Core/InstanceChooserTests.cs b/tests/CommandLine.Tests/Unit/Core/InstanceChooserTests.cs
@@ -16,7 +16,8 @@ public class InstanceChooserTests
         private static ParserResult<object> InvokeChoose(
             IEnumerable<Type> types,
             IEnumerable<string> arguments,
-            bool multiInstance = false)
+            bool multiInstance = false,
+            OptionsParseMode optionsParseMode = OptionsParseMode.Default)
         {
             return InstanceChooser.Choose(
                 (args, optionSpecs) => Tokenizer.ConfigureTokenizer(StringComparer.Ordinal, false, false)(args, optionSpecs),
@@ -28,6 +29,7 @@ private static ParserResult<object> InvokeChoose(
                 true,
                 true,
                 multiInstance,
+                optionsParseMode,
                 Enumerable.Empty<ErrorType>());
         }
 
@@ -183,5 +185,60 @@ public void Parse_sequence_verb_with_multi_instance_returns_verb_instance()
             Assert.IsType<SequenceOptions>(((Parsed<object>)result).Value);
             expected.Should().BeEquivalentTo(((Parsed<object>)result).Value);
         }
+
+        [Theory]
+        [InlineData("help", OptionsParseMode.Default)]
+        [InlineData("help", OptionsParseMode.SingleDashOnly)]
+        [InlineData("help", OptionsParseMode.SingleOrDoubleDash)]
+        [InlineData("-help", OptionsParseMode.SingleDashOnly)]
+        [InlineData("-help", OptionsParseMode.SingleOrDoubleDash)]
+        [InlineData("--help", OptionsParseMode.Default)]
+        [InlineData("--help", OptionsParseMode.SingleOrDoubleDash)]
+        public void Parse_Built_In_Help_Argument(string argument, OptionsParseMode optionsParseMode)
+        {
+            var result = InvokeChoose(
+                Type.EmptyTypes,
+                new[] { argument },
+                true,
+                optionsParseMode);
+
+            result.Errors.Single().Should().BeOfType<HelpVerbRequestedError>();
+        }
+
+        [Theory]
+        [InlineData("version", OptionsParseMode.Default)]
+        [InlineData("version", OptionsParseMode.SingleDashOnly)]
+        [InlineData("version", OptionsParseMode.SingleOrDoubleDash)]
+        [InlineData("-version", OptionsParseMode.SingleDashOnly)]
+        [InlineData("-version", OptionsParseMode.SingleOrDoubleDash)]
+        [InlineData("--version", OptionsParseMode.Default)]
+        [InlineData("--version", OptionsParseMode.SingleOrDoubleDash)]
+        public void Parse_Built_In_Version_Argument(string argument, OptionsParseMode optionsParseMode)
+        {
+            var result = InvokeChoose(
+                Type.EmptyTypes,
+                new[] { argument },
+                true,
+                optionsParseMode);
+
+            result.Errors.Single().Should().BeOfType<VersionRequestedError>();
+        }
+
+        [Theory]
+        [InlineData("-help", OptionsParseMode.Default)]
+        [InlineData("--help", OptionsParseMode.SingleDashOnly)]
+        [InlineData("-version", OptionsParseMode.Default)]
+        [InlineData("--version", OptionsParseMode.SingleDashOnly)]
+        public void Parse_Invalid_Built_In_Argument(string argument, OptionsParseMode optionsParseMode)
+        {
+            var result = InvokeChoose(
+                Type.EmptyTypes,
+                new[] { argument },
+                true,
+                optionsParseMode);
+
+            result.Errors.Single().Should().NotBeOfType<HelpVerbRequestedError>()
+                .And.Should().NotBeOfType<VersionRequestedError>();
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -9,30 +9,31 @@ namespace CommandLine.Core`
`9`	`9`	`static class PreprocessorGuards`
`10`	`10`	`{`
`11`	`11`	`public static IEnumerable<Func<IEnumerable<string>, IEnumerable<Error>>>`
`12`		`- Lookup(StringComparer nameComparer, bool autoHelp, bool autoVersion)`
	`12`	`+ Lookup(StringComparer nameComparer, bool autoHelp, bool autoVersion, OptionsParseMode optionsParseMode)`
`13`	`13`	`{`
`14`	`14`	`var list = new List<Func<IEnumerable<string>, IEnumerable<Error>>>();`
`15`	`15`	`if (autoHelp)`
`16`		`- list.Add(HelpCommand(nameComparer));`
	`16`	`+ list.Add(HelpCommand(nameComparer, optionsParseMode));`
`17`	`17`	`if (autoVersion)`
`18`		`- list.Add(VersionCommand(nameComparer));`
	`18`	`+ list.Add(VersionCommand(nameComparer, optionsParseMode));`
`19`	`19`	`return list;`
`20`	`20`	`}`
`21`		`-`
`22`		`- public static Func<IEnumerable<string>, IEnumerable<Error>> HelpCommand(StringComparer nameComparer)`
	`21`	`+ public static Func<IEnumerable<string>, IEnumerable<Error>> HelpCommand(StringComparer nameComparer, OptionsParseMode optionsParseMode)`
`23`	`22`	`{`
`24`	`23`	`return`
`25`	`24`	`arguments =>`
`26`		`- nameComparer.Equals("--help", arguments.First())`
	`25`	`+ optionsParseMode != OptionsParseMode.SingleDashOnly && nameComparer.Equals("--help", arguments.First())`
	`26`	`+ \|\| optionsParseMode != OptionsParseMode.Default && nameComparer.Equals("-help", arguments.First())`
`27`	`27`	`? new Error[] { new HelpRequestedError() }`
`28`	`28`	`: Enumerable.Empty<Error>();`
`29`	`29`	`}`
`30`	`30`
`31`		`- public static Func<IEnumerable<string>, IEnumerable<Error>> VersionCommand(StringComparer nameComparer)`
	`31`	`+ public static Func<IEnumerable<string>, IEnumerable<Error>> VersionCommand(StringComparer nameComparer, OptionsParseMode optionsParseMode)`
`32`	`32`	`{`
`33`	`33`	`return`
`34`	`34`	`arguments =>`
`35`		`- nameComparer.Equals("--version", arguments.First())`
	`35`	`+ optionsParseMode != OptionsParseMode.SingleDashOnly && nameComparer.Equals("--version", arguments.First())`
	`36`	`+ \|\| optionsParseMode != OptionsParseMode.Default && nameComparer.Equals("-version", arguments.First())`
`36`	`37`	`? new Error[] { new VersionRequestedError() }`
`37`	`38`	`: Enumerable.Empty<Error>();`
`38`	`39`	`}`