[ 
https://issues.apache.org/jira/browse/IGNITE-15411?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Andrey N. Gura updated IGNITE-15411:
------------------------------------
    Description: 
Help for {{ignite node start}} command:

{noformat}
$ ./target/ignite node start --help
Picked up JAVA_TOOL_OPTIONS: -Dfile.encoding=UTF8 
-Djava.net.preferIPv4Stack=true
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further 
details.


           #              ___                         __
         ###             /   |   ____   ____ _ _____ / /_   ___
     #  #####           / /| |  / __ \ / __ `// ___// __ \ / _ \
   ###  ######         / ___ | / /_/ // /_/ // /__ / / / // ___/
  #####  #######      /_/  |_|/ .___/ \__,_/ \___//_/ /_/ \___/
  #######  ######            /_/
    ########  ####        ____               _  __           _____
   #  ########  ##       /  _/____ _ ____   (_)/ /_ ___     |__  /
  ####  #######  #       / / / __ `// __ \ / // __// _ \     /_ <
   #####  #####        _/ / / /_/ // / / // // /_ / ___/   ___/ /
     ####  ##         /___/ \__, //_/ /_//_/ \__/ \___/   /____/
       ##                  /____/

                      Apache Ignite CLI ver. 3.0.0-SNAPSHOT

ignite node start [OPTIONS] name

Starts an Ignite node locally.

+-----------------------+-------------------------------------------+
| REQUIRED PARAMETERS                                               |
+-----------------------+-------------------------------------------+
| name                  | Name of the new node                      |
+-----------------------+-------------------------------------------+
| OPTIONS                                                           |
+-----------------------+-------------------------------------------+
| --config=<configPath> | Configuration file to start the node with |
+-----------------------+-------------------------------------------+
{noformat}

{{name}} parameter is indistinguishable from other tokens of command (e.g., 
{{node}}, {{start}}).

*Proposal:*

- use different color for required parameter (e.g. white)
- additionally use angle brackets ({{<name>}}).

Also, in this particular case, it makes sense to change order of token from 
{{ignite node start [OPTIONS] name}} to {{ignite node start name [OPTIONS]}}.

*Expected result:*

{{ignite node start <name> [OPTIONS]}} with additional color highlighting of 
{{<name>}} part.

  was:
Help for {{ignite node start}} command:

{noformat}
$ ./target/ignite node start --help
Picked up JAVA_TOOL_OPTIONS: -Dfile.encoding=UTF8 
-Djava.net.preferIPv4Stack=true
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further 
details.


           #              ___                         __
         ###             /   |   ____   ____ _ _____ / /_   ___
     #  #####           / /| |  / __ \ / __ `// ___// __ \ / _ \
   ###  ######         / ___ | / /_/ // /_/ // /__ / / / // ___/
  #####  #######      /_/  |_|/ .___/ \__,_/ \___//_/ /_/ \___/
  #######  ######            /_/
    ########  ####        ____               _  __           _____
   #  ########  ##       /  _/____ _ ____   (_)/ /_ ___     |__  /
  ####  #######  #       / / / __ `// __ \ / // __// _ \     /_ <
   #####  #####        _/ / / /_/ // / / // // /_ / ___/   ___/ /
     ####  ##         /___/ \__, //_/ /_//_/ \__/ \___/   /____/
       ##                  /____/

                      Apache Ignite CLI ver. 3.0.0-SNAPSHOT

ignite node start [OPTIONS] name

Starts an Ignite node locally.

+-----------------------+-------------------------------------------+
| REQUIRED PARAMETERS                                               |
+-----------------------+-------------------------------------------+
| name                  | Name of the new node                      |
+-----------------------+-------------------------------------------+
| OPTIONS                                                           |
+-----------------------+-------------------------------------------+
| --config=<configPath> | Configuration file to start the node with |
+-----------------------+-------------------------------------------+
{noformat}

{{name}} parameter is indistinguishable from other token of command (e.g., 
node, start).

*Proposal:*

- use different color for required parameter (e.g. white)
- additionally use angle brackets ({{<name>}}).

Also, in this particular case, it makes sense to change order of token from 
{{ignite node start [OPTIONS] name}} to {{ignite node start name [OPTIONS]}}.

*Expected result:*

{{ignite node start <name> [OPTIONS]}} with additional color highlighting of 
{{<name>}} part.


> CLI: It's impossible to distinguish command from required parameter in help
> ---------------------------------------------------------------------------
>
>                 Key: IGNITE-15411
>                 URL: https://issues.apache.org/jira/browse/IGNITE-15411
>             Project: Ignite
>          Issue Type: Bug
>            Reporter: Andrey N. Gura
>            Priority: Major
>              Labels: ignite-3
>
> Help for {{ignite node start}} command:
> {noformat}
> $ ./target/ignite node start --help
> Picked up JAVA_TOOL_OPTIONS: -Dfile.encoding=UTF8 
> -Djava.net.preferIPv4Stack=true
> SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
> SLF4J: Defaulting to no-operation (NOP) logger implementation
> SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further 
> details.
>            #              ___                         __
>          ###             /   |   ____   ____ _ _____ / /_   ___
>      #  #####           / /| |  / __ \ / __ `// ___// __ \ / _ \
>    ###  ######         / ___ | / /_/ // /_/ // /__ / / / // ___/
>   #####  #######      /_/  |_|/ .___/ \__,_/ \___//_/ /_/ \___/
>   #######  ######            /_/
>     ########  ####        ____               _  __           _____
>    #  ########  ##       /  _/____ _ ____   (_)/ /_ ___     |__  /
>   ####  #######  #       / / / __ `// __ \ / // __// _ \     /_ <
>    #####  #####        _/ / / /_/ // / / // // /_ / ___/   ___/ /
>      ####  ##         /___/ \__, //_/ /_//_/ \__/ \___/   /____/
>        ##                  /____/
>                       Apache Ignite CLI ver. 3.0.0-SNAPSHOT
> ignite node start [OPTIONS] name
> Starts an Ignite node locally.
> +-----------------------+-------------------------------------------+
> | REQUIRED PARAMETERS                                               |
> +-----------------------+-------------------------------------------+
> | name                  | Name of the new node                      |
> +-----------------------+-------------------------------------------+
> | OPTIONS                                                           |
> +-----------------------+-------------------------------------------+
> | --config=<configPath> | Configuration file to start the node with |
> +-----------------------+-------------------------------------------+
> {noformat}
> {{name}} parameter is indistinguishable from other tokens of command (e.g., 
> {{node}}, {{start}}).
> *Proposal:*
> - use different color for required parameter (e.g. white)
> - additionally use angle brackets ({{<name>}}).
> Also, in this particular case, it makes sense to change order of token from 
> {{ignite node start [OPTIONS] name}} to {{ignite node start name [OPTIONS]}}.
> *Expected result:*
> {{ignite node start <name> [OPTIONS]}} with additional color highlighting of 
> {{<name>}} part.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

Reply via email to