feat(config): added posibility to allow different tool configs to robot.toml.json schema

Author: d-biehl

etc/robot.toml.json

@@ -6,6 +6,106 @@
     }
   ],
   "definitions": {
+    "AnalyzerConfig": {
+      "additionalProperties": false,
+      "description": "Analyzer configuration.",
+      "properties": {
+        "cache-dir": {
+          "default": null,
+          "description": "Path to the cache directory.",
+          "title": "Cache dir",
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "exclude-patterns": {
+          "default": [],
+          "items": {
+            "type": "string"
+          },
+          "title": "Exclude patterns",
+          "type": "array"
+        },
+        "extend-ignore": {
+          "default": null,
+          "description": "Extends the rules which are ignored.",
+          "items": {
+            "type": "string"
+          },
+          "title": "Extend ignore",
+          "type": [
+            "array",
+            "null"
+          ]
+        },
+        "extend-select": {
+          "default": null,
+          "description": "Extends the rules which are run.",
+          "items": {
+            "type": "string"
+          },
+          "title": "Extend select",
+          "type": [
+            "array",
+            "null"
+          ]
+        },
+        "global-library-search-order": {
+          "default": [],
+          "description": "TODO\n",
+          "items": {
+            "type": "string"
+          },
+          "title": "Global library search order",
+          "type": "array"
+        },
+        "ignore": {
+          "default": null,
+          "description": "Defines which rules are ignored.",
+          "items": {
+            "type": "string"
+          },
+          "title": "Ignore",
+          "type": [
+            "array",
+            "null"
+          ]
+        },
+        "ignored-libraries": {
+          "default": [],
+          "description": "Specifies the library names that should not be cached.\nThis is useful if you have a dynamic or hybrid library that has different keywords depending on\nthe arguments. You can specify a glob pattern that matches the library name or the source file.\n\nExamples:\n- `**/mylibfolder/mylib.py`\n- `MyLib`\n- `mylib.subpackage.subpackage`\n\nFor robot framework internal libraries, you have to specify the full module name like\n`robot.libraries.Remote`.\n",
+          "items": {
+            "type": "string"
+          },
+          "title": "Ignored libraries",
+          "type": "array"
+        },
+        "ignored-variables": {
+          "default": [],
+          "description": "Specifies the variable files that should not be cached.\nThis is useful if you have a dynamic or hybrid variable files that has different variables\ndepending on the arguments. You can specify a glob pattern that matches the variable module\nname or the source file.\n\nExamples:\n- `**/variables/myvars.py`\n- `MyVariables`\n- `myvars.subpackage.subpackage`\n",
+          "items": {
+            "type": "string"
+          },
+          "title": "Ignored variables",
+          "type": "array"
+        },
+        "select": {
+          "default": null,
+          "description": "Selects which rules are run.",
+          "items": {
+            "type": "string"
+          },
+          "title": "Select",
+          "type": [
+            "array",
+            "null"
+          ]
+        }
+      },
+      "title": "AnalyzerConfig",
+      "type": "object"
+    },
     "Condition": {
       "additionalProperties": false,
       "description": "Condition to evaluate.",
@@ -3114,6 +3214,17 @@
           "title": "Timestamp outputs"
         },
         "tool": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/ToolConfig"
+            },
+            {
+              "type": "object"
+            },
+            {
+              "type": "null"
+            }
+          ],
           "default": null,
           "description": "Tool configurations.",
           "title": "Tool"
@@ -5393,6 +5504,27 @@
       },
       "title": "TestDocProfile",
       "type": "object"
+    },
+    "ToolConfig": {
+      "additionalProperties": false,
+      "description": "ToolConfig(robotcode_analyze: Union[robotcode.analyze.config.AnalyzerConfig, NoneType] = None)",
+      "properties": {
+        "robotcode-analyze": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/AnalyzerConfig"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "description": "Analyzer configuration.",
+          "title": "Robotcode analyze"
+        }
+      },
+      "title": "ToolConfig",
+      "type": "object"
     }
   },
   "x-taplo-info": {

packages/analyze/src/robotcode/analyze/config.py

@@ -13,6 +13,8 @@ class CacheSaveLocation(Enum):
 
 @dataclass
 class AnalyzerConfig(BaseOptions):
+    """Analyzer configuration."""
+
     select: Optional[List[str]] = field(description="Selects which rules are run.")
     extend_select: Optional[List[str]] = field(description="Extends the rules which are run.")
     ignore: Optional[List[str]] = field(description="Defines which rules are ignored.")

scripts/create_robot_toml_json_schema.py

@@ -1,12 +1,27 @@
 import json
 import pathlib
 import typing
-from dataclasses import fields, is_dataclass
-from typing import Any, Callable, Optional
+from dataclasses import dataclass, fields, is_dataclass
+from typing import Any, Callable, Dict, Optional, Union
 
 import apischema
 
-from robotcode.robot.config.model import RobotConfig
+from robotcode.analyze.config import AnalyzerConfig
+from robotcode.robot.config.model import RobotConfig as OrigRobotConfig
+from robotcode.robot.config.model import field
+
+
+@dataclass
+class ToolConfig:
+    robotcode_analyze: Optional[AnalyzerConfig] = field(description="Analyzer configuration.")  # noqa: RUF009
+
+
+@dataclass
+class RobotConfig(OrigRobotConfig):
+    tool: Union[ToolConfig, Dict[str, Any], None] = field(description="Tool configurations.")  # noqa: RUF009
+
+
+RobotConfig.__doc__ = OrigRobotConfig.__doc__
 
 if __name__ == "__main__":