Skip to content

Commit

Permalink
feat(analyzer): added command line options for diagnostics modifiers …
Browse files Browse the repository at this point in the history
…to `code` command
  • Loading branch information
d-biehl committed Nov 19, 2024
1 parent 610b1f3 commit 0a29800
Show file tree
Hide file tree
Showing 10 changed files with 174 additions and 86 deletions.
6 changes: 3 additions & 3 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,10 @@
// "-i",
// "-v", "CMD_LINE_VAR:cmd_line_var",
// "E:\\source\\uvtestprj\\tests\\first.robotrepl"
"analyze",
"code",
// "analyze",
// "code",
// "tests"
// "repl",
"repl",
// "-v",
// "asd:asd"

Expand Down
58 changes: 39 additions & 19 deletions docs/03_reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,26 @@ robotcode analyze code [OPTIONS] [PATHS]...
Specifies the diagnostics codes to ignore.


- `-me, --modifiers-error CODE`

Specifies the diagnostics codes to treat as errors.


- `-mw, --modifiers-warning CODE`

Specifies the diagnostics codes to treat as warning.


- `-mI, --modifiers-information CODE`

Specifies the diagnostics codes to treat as information.


- `-mh, --modifiers-hint CODE`

Specifies the diagnostics codes to treat as hint.


- `--help`

