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.

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

Support customizable user help format. #32

Closed
remkop opened this issue Feb 11, 2017 · 0 comments
Closed

Support customizable user help format. #32

remkop opened this issue Feb 11, 2017 · 0 comments

Comments

@remkop
Copy link
Owner

remkop commented Feb 11, 2017

Ideally programmers should be able to specify a UsageFormatter interface implementation that gives complete freedom over the usage message layout.

Expose picoCLI usage layout functionality so custom formatters can reuse it.

Customizable:

  • "Usage" line: mention option short form with [-v] optional and mandatory elements, or a generic [OPTIONS] [PARAMETERS]
  • option columns: show in declared order or sort short options first
  • option rows: sort alphabetically or show in declared order
  • required options: show '*' in front of option name, or print 'Required' on 2nd line or print '(Required)' before or after the option description
  • option parameter name: use field name or use field type (class SimpleName)
  • option and parameter separated by space or by '='
  • option parameter default value: print 'Default: VALUE' on 2nd line or print '(default: VALUE)' after the option description
@remkop remkop added this to the 0.3.0 usage online help milestone Feb 11, 2017
@remkop remkop closed this as completed in 88a1f27 Feb 21, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant