[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=13383666#comment-13383666 ] 

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

[~brian.stansberry]
something that is missing in a filtering only approach is the ability to easily (without having to go to help) answer the question: Do all the required attributes have been set?
If we complement the approach with a "Double Tab" of something like 500ms, we could expose all the remaining arguments annotated with relationships/attributes. ('*', <optional>, ...)

It seems that required, requires and alternatives would be doable with the filtering approach:

- Alternatives should be hidden as soon as a choice has been made.
- Partly typed argument name should be completed if it exists and all its dependencies are resolved, being required or not.
- Argument that depends on the presence of other arguments should be hidden until all the dependencies are present. That is in line with the way Commands are exposing options.
- Requires relationship overrides the required attribute. Any attribute is exposed as soon as all its dependencies (if any) are resolved.
In your example, let's imagine that:
D - not required, requires A and C.
E - required
As soon as A and C are present, D is exposed along E although D is not required.

Seems that users wouldn't have to think too much. They press Tab, and choose the argument they want to set. If lost, they press Tab twice and decode the exposed relationships. If that is not enough, they go to help.

Going to help requires to clear the current line and type help <my operation>, then type again the operation (generally Paste again the operation that would have been previously copied). This is very inefficient and requires too much context switching.

An inline help could be designed...more thinking needed there... Double tab, could be a first step toward it.
JF


> 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)