Skip to content

Commit f7c0693

Browse files
committed
docs: update json schema and doc for robot.toml file
1 parent fc73ba6 commit f7c0693

File tree

3 files changed

+29
-2
lines changed

3 files changed

+29
-2
lines changed

docs/cli/config.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2382,6 +2382,30 @@ Type: Any
23822382

23832383
Tool configuration.
23842384

2385+
## tool.robotcode-analyze.extra-ignore
2386+
2387+
Type: Optional[List[str]]
2388+
2389+
Ignores which rules are run.
2390+
2391+
## tool.robotcode-analyze.extra-select
2392+
2393+
Type: Optional[List[Union[str, robotcode.analyze.cli.Dummy]]]
2394+
2395+
Selects which rules are run.
2396+
2397+
## tool.robotcode-analyze.ignore
2398+
2399+
Type: Optional[List[str]]
2400+
2401+
Ignores which rules are run.
2402+
2403+
## tool.robotcode-analyze.select
2404+
2405+
Type: Optional[List[Union[str, robotcode.analyze.cli.Dummy]]]
2406+
2407+
Selects which rules are run.
2408+
23852409
## variable-files
23862410

23872411
Type: Optional[List[Union[str, StringExpression]]]
@@ -2426,3 +2450,5 @@ xUnit compatible result file. Not created unless this
24262450
option is specified.
24272451

24282452
corresponds to the `-x --xunit file` option of _robot_
2453+
2454+

etc/robot.toml.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"description": "Condition to evaluate.",
1212
"properties": {
1313
"if": {
14-
"description": "Condition to evaluate. This must be a Python \"eval\" expression.\nFor security reasons, only certain expressions and functions are allowed.\n\nExamples:\n```toml\nif = \"re.match(r'^\\d+$', environ.get('TEST_VAR', ''))\"\nif = \"platform.system() == 'Linux'\"\n```\n",
14+
"description": "Condition to evaluate. This must be a Python \"eval\" expression.\nFor security reasons, only certain expressions and functions are allowed.\n\nExamples:\n```toml\nif = \"re.match(r'^\\d+$', environ.get('TEST_VAR', ''))\"\nif = \"platform.system() == 'Linux'\"\n```\n\nsee also `expr` for allowed global names.\n",
1515
"title": "If ",
1616
"type": "string"
1717
}
@@ -4911,7 +4911,7 @@
49114911
"description": "Expression to evaluate to a string.",
49124912
"properties": {
49134913
"expr": {
4914-
"description": "Condition to evaluate. This must be a Python \"eval\" expression.\nFor security reasons, only certain expressions and functions are allowed.\n\nExamples:\n```toml\nif = \"re.match(r'^\\d+$', environ.get('TEST_VAR', ''))\"\nif = \"platform.system() == 'Linux'\"\n```\n",
4914+
"description": "Expression to evaluate. This must be a Python \"eval\" expression.\nFor security reasons, only certain expressions and functions are allowed.\n\nExamples:\n```toml\nexpr = \"re.match(r'^\\d+$', environ.get('TEST_VAR', ''))\"\nexpr = \"platform.system() == 'Linux'\"\nexpr = \"Path.cwd() / 'app'\"\n```\n\nAllowed global names (the name and the corresponding python module/name):\n\n- `environ` -> os.environ\n- `re` -> re\n- `platform` -> platform\n- `datetime` -> datetime.datetime\n- `date` -> datetime.date\n- `time` -> datetime.time\n- `timedelta` -> datetime.timedelta\n- `timezone` -> datetime.timezone\n- `Path` -> pathlib.Path\n",
49154915
"title": "Expr",
49164916
"type": "string"
49174917
}

hatch.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ fmt = ["black .", "ruff --fix .", "style", "npx eslint --fix ."]
112112
all = ["style", "typing"]
113113

114114
[envs.pages]
115+
python = "3.11"
115116
#detached = true
116117
extra-dependencies = [
117118
"mkdocs>=1.4.2",

0 commit comments

Comments
 (0)