Skip to content

Commit dd6d758

Browse files
d-biehld-biehl
committed
feat: add command for robots _testdoc_
1 parent a55a833 commit dd6d758

File tree

8 files changed

+573
-13
lines changed

8 files changed

+573
-13
lines changed

‎etc/robot.toml.json

Lines changed: 207 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
},
2525
"LibDocProfile": {
2626
"additionalProperties": false,
27-
"description": "LibDocProfile(extra_python_path: 'Optional[List[str]]' = None, doc_format: \"Optional[Literal['ROBOT', 'HTML', 'TEXT', 'REST']]\" = None, format: \"Optional[Literal['HTML', 'XML', 'JSON', 'LIBSPEC']]\" = None, name: 'Optional[str]' = None, python_path: 'Optional[List[str]]' = None, quiet: 'Union[bool, Flag, None]' = None, spec_doc_format: \"Optional[Literal['RAW', 'HTML']]\" = None, theme: \"Optional[Literal['DARK', 'LIGHT', 'NONE']]\" = None)",
27+
"description": "Profile for _libdoc_ command.",
2828
"properties": {
2929
"doc-format": {
3030
"description": "Specifies the source documentation format. Possible\nvalues are Robot Framework's documentation format,\nHTML, plain text, and reStructuredText. The default\nvalue can be specified in library source code and\nthe initial default value is ROBOT.\n\n---\ncorresponds to the `-F --docformat ROBOT|HTML|TEXT|REST` option of _robot_\n",
@@ -139,7 +139,7 @@
139139
},
140140
"RebotProfile": {
141141
"additionalProperties": false,
142-
"description": "RebotProfile(extra_excludes: 'Optional[List[str]]' = None, extra_expand_keywords: \"Optional[List[Union[str, Literal['name:<pattern>', 'tag:<pattern>']]]]\" = None, extra_flatten_keywords: \"Optional[List[Union[str, Literal['for', 'while', 'iteration', 'name:<pattern>', 'tag:<pattern>']]]]\" = None, extra_includes: 'Optional[List[str]]' = None, extra_metadata: 'Optional[Dict[str, str]]' = None, extra_pre_rebot_modifiers: 'Optional[Dict[str, List[str]]]' = None, extra_python_path: 'Optional[List[str]]' = None, extra_remove_keywords: \"Optional[List[Union[str, Literal['all', 'passed', 'for', 'wuks', 'name:<pattern>', 'tag:<pattern>']]]]\" = None, extra_set_tag: 'Optional[List[str]]' = None, extra_suites: 'Optional[List[str]]' = None, extra_tag_doc: 'Optional[Dict[str, str]]' = None, extra_tag_stat_combine: 'Optional[Dict[str, str]]' = None, extra_tag_stat_exclude: 'Optional[List[str]]' = None, extra_tag_stat_include: 'Optional[List[str]]' = None, extra_tag_stat_link: 'Optional[Dict[str, str]]' = None, extra_tasks: 'Optional[List[str]]' = None, extra_tests: 'Optional[List[str]]' = None, console_colors: \"Optional[Literal['auto', 'on', 'ansi', 'off']]\" = None, doc: 'Optional[str]' = None, excludes: 'Optional[List[str]]' = None, expand_keywords: \"Optional[List[Union[str, Literal['name:<pattern>', 'tag:<pattern>']]]]\" = None, flatten_keywords: \"Optional[List[Union[str, Literal['for', 'while', 'iteration', 'name:<pattern>', 'tag:<pattern>']]]]\" = None, includes: 'Optional[List[str]]' = None, log: 'Optional[str]' = None, log_title: 'Optional[str]' = None, metadata: 'Optional[Dict[str, str]]' = None, name: 'Optional[str]' = None, no_status_rc: 'Union[bool, Flag, None]' = None, output_dir: 'Optional[str]' = None, pre_rebot_modifiers: 'Optional[Dict[str, List[str]]]' = None, python_path: 'Optional[List[str]]' = None, remove_keywords: \"Optional[List[Union[str, Literal['all', 'passed', 'for', 'wuks', 'name:<pattern>', 'tag:<pattern>']]]]\" = None, report: 'Optional[str]' = None, report_background: 'Optional[str]' = None, report_title: 'Optional[str]' = None, rpa: 'Union[bool, Flag, None]' = None, set_tag: 'Optional[List[str]]' = None, split_log: 'Union[bool, Flag, None]' = None, suites: 'Optional[List[str]]' = None, suite_stat_level: 'Optional[int]' = None, tag_doc: 'Optional[Dict[str, str]]' = None, tag_stat_combine: 'Optional[Dict[str, str]]' = None, tag_stat_exclude: 'Optional[List[str]]' = None, tag_stat_include: 'Optional[List[str]]' = None, tag_stat_link: 'Optional[Dict[str, str]]' = None, tasks: 'Optional[List[str]]' = None, tests: 'Optional[List[str]]' = None, timestamp_outputs: 'Union[bool, Flag, None]' = None, xunit: 'Optional[str]' = None, end_time: 'Optional[str]' = None, log_level: 'Optional[str]' = None, merge: 'Union[bool, Flag, None]' = None, output: 'Optional[str]' = None, process_empty_suite: 'Union[bool, Flag, None]' = None, start_time: 'Optional[str]' = None)",
142+
"description": "Profile for _rebot_ command.",
143143
"properties": {
144144
"console-colors": {
145145
"description": "Use colors on console output or not.\nauto: use colors when output not redirected (default)\non: always use colors\nansi: like `on` but use ANSI colors also on Windows\noff: disable colors altogether\n\n---\ncorresponds to the `-C --consolecolors auto|on|ansi|off` option of _robot_\n",
@@ -2121,6 +2121,19 @@
21212121
"null"
21222122
]
21232123
},
2124+
"testdoc": {
2125+
"anyOf": [
2126+
{
2127+
"$ref": "#/definitions/TestDocProfile"
2128+
},
2129+
{
2130+
"type": "null"
2131+
}
2132+
],
2133+
"default": null,
2134+
"description": "Options to be passed to _testdoc_.\n",
2135+
"title": "Testdoc"
2136+
},
21242137
"tests": {
21252138
"default": null,
21262139
"description": "Select tests by name or by long name containing also\nparent suite name like `Parent.Test`. Name is case\nand space insensitive and it can also be a simple\npattern where `*` matches anything, `?` matches any\nsingle character, and `[chars]` matches one character\nin brackets.\n\n---\ncorresponds to the `-t --test name *` option of _robot_\n",
@@ -3411,6 +3424,19 @@
34113424
"null"
34123425
]
34133426
},
3427+
"testdoc": {
3428+
"anyOf": [
3429+
{
3430+
"$ref": "#/definitions/TestDocProfile"
3431+
},
3432+
{
3433+
"type": "null"
3434+
}
3435+
],
3436+
"default": null,
3437+
"description": "Options to be passed to _testdoc_.\n",
3438+
"title": "Testdoc"
3439+
},
34143440
"tests": {
34153441
"default": null,
34163442
"description": "Select tests by name or by long name containing also\nparent suite name like `Parent.Test`. Name is case\nand space insensitive and it can also be a simple\npattern where `*` matches anything, `?` matches any\nsingle character, and `[chars]` matches one character\nin brackets.\n\n---\ncorresponds to the `-t --test name *` option of _robot_\n",
@@ -3480,6 +3506,185 @@
34803506
},
34813507
"title": "RobotProfile",
34823508
"type": "object"
3509+
},
3510+
"TestDocProfile": {
3511+
"additionalProperties": false,
3512+
"description": "Profile for _testdoc_ command.",
3513+
"properties": {
3514+
"doc": {
3515+
"default": null,
3516+
"description": "Override the documentation of the top level suite.\n\n---\ncorresponds to the `-D --doc document` option of _robot_\n",
3517+
"title": "Doc",
3518+
"type": [
3519+
"string",
3520+
"null"
3521+
]
3522+
},
3523+
"excludes": {
3524+
"default": null,
3525+
"description": "Exclude tests by tags.\n\n---\ncorresponds to the `-e --exclude tag *` option of _robot_\n",
3526+
"items": {
3527+
"type": "string"
3528+
},
3529+
"title": "Excludes",
3530+
"type": [
3531+
"array",
3532+
"null"
3533+
]
3534+
},
3535+
"extra-excludes": {
3536+
"default": null,
3537+
"description": "Appends entries to the --exclude option.\n\n---\n\nExclude tests by tags.\n\n---\ncorresponds to the `-e --exclude tag *` option of _robot_\n",
3538+
"items": {
3539+
"type": "string"
3540+
},
3541+
"title": "Extra excludes",
3542+
"type": [
3543+
"array",
3544+
"null"
3545+
]
3546+
},
3547+
"extra-includes": {
3548+
"default": null,
3549+
"description": "Appends entries to the --include option.\n\n---\n\nInclude tests by tags.\n\n---\ncorresponds to the `-i --include tag *` option of _robot_\n",
3550+
"items": {
3551+
"type": "string"
3552+
},
3553+
"title": "Extra includes",
3554+
"type": [
3555+
"array",
3556+
"null"
3557+
]
3558+
},
3559+
"extra-metadata": {
3560+
"additionalProperties": {
3561+
"type": "string"
3562+
},
3563+
"default": null,
3564+
"description": "Appends entries to the --metadata option.\n\n---\n\nSet/override metadata of the top level suite.\n\n---\ncorresponds to the `-M --metadata name:value *` option of _robot_\n",
3565+
"title": "Extra metadata",
3566+
"type": [
3567+
"object",
3568+
"null"
3569+
]
3570+
},
3571+
"extra-set-tag": {
3572+
"default": null,
3573+
"description": "Appends entries to the --settag option.\n\n---\n\nSet given tag(s) to all test cases.\n\n---\ncorresponds to the `-G --settag tag *` option of _robot_\n",
3574+
"items": {
3575+
"type": "string"
3576+
},
3577+
"title": "Extra set tag",
3578+
"type": [
3579+
"array",
3580+
"null"
3581+
]
3582+
},
3583+
"extra-suites": {
3584+
"default": null,
3585+
"description": "Appends entries to the --suite option.\n\n---\n\nInclude suites by name.\n\n---\ncorresponds to the `-s --suite name *` option of _robot_\n",
3586+
"items": {
3587+
"type": "string"
3588+
},
3589+
"title": "Extra suites",
3590+
"type": [
3591+
"array",
3592+
"null"
3593+
]
3594+
},
3595+
"extra-tests": {
3596+
"default": null,
3597+
"description": "Appends entries to the --test option.\n\n---\n\nInclude tests by name.\n\n---\ncorresponds to the `-t --test name *` option of _robot_\n",
3598+
"items": {
3599+
"type": "string"
3600+
},
3601+
"title": "Extra tests",
3602+
"type": [
3603+
"array",
3604+
"null"
3605+
]
3606+
},
3607+
"includes": {
3608+
"default": null,
3609+
"description": "Include tests by tags.\n\n---\ncorresponds to the `-i --include tag *` option of _robot_\n",
3610+
"items": {
3611+
"type": "string"
3612+
},
3613+
"title": "Includes",
3614+
"type": [
3615+
"array",
3616+
"null"
3617+
]
3618+
},
3619+
"metadata": {
3620+
"additionalProperties": {
3621+
"type": "string"
3622+
},
3623+
"default": null,
3624+
"description": "Set/override metadata of the top level suite.\n\n---\ncorresponds to the `-M --metadata name:value *` option of _robot_\n",
3625+
"title": "Metadata",
3626+
"type": [
3627+
"object",
3628+
"null"
3629+
]
3630+
},
3631+
"name": {
3632+
"default": null,
3633+
"description": "Override the name of the top level suite.\n\n---\ncorresponds to the `-N --name name` option of _robot_\n",
3634+
"title": "Name",
3635+
"type": [
3636+
"string",
3637+
"null"
3638+
]
3639+
},
3640+
"set-tag": {
3641+
"default": null,
3642+
"description": "Set given tag(s) to all test cases.\n\n---\ncorresponds to the `-G --settag tag *` option of _robot_\n",
3643+
"items": {
3644+
"type": "string"
3645+
},
3646+
"title": "Set tag",
3647+
"type": [
3648+
"array",
3649+
"null"
3650+
]
3651+
},
3652+
"suites": {
3653+
"default": null,
3654+
"description": "Include suites by name.\n\n---\ncorresponds to the `-s --suite name *` option of _robot_\n",
3655+
"items": {
3656+
"type": "string"
3657+
},
3658+
"title": "Suites",
3659+
"type": [
3660+
"array",
3661+
"null"
3662+
]
3663+
},
3664+
"tests": {
3665+
"default": null,
3666+
"description": "Include tests by name.\n\n---\ncorresponds to the `-t --test name *` option of _robot_\n",
3667+
"items": {
3668+
"type": "string"
3669+
},
3670+
"title": "Tests",
3671+
"type": [
3672+
"array",
3673+
"null"
3674+
]
3675+
},
3676+
"title": {
3677+
"default": null,
3678+
"description": "Set the title of the generated documentation.\nUnderscores in the title are converted to spaces.\nThe default title is the name of the top level suite.\n\n---\ncorresponds to the `-T --title title` option of _robot_\n",
3679+
"title": "Title",
3680+
"type": [
3681+
"string",
3682+
"null"
3683+
]
3684+
}
3685+
},
3686+
"title": "TestDocProfile",
3687+
"type": "object"
34833688
}
34843689
},
34853690
"x-taplo-info": {

0 commit comments

Comments
 (0)