commandlineparser / commandlineparser/commandline

Issue when turning off AutoHelp or AutoVersion

Offen
#821 0 Kommentare 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
C#
Sterne
4.8k
Forks
478
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

**Symptom**

When turning off AutoVersion (or AutoHelp) in the `ParserSettings`, the HelpText still announces these commands as being available.

**Root cause**

In the `Parser` Class, the method `MakeParserResult` is called, which may call `DisplayHelp`.

`DisplayHelp` calls `HelpText.AutoBuild`, which creates a HelpText instance with `AutoVersion` and `AutoHelp` always set to `true` no matter which value has been set in the `ParserSettings` instance.

**How to reproduce**

```
public static class Program {

[Verb("do")]
public class Options {
[Option("what")]
public string What { get; set; }
}

static void Main(string args[]){
Parser p = new Parser(s => { s.AutoVersion = false });
ParserResult r = p.Parse(args, typeof(Options));

}
}
```

Calling the project without any options results in a helptext that includes the 'version' command, which is officially turned of.

If the user then calls the application with the version verb, an error is produced, since the version verb is not known.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne damit, Parser.MakeParserResult bis zu DisplayHelp und HelpText.AutoBuild nachzuverfolgen, wobei die ParserSettings-Werte aus der Reproduktion als Ausgangsfall verwendet werden. Reproduziere das Verhalten der generierten Hilfe und des Versionsverbs und überprüfe anschließend, dass deaktivierte AutoHelp- und AutoVersion-Einstellungen in den angezeigten Befehlen konsistent widergespiegelt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
cli
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.