commandlineparser / commandlineparser/commandline

Enum list options not displayed in help text

Open
#893 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
4.8k
Forks
478
PR merge metrics
No merged PRs in 30d

Description

Apologies if this question/bug was already open

**Describe the bug**
The property: `HelpText.AddenumValuesToHelpText` does not work when the option is of type `IEnummerable<{Enum}>`. I'm guessing the list is masking the fact that its containing an enum.

Is it possible to have the same `Valid values: {enum values}` in the help text to be displayed when its a list of enums?

**To Reproduce**
1. Create an option of type `IEnummerable<{Enum}>`
2. configure a parser as follows:
```cs
var parser = new Parser(with =>
{
with.CaseInsensitiveEnumValues = true;
with.HelpWriter = null;
with.AutoVersion = false;
});

var parserResult = parser.ParseArguments(args.SplitArgs());
parserResult
.WithNotParsed(_ =>
{
var helpText = HelpText.AutoBuild(parserResult, h =>
{
h.AutoVersion = false;
h.Heading = string.Empty;
h.Copyright = string.Empty;
h.AddEnumValuesToHelpText = true;

return h;
});
Console.WriteLine(helpText);
});
```
3. use the --help to find no `Valid values: {enum values}` in the help text.

**Expected behavior**
I expected a list of enums to still show available options

**Screenshots**
![image](https://github.com/commandlineparser/commandline/assets/19995485/94050f9a-7496-4bed-b8ac-ae4f2add7953)
![image](https://github.com/commandlineparser/commandline/assets/19995485/ba77ab82-42cd-43a0-a052-2185c3b80ba7)
![image](https://github.com/commandlineparser/commandline/assets/19995485/6c465d85-404a-474c-8c48-810620fdd025)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.