Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fully automatic help #175

Closed
remkop opened this issue Aug 25, 2017 · 1 comment
Closed

Fully automatic help #175

remkop opened this issue Aug 25, 2017 · 1 comment
Labels
type: enhancement ✨
Milestone
3.0

Comments

@remkop
Copy link
Owner

remkop commented Aug 25, 2017 •
edited
Loading

Imagine an autoHelp attribute on the @Command annotation that installs a Help subcommand as well as a mixin with standard usageHelp and versionHelp options.

The help subcommand would show the usage help of the subcommand that follows or (if the help subcommand is the last argument) of the preceding command.

Having a standard mixin with help/version options automatically added is convenient and reduces the annoying IDE warnings that these fields are unused.
@remkop remkop added this to the backlog milestone Aug 25, 2017
@remkop remkop modified the milestones: backlog, 3.0 Dec 20, 2017
@remkop remkop changed the title Add built-in help subcommand that shows help on specified sub-subcommand Fully automatic help Dec 21, 2017
@remkop remkop mentioned this issue Jan 5, 2018
Closed
remkop added a commit that referenced this issue Jan 10, 2018
@remkop
#175 Add support for autohelp @command attribute to conveniently ac…
e3ac945 
…tivate fully automatic help including a help subcommand.
@remkop remkop closed this as completed in 96f783c Jan 11, 2018
@remkop
Copy link
Owner Author

remkop commented Feb 5, 2018

Reopening for further refinement:

  • Rename autoHelp to addHelpOptions
  • addHelpOptions should not mix in the HelpCommand subcommand
  • Make the HelpCommand subcommand public (and final) and document it separately
  • Anything else needed to support custom help subcommands?

@remkop remkop reopened this Feb 5, 2018
remkop added a commit that referenced this issue Feb 6, 2018
@remkop
#175 renamed autoHelp to mixinStandardHelpOptions, separated out Help…
924ead2 
…Command
remkop added a commit that referenced this issue Mar 4, 2018
@remkop
#175 Add interface IHelpCommandInitializable
22d5fc9
@remkop remkop closed this as completed in dce7f74 Mar 4, 2018
remkop added a commit that referenced this issue Mar 4, 2018
@remkop
#175 small user manual improvement
80fad0b
remkop added a commit that referenced this issue Apr 11, 2018
@remkop
[#175] update mixinStandardHelpOptions example to remove help subcommand
532404e
remkop added a commit that referenced this issue Apr 11, 2018
@remkop
[#175] improved javadoc for IHelpCommandInitializable
5da3630
remkop added a commit that referenced this issue Apr 30, 2018
@remkop
#175, #250 improved Groovy and Scala examples to use `mixinStandardHe…
98fede0 
…lpOptions` and `run` method with minimal parameters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: enhancement ✨
Projects
None yet
Milestone
3.0
Development

No branches or pull requests
1 participant
@remkop