Show this message and exit.
Expand Down Expand Up @@ -624,12 +644,12 @@ robotcode debug [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...

- `--tcp [<ADDRESS>:]<PORT>`

Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: port, pipe-server, mode, pipe-name.
Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: mode, port, pipe-server, pipe-name.


- `--pipe-server NAME`

Run in `pipe-server` mode and listen at the given pipe name. (Equivalent to `--mode pipe-server --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: bind, mode, port, tcp, pipe-name.
Run in `pipe-server` mode and listen at the given pipe name. (Equivalent to `--mode pipe-server --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: bind, mode, tcp, port, pipe-name.


- `--mode [tcp|pipe-server]`
Expand All @@ -649,7 +669,7 @@ robotcode debug [OPTIONS] [ROBOT_OPTIONS_AND_ARGS]...

- `--pipe-name NAME`

The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: tcp, bind, pipe-server, port. [env var: ROBOTCODE_PIPE_NAME]
The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: bind, tcp, port, pipe-server. [env var: ROBOTCODE_PIPE_NAME]


- `--version`
Expand All @@ -676,47 +696,47 @@ robotcode debug-launch [OPTIONS]
**Options:**
- `--stdio`

Run in `stdio` mode. (Equivalent to `--mode stdio`) *NOTE:* This option is mutually exclusive with options: bind, socket, pipe, mode, port, tcp, pipe-server, pipe-name. [env var: ROBOTCODE_STDIO]
Run in `stdio` mode. (Equivalent to `--mode stdio`) *NOTE:* This option is mutually exclusive with options: bind, socket, pipe, mode, tcp, port, pipe-server, pipe-name. [env var: ROBOTCODE_STDIO]


- `--tcp [<ADDRESS>:]<PORT>`

Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: socket, pipe, mode, port, stdio, pipe-server, pipe-name.
Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: socket, pipe, mode, port, pipe-server, pipe-name, stdio.


- `--socket [<ADDRESS>:]<PORT>`

Run in `socket` mode and connect to the given port. (Equivalent to `--mode socket --port <port>`) *NOTE:* This option is mutually exclusive with options: pipe, mode, port, tcp, stdio, pipe-server, pipe-name.
Run in `socket` mode and connect to the given port. (Equivalent to `--mode socket --port <port>`) *NOTE:* This option is mutually exclusive with options: pipe, mode, tcp, port, pipe-server, pipe-name, stdio.


- `--pipe NAME`

Run in `pipe` mode and connect to the given pipe name. (Equivalent to `--mode pipe --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: bind, socket, mode, port, tcp, stdio, pipe-server, pipe-name.
Run in `pipe` mode and connect to the given pipe name. (Equivalent to `--mode pipe --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: bind, socket, mode, tcp, port, pipe-server, pipe-name, stdio.


- `--pipe-server NAME`

Run in `pipe-server` mode and listen at the given pipe name. (Equivalent to `--mode pipe-server --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: bind, socket, pipe, mode, port, tcp, stdio, pipe-name.
Run in `pipe-server` mode and listen at the given pipe name. (Equivalent to `--mode pipe-server --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: bind, socket, pipe, mode, tcp, port, pipe-name, stdio.


- `--mode [stdio|tcp|socket|pipe|pipe-server]`

The mode to use for the debug launch server. *NOTE:* This option is mutually exclusive with options: socket, tcp, stdio, pipe-server, pipe. [env var: ROBOTCODE_MODE; default: stdio]
The mode to use for the debug launch server. *NOTE:* This option is mutually exclusive with options: socket, pipe, tcp, pipe-server, stdio. [env var: ROBOTCODE_MODE; default: stdio]


- `--port PORT`

The port to listen on or connect to. (Only valid for `tcp` and `socket mode`) *NOTE:* This option is mutually exclusive with options: pipe-server, pipe-name, pipe. [env var: ROBOTCODE_PORT; default: 6611; 1<=x<=65535]
The port to listen on or connect to. (Only valid for `tcp` and `socket mode`) *NOTE:* This option is mutually exclusive with options: pipe-name, pipe-server, pipe. [env var: ROBOTCODE_PORT; default: 6611; 1<=x<=65535]


- `--bind ADDRESS`

Specify alternate bind address. If no address is specified `localhost` is used. (Only valid for tcp and socket mode) *NOTE:* This option is mutually exclusive with options: pipe-server, pipe-name, pipe. [env var: ROBOTCODE_BIND; default: 127.0.0.1]
Specify alternate bind address. If no address is specified `localhost` is used. (Only valid for tcp and socket mode) *NOTE:* This option is mutually exclusive with options: pipe-name, pipe-server, pipe. [env var: ROBOTCODE_BIND; default: 127.0.0.1]


- `--pipe-name NAME`

The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: bind, socket, port, tcp, stdio, pipe-server, pipe. [env var: ROBOTCODE_PIPE_NAME]
The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: bind, socket, pipe, tcp, port, pipe-server, stdio. [env var: ROBOTCODE_PIPE_NAME]


- `--version`
Expand Down Expand Up @@ -1146,27 +1166,27 @@ robotcode language-server [OPTIONS] [PATHS]...
**Options:**
- `--stdio`

Run in `stdio` mode. (Equivalent to `--mode stdio`) *NOTE:* This option is mutually exclusive with options: bind, socket, pipe, mode, port, tcp, pipe-name. [env var: ROBOTCODE_STDIO]
Run in `stdio` mode. (Equivalent to `--mode stdio`) *NOTE:* This option is mutually exclusive with options: bind, socket, pipe, mode, tcp, port, pipe-name. [env var: ROBOTCODE_STDIO]


- `--tcp [<ADDRESS>:]<PORT>`

Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: socket, pipe, mode, port, stdio, pipe-name.
Run in `tcp` server mode and listen at the given port. (Equivalent to `--mode tcp --port <port>`) *NOTE:* This option is mutually exclusive with options: socket, pipe, mode, port, pipe-name, stdio.


- `--socket [<ADDRESS>:]<PORT>`

Run in `socket` mode and connect to the given port. (Equivalent to `--mode socket --port <port>`) *NOTE:* This option is mutually exclusive with options: pipe, mode, port, tcp, stdio, pipe-name.
Run in `socket` mode and connect to the given port. (Equivalent to `--mode socket --port <port>`) *NOTE:* This option is mutually exclusive with options: pipe, mode, tcp, port, pipe-name, stdio.


- `--pipe NAME`

Run in `pipe` mode and connect to the given pipe name. (Equivalent to `--mode pipe --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: bind, socket, mode, port, tcp, stdio, pipe-name.
Run in `pipe` mode and connect to the given pipe name. (Equivalent to `--mode pipe --pipe-name <name>`) *NOTE:* This option is mutually exclusive with options: bind, socket, mode, tcp, port, pipe-name, stdio.


- `--mode [tcp|stdio|socket|pipe]`
- `--mode [stdio|tcp|socket|pipe]`

The mode to use for the debug launch server. *NOTE:* This option is mutually exclusive with options: tcp, stdio, socket, pipe. [env var: ROBOTCODE_MODE; default: stdio]
The mode to use for the debug launch server. *NOTE:* This option is mutually exclusive with options: stdio, tcp, socket, pipe. [env var: ROBOTCODE_MODE; default: stdio]


- `--port PORT`
Expand All @@ -1181,7 +1201,7 @@ robotcode language-server [OPTIONS] [PATHS]...

- `--pipe-name NAME`

The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: bind, socket, port, tcp, stdio, pipe. [env var: ROBOTCODE_PIPE_NAME]
The pipe to listen on or connect to. (Only valid in `pipe` and `pipe-server` mode) *NOTE:* This option is mutually exclusive with options: bind, socket, pipe, tcp, port, stdio. [env var: ROBOTCODE_PIPE_NAME]


- `--version`
Expand Down
40 changes: 20 additions & 20 deletions docs/03_reference/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -2732,7 +2732,7 @@ extend-information = ["MultipleKeywords"]

Type: `list[str] | None`

Specifies the error codes to treat as errors.
Specifies the diagnostics codes to treat as errors.

Examples:

Expand All @@ -2745,7 +2745,7 @@ error = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Extend the error codes to treat as errors.
Extend the diagnostics codes to treat as errors.

Examples:

Expand All @@ -2758,7 +2758,7 @@ extend_error = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Extend the error codes to treat as hint.
Extend the diagnostics codes to treat as hint.

Examples:

Expand All @@ -2771,7 +2771,7 @@ extend_hint = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Extend the error codes to ignore.
Extend the diagnostics codes to ignore.

Examples:

Expand All @@ -2784,7 +2784,7 @@ extend_ignore = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Extend the error codes to treat as information.
Extend the diagnostics codes to treat as information.

Examples:

Expand All @@ -2797,7 +2797,7 @@ extend_information = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Extend the error codes to treat as warnings.
Extend the diagnostics codes to treat as warning.

Examples:

Expand All @@ -2810,7 +2810,7 @@ extend_warning = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Specifies the error codes to treat as hint.
Specifies the diagnostics codes to treat as hint.

Examples:

Expand All @@ -2823,7 +2823,7 @@ hint = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Specifies the error codes to ignore.
Specifies the diagnostics codes to ignore.

Examples:

Expand All @@ -2836,7 +2836,7 @@ ignore = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Specifies the error codes to treat as information.
Specifies the diagnostics codes to treat as information.

Examples:

Expand All @@ -2849,7 +2849,7 @@ information = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Specifies the error codes to treat as warning.
Specifies the diagnostics codes to treat as warning.

Examples:

Expand Down Expand Up @@ -2889,7 +2889,7 @@ information = ["MultipleKeywords"]

Type: `list[str] | None`

Specifies the error codes to treat as errors.
Specifies the diagnostics codes to treat as errors.

Examples:

Expand All @@ -2902,7 +2902,7 @@ error = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Extend the error codes to treat as errors.
Extend the diagnostics codes to treat as errors.

Examples:

Expand All @@ -2915,7 +2915,7 @@ extend_error = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Extend the error codes to treat as hint.
Extend the diagnostics codes to treat as hint.

Examples:

Expand All @@ -2928,7 +2928,7 @@ extend_hint = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Extend the error codes to ignore.
Extend the diagnostics codes to ignore.

Examples:

Expand All @@ -2941,7 +2941,7 @@ extend_ignore = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Extend the error codes to treat as information.
Extend the diagnostics codes to treat as information.

Examples:

Expand All @@ -2954,7 +2954,7 @@ extend_information = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Extend the error codes to treat as warnings.
Extend the diagnostics codes to treat as warning.

Examples:

Expand All @@ -2967,7 +2967,7 @@ extend_warning = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Specifies the error codes to treat as hint.
Specifies the diagnostics codes to treat as hint.

Examples:

Expand All @@ -2980,7 +2980,7 @@ hint = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Specifies the error codes to ignore.
Specifies the diagnostics codes to ignore.

Examples:

Expand All @@ -2993,7 +2993,7 @@ ignore = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Specifies the error codes to treat as information.
Specifies the diagnostics codes to treat as information.

Examples:

Expand All @@ -3006,7 +3006,7 @@ information = ["VariableNotFound", "multiple-keywords"]

Type: `list[str] | None`

Specifies the error codes to treat as warning.
Specifies the diagnostics codes to treat as warning.

Examples:

Expand Down
Loading

0 comments on commit 0a29800

Please sign in to comment.