Repository navigation
Open
Description
This library should not return a non-zero exit code for the default supported verbs and options:
- help
- version
- --help
- --version
using System;
using CommandLine;
public class Program
{
[Verb("add", HelpText = "Add file contents to the index.")]
class AddOptions
{
[Option(Default = false, HelpText = "Prints all messages to standard output.")]
public bool Verbose { get; set; }
}
[Verb("commit", HelpText = "Record changes to the repository.")]
class CommitOptions
{
}
static int Main(string[] args)
{
var exitCode = Parser.Default.ParseArguments<AddOptions, CommitOptions>(args)
.MapResult(
(AddOptions opts) => 0,
(CommitOptions opts) => 0,
errs => 1
);
Console.WriteLine($"exitCode = {exitCode}");
return exitCode;
}
}Executing this code results in the following outputs:
> ConsoleApp1.exe version
ConsoleApp1 1.0.0.0
exitCode = 1
> ConsoleApp1.exe help
ConsoleApp1 1.0.0.0
Copyright c 2022
add Add file contents to the index.
commit Record changes to the repository.
help Display more information on a specific command.
version Display version information.
exitCode = 1
> ConsoleApp1.exe --version
ConsoleApp1 1.0.0.0
exitCode = 1
> ConsoleApp1.exe --help
ConsoleApp1 1.0.0.0
Copyright c 2022
add Add file contents to the index.
commit Record changes to the repository.
help Display more information on a specific command.
version Display version information.
exitCode = 1
> ConsoleApp1.exe help add
ConsoleApp1 1.0.0.0
Copyright c 2022
--verbose (Default: false) Prints all messages to standard output.
--help Display this help screen.
--version Display version information.
exitCode = 1
> ConsoleApp1.exe add --version
ConsoleApp1 1.0.0.0
exitCode = 1
> ConsoleApp1.exe add --help
ConsoleApp1 1.0.0.0
Copyright c 2022
--verbose (Default: false) Prints all messages to standard output.
--help Display this help screen.
--version Display version information.
exitCode = 1
As far as I can tell, those errors can be handled by the consumer as in your code example or by doing it like suggested in #660.
However, since those verbs/options are supported they should not result in an error and therefore also should not require to be handled by the consumer.
Reacted by BADF00D, dalenewman, Henri Hyyryläinen, Bo Lingen, Arturo Molina, Alex Sonneveld and Marco Pelegrini
Metadata
Metadata
Assignees
Labels
No labels
Activity
I3urny commentedon Sep 4, 2022
Right, so I took a closer look at the code:
The biggest problem is that
.MapResultdoes not necessarily return an integer but rather a generic type meaning that the library cannot always set an appropriate default value to return for help/version. Returning the default value of a type via thedefaultliteral would suffice in my case but that does not necessarily apply to other programs that for example use a custom integer, string or boolean.Rather, the consumer would have to define a return value for help/version and at that point there is not much of a difference between setting a value for those verbs/options or handling the error in a custom function.
Unless the maintainers of this project want the
.MapResultmethod to return the default value of the specified type, we will have to handle the "errors" caused by help/version ourselves.marcopelegrini commentedon Aug 29, 2024
This behaviour is very weird, no stablished command line I know would return != for version/help options