]
Darran Lofthouse updated ELY-2082:
----------------------------------
Summary: Optimise Tool Help Text (was: Optomise Tool Help Text)
Optimise Tool Help Text
-----------------------
Key: ELY-2082
URL:
https://issues.redhat.com/browse/ELY-2082
Project: WildFly Elytron
Issue Type: Task
Components: Command-Line Tool
Reporter: Darran Lofthouse
Priority: Major
Attachments: tool-help.txt
Attached to this issue is the present help test from the tool when called with no
arguments, it is already very verbose and new commands are in the process of being added
making it even longer.
We should switch to some kind of tiered help so by default we just show the stop level
commands with a description and provide instructions to obtain help text on the individual
commands.
Secondly the wrapping of text makes us hard to read - even on a widescreen monitor. If
we could detect the width of the terminal window maybe we could more dynamically format
the output. Failing that maybe we should determine a minimum width to view the output and
ensure we format cleanly within the width.
We could also go further and ensure each command has a reference manual published from
the Elytron project that can be referred to with a http link - or could the tool trigger
loading the link?