[jboss-jira] [JBoss JIRA] (WFCORE-2283) Make 'required' attributes clearer when using tab completion within CLI

[Jean-Francois Denise (JIRA)]

    [ https://issues.jboss.org/browse/WFCORE-2283?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13383150#comment-13383150 ] 

Jean-Francois Denise commented on WFCORE-2283:
----------------------------------------------

I have done some experimentation to better expose mandatory arguments (should also apply to complex object properties).
An efficient way would be to only expose required attributes first then, once all required attributes have been provided, propose optional ones. This has the benefit to:
1) Better drive users to fill an operation by reducing the amount of exposed arguments to the right set.
2) Reduce the risk to forget required arguments.
3) Comply with existing CLI user experience. High level commands have already this kind of logic. "Required" options are exposed first, then optional options are exposed incrementally.
4) In case there is only one required argument, it will be automatically inlined. Then optionals are proposed.

As an example, today:
list-add(<TAB>
filter handlers name

With such approach:
list-add(<TAB>
list-add(name=
list-add(name=xxx,<TAB>
filter handlers


> Make 'required' attributes clearer when using tab completion within CLI
> -----------------------------------------------------------------------
>
>                 Key: WFCORE-2283
>                 URL: https://issues.jboss.org/browse/WFCORE-2283
>             Project: WildFly Core
>          Issue Type: Feature Request
>          Components: CLI
>            Reporter: Darran Lofthouse
>            Assignee: Jean-Francois Denise
>
> The following is some example output pressing tab to reveal the parameters of 'add': -
> {{[standalone at localhost:9990 /] ./subsystem=elytron/key-store=localhost:add(
> !  alias-filter  credential-reference  path  provider-name  providers  relative-to  required  type  }}
> From this is it not clear which are actually required.
> Suggestions to make it clearer: -
> * Show required / optional in different colours.
> * Add something to the required attributes e.g. '*'
> * Add something to the optional requirements e.g. {optional_arg}
> Maybe this can go one step further and take into account arguments already added by the user, especially where attributes require another attribute or are an alternative.
> Once an attribute is identified as being an alternative to another attribute maybe it should be omitted altogether from the list or maybe also have something adding to it !attr_name.



--
This message was sent by Atlassian JIRA
(v7.2.3#72005)