chore: rename configurations to profile and add set additionalproperties to false

Author: d-biehl

etc/robot.json

@@ -1,8 +1,10 @@
 {
   "$id": "robotframework:https://raw.githubusercontent.com/d-biehl/robotcode/main/etc/robot.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
+  "additionalProperties": false,
   "definitions": {
     "DetachableConfiguration": {
+      "additionalProperties": false,
       "properties": {
         "args": {
           "description": "Extra arguments to be passed to Robot Framework\n\nExamples:\n```toml\nargs = [\"-t\", \"abc\"]\n```\n",
@@ -25,9 +27,9 @@
           "title": "Detached",
           "type": "boolean"
         },
-        "documentation": {
-          "description": "Documentation for the test suite.",
-          "title": "Documentation",
+        "doc": {
+          "description": "Set the documentation of the top level suite.\nSimple formatting is supported (e.g. *bold*). If the\ndocumentation contains spaces, it must be quoted.\nIf the value is path to an existing file, actual\ndocumentation is read from that file.\n\nExamples:\n```toml\ndoc = \"\"\"Very *good* example\n\nThis is a second paragraph.\n\"\"\"\n```\n",
+          "title": "Doc",
           "type": "string"
         },
         "dry-run": {
@@ -38,7 +40,7 @@
           "additionalProperties": {
             "type": "string"
           },
-          "description": "Environment variables to be set before running tests.\n\nExamples:\n```toml\n[env]\nTEST_VAR = \"test\"\nSECRET = \"password\"\n```\n",
+          "description": "Set variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`\n\nExamples:\n```toml\n[env]\nTEST_VAR = \"test\"\nSECRET = \"password\"\n```\n",
           "title": "Env",
           "type": "object"
         },
@@ -130,6 +132,7 @@
           "type": "array"
         },
         "variables": {
+          "description": "Set variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`\n\nExamples:\n```toml\n[variables]\nTEST_VAR = \"test\"\nSECRET = \"password\"\n```\n",
           "title": "Variables",
           "type": "object"
         }
@@ -157,14 +160,6 @@
       "title": "Args",
       "type": "array"
     },
-    "configurations": {
-      "additionalProperties": {
-        "$ref": "#/definitions/DetachableConfiguration"
-      },
-      "description": "Configurations for Robot Framework.",
-      "title": "Configurations",
-      "type": "object"
-    },
     "console": {
       "title": "Console",
       "type": "string"
@@ -173,9 +168,9 @@
       "title": "Debug-File",
       "type": "string"
     },
-    "documentation": {
-      "description": "Documentation for the test suite.",
-      "title": "Documentation",
+    "doc": {
+      "description": "Set the documentation of the top level suite.\nSimple formatting is supported (e.g. *bold*). If the\ndocumentation contains spaces, it must be quoted.\nIf the value is path to an existing file, actual\ndocumentation is read from that file.\n\nExamples:\n```toml\ndoc = \"\"\"Very *good* example\n\nThis is a second paragraph.\n\"\"\"\n```\n",
+      "title": "Doc",
       "type": "string"
     },
     "dry-run": {
@@ -186,7 +181,7 @@
       "additionalProperties": {
         "type": "string"
       },
-      "description": "Environment variables to be set before running tests.\n\nExamples:\n```toml\n[env]\nTEST_VAR = \"test\"\nSECRET = \"password\"\n```\n",
+      "description": "Set variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`\n\nExamples:\n```toml\n[env]\nTEST_VAR = \"test\"\nSECRET = \"password\"\n```\n",
       "title": "Env",
       "type": "object"
     },
@@ -262,6 +257,14 @@
       "title": "Pre-Run-Modifiers",
       "type": "object"
     },
+    "profiles": {
+      "additionalProperties": {
+        "$ref": "#/definitions/DetachableConfiguration"
+      },
+      "description": "Execution Profiles.",
+      "title": "Profiles",
+      "type": "object"
+    },
     "python-path": {
       "description": "Additional locations directories where\nto search test libraries and other extensions when\nthey are imported. Given path can also be a glob\npattern matching multiple paths.\n\nExamples:\n```toml\npython_path = [\"./lib\", \"./resources\"]\n```\n",
       "items": {
@@ -278,6 +281,7 @@
       "type": "array"
     },
     "variables": {
+      "description": "Set variables in the test data. Only scalar\nvariables with string value are supported and name is\ngiven without `${}`\n\nExamples:\n```toml\n[variables]\nTEST_VAR = \"test\"\nSECRET = \"password\"\n```\n",
       "title": "Variables",
       "type": "object"
     }

packages/robot/robotcode/robot/config/model.py

@@ -40,7 +40,26 @@ def _decode_case(cls, s: str) -> str:
 """
         },
     )
-    documentation: Optional[str] = field(default=None, metadata={"description": "Documentation for the test suite."})
+    doc: Optional[str] = field(
+        default=None,
+        metadata={
+            "description": """\
+Set the documentation of the top level suite.
+Simple formatting is supported (e.g. *bold*). If the
+documentation contains spaces, it must be quoted.
+If the value is path to an existing file, actual
+documentation is read from that file.
+
+Examples:
+```toml
+doc = \"\"\"Very *good* example
+
+This is a second paragraph.
+\"\"\"
+```
+"""
+        },
+    )
     """Arguments to be passed to Robot Framework"""
     python_path: List[str] = field(
         default_factory=list,
@@ -62,7 +81,9 @@ def _decode_case(cls, s: str) -> str:
         default_factory=dict,
         metadata={
             "description": """\
-Environment variables to be set before running tests.
+Set variables in the test data. Only scalar
+variables with string value are supported and name is
+given without `${}`
 
 Examples:
 ```toml
@@ -73,7 +94,39 @@ def _decode_case(cls, s: str) -> str:
 """
         },
     )
-    variables: Dict[str, Any] = field(default_factory=dict)
+    variables: Dict[str, Any] = field(
+        default_factory=dict,
+        metadata={
+            "description": """\
+Set variables in the test data. Only scalar
+variables with string value are supported and name is
+given without `${}`
+
+Examples:
+```toml
+[variables]
+TEST_VAR = "test"
+SECRET = "password"
+```
+"""
+        },
+    )
+    meta_data: Dict[str, Any] = field(
+        default_factory=dict,
+        metadata={
+            "description": """\
+Set metadata of the top level suite. Value can
+contain formatting and be read from a file similarly
+
+Examples:
+```toml
+[meta-data]
+Version = "1.2"
+Release = "release.txt"
+```
+"""
+        },
+    )
     variable_files: List[str] = field(default_factory=list)
     paths: List[str] = field(default_factory=list)
     output_dir: Optional[str] = None
@@ -83,7 +136,6 @@ def _decode_case(cls, s: str) -> str:
     log_level: Optional[str] = None
     console: Optional[str] = None
     mode: Optional[Mode] = None
-    meta_data: List[str] = field(default_factory=list)
     languages: List[str] = field(default_factory=list)
     parsers: Dict[str, List[Any]] = field(default_factory=dict)
     pre_run_modifiers: Dict[str, List[Any]] = field(default_factory=dict)
@@ -104,9 +156,9 @@ class DetachableConfiguration(BaseConfiguration):
 class Configuration(BaseConfiguration):
     """Configuration for Robot Framework."""
 
-    configurations: Dict[str, DetachableConfiguration] = field(
+    profiles: Dict[str, DetachableConfiguration] = field(
         default_factory=dict,
-        metadata={"description": "Configurations for Robot Framework."},
+        metadata={"description": "Execution Profiles."},
     )
 
 
@@ -119,6 +171,9 @@ class Configuration(BaseConfiguration):
 #     class Config:
 #         title = "robot.toml"
 #         description = "Configuration for Robot Framework."
+#         schema_extra = {
+#             "additionalProperties": False,
+#         }
 
 #         @classmethod
 #         def alias_generator(cls, string: str) -> str:
@@ -129,9 +184,7 @@ class Configuration(BaseConfiguration):
 #     schema = model.schema()
 
 #     schema["$schema"] = "http://json-schema.org/draft-07/schema#"
-#     schema[
-#         "$id"
-#     ] = "robotframework:https://raw.githubusercontent.com/d-biehl/robotcode/main/etc/robot.json"
+#     schema["$id"] = "robotframework:https://raw.githubusercontent.com/d-biehl/robotcode/main/etc/robot.json"
 #     schema["x-taplo-info"] = {
 #         "authors": ["d-biehl (https://github.com/d-biehl)"],
 #         "patterns": ["^(.*(/|\\\\)robot\\.toml|robot\\.toml)$"],

tests/robotcode/language_server/robotframework/parts/data/robot.toml

@@ -1,6 +1,5 @@
 args = []
-
-python_path = []
+python-path = []
 documentation = """\
 This is a *sample* test suite
 
@@ -19,19 +18,19 @@ c = [1, 2, "hello World"]
 MyListener = []
 Abc = ["def", 1]
 
-[configurations.default]
+[profiles.default]
 args = ["abc"]
-python_path = ["abc", "def"]
+python-path = ["abc", "def"]
 
-[configurations.default.envs]
+[profiles.default.envs]
 ENV_VAR2 = "2"
 
-[configurations.devel]
+[profiles.devel]
 mode = "default"
 
-[configurations.devel.listeners]
+[profiles.devel.listeners]
 AnotherListener = ["default"]
 
-[configs.devel_detached]
+[profiles.devel-detached]
 detached = true
 mode = "default"