dotnet / dotnet/command-line-api
Allow developer to present an abbreviated help screen on user error
- Dominant language
- C#
- Stars
- 3.7k
- Forks
- 428
- PR merge metrics
- No merged PRs in 30d
Description
When the user makes a mistake on an option it outputs the full help-screen after the red-text. This pushes the error out of the screen if you've a long help-screen.
I could customize this behavior in the HelpBuilder, but the HelpBuilder doesn't let me know *why* the user is seeing help. Even just the ability to know if we're showing "Help" because the user made a mistake (in which case an abbreviated "help" and a note to try `appname -?` is sufficient) or if they want the full "Help", in which case it's time to drink from the firehose.
Like if I knew they were seeing help because they missed a required thing or made a typo, I'd skip my options list, which looks like it'd be trivial to do by subclassing HelpBuilder.
Contributor guide
Assessment
This issue has not been assessed yet.