Skip to content

Commit 3902937

Browse files
committed
feat(config): add console_links to robot.toml
1 parent 5e83537 commit 3902937

File tree

3 files changed

+75
-2
lines changed

3 files changed

+75
-2
lines changed

Diff for: docs/03_reference/config.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# `robot.toml` Configuration Settings
1+
# robot.toml configuration settings
22

33
## [profile].description
44

@@ -108,6 +108,18 @@ Use colors on console output or not.
108108

109109
corresponds to the `-C --consolecolors auto|on|ansi|off` option of _robot_
110110

111+
## console-links
112+
113+
Type: `Optional[Literal['auto', 'off']]`
114+
115+
Control making paths to results files hyperlinks.
116+
117+
**auto:** use links when colors are enabled (default)
118+
119+
**off:** disable links unconditionally
120+
121+
corresponds to the `--consolelinks auto|off` option of _robot_
122+
111123
## console-markers
112124

113125
Type: `Optional[Literal['auto', 'on', 'off']]`
@@ -1200,6 +1212,18 @@ Use colors on console output or not.
12001212

12011213
corresponds to the `-C --consolecolors auto|on|ansi|off` option of _robot_
12021214

1215+
## rebot.console-links
1216+
1217+
Type: `Optional[Literal['auto', 'off']]`
1218+
1219+
Control making paths to results files hyperlinks.
1220+
1221+
**auto:** use links when colors are enabled (default)
1222+
1223+
**off:** disable links unconditionally
1224+
1225+
corresponds to the `--consolelinks auto|off` option of _robot_
1226+
12031227
## rebot.doc
12041228

12051229
Type: `Union[str, StringExpression, None]`

Diff for: etc/robot.toml.json

+37-1
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,18 @@
192192
"null"
193193
]
194194
},
195+
"console-links": {
196+
"description": "Control making paths to results files hyperlinks.\n\n**auto:** use links when colors are enabled (default)\n\n**off:** disable links unconditionally\n\ncorresponds to the `--consolelinks auto|off` option of _robot_\n",
197+
"enum": [
198+
"auto",
199+
"off"
200+
],
201+
"title": "Console links",
202+
"type": [
203+
"string",
204+
"null"
205+
]
206+
},
195207
"doc": {
196208
"anyOf": [
197209
{
@@ -1349,6 +1361,18 @@
13491361
"null"
13501362
]
13511363
},
1364+
"console-links": {
1365+
"description": "Control making paths to results files hyperlinks.\n\n**auto:** use links when colors are enabled (default)\n\n**off:** disable links unconditionally\n\ncorresponds to the `--consolelinks auto|off` option of _robot_\n",
1366+
"enum": [
1367+
"auto",
1368+
"off"
1369+
],
1370+
"title": "Console links",
1371+
"type": [
1372+
"string",
1373+
"null"
1374+
]
1375+
},
13521376
"console-markers": {
13531377
"description": "Show markers on the console when top level\nkeywords in a test case end. Values have same\nsemantics as with --consolecolors.\n\ncorresponds to the `-K --consolemarkers auto|on|off` option of _robot_\n",
13541378
"enum": [
@@ -3197,6 +3221,18 @@
31973221
"null"
31983222
]
31993223
},
3224+
"console-links": {
3225+
"description": "Control making paths to results files hyperlinks.\n\n**auto:** use links when colors are enabled (default)\n\n**off:** disable links unconditionally\n\ncorresponds to the `--consolelinks auto|off` option of _robot_\n",
3226+
"enum": [
3227+
"auto",
3228+
"off"
3229+
],
3230+
"title": "Console links",
3231+
"type": [
3232+
"string",
3233+
"null"
3234+
]
3235+
},
32003236
"console-markers": {
32013237
"description": "Show markers on the console when top level\nkeywords in a test case end. Values have same\nsemantics as with --consolecolors.\n\ncorresponds to the `-K --consolemarkers auto|on|off` option of _robot_\n",
32023238
"enum": [
@@ -3324,7 +3360,7 @@
33243360
}
33253361
],
33263362
"default": null,
3327-
"description": "If enabled the profile is used. You can also use and `if` condition\nto calculate the enabled state.\n\nExamples:\n```toml\n# alway disabled\nenabled = false\n```\n\n```toml\n# enabled if TEST_VAR is set\nenabled = { if = 'environ.get(\"CI\") == \"true\"' }\n```\n",
3363+
"description": "If enabled the profile is used. You can also use and `if` condition\nto calculate the enabled state.\n\nExamples:\n```toml\n# always disabled\nenabled = false\n```\n\n```toml\n# enabled if TEST_VAR is set\nenabled = { if = 'environ.get(\"CI\") == \"true\"' }\n```\n",
33283364
"title": "Enabled"
33293365
},
33303366
"env": {

Diff for: packages/robot/src/robotcode/robot/config/model.py

+13
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,19 @@ class CommonOptions(BaseOptions):
434434
robot_priority=500,
435435
robot_short_name="C",
436436
)
437+
console_links: Optional[Literal["auto", "off"]] = field(
438+
description="""\
439+
Control making paths to results files hyperlinks.
440+
441+
**auto:** use links when colors are enabled (default)
442+
443+
**off:** disable links unconditionally
444+
445+
corresponds to the `--consolelinks auto|off` option of _robot_
446+
""",
447+
robot_name="consolelinks",
448+
robot_priority=500,
449+
)
437450
doc: Optional[Union[str, StringExpression]] = field(
438451
description="""\
439452
Set the documentation of the top level suite.

0 commit comments

Comments
 (0)