feat: user default robot.toml config file

Instead of defining default settings like output-dir or python-path in VSCode a default config file is created in user directory. The default settings in VSCode are removed, but you can define them here again, but the prefered way is to use the `robot.toml` file in user directory.

Author: d-biehl

.vscode/launch.json

@@ -42,11 +42,9 @@
 				// "toml",
 				"--no-color",
 				"--no-pager",
-				"--default-path",
-				".",
 				//"config", "info", "desc",
-				"discover",
-				"info"
+				"config",
+				"files"
 			]
 		},
 		{

bundled_requirements.txt

@@ -3,3 +3,4 @@ click>=8.1.0
 pluggy>=1.0.0
 tomli > 2.0.0
 tomli_w >= 1.0.0
+platformdirs<3.9.0,>=3.2.0

package.json

@@ -449,14 +449,11 @@
           },
           "robotcode.robot.pythonPath": {
             "type": "array",
-            "default": [
-              "./lib",
-              "./resources"
-            ],
+            "default": [],
             "items": {
               "type": "string"
             },
-            "markdownDescription": "Specifies additional python paths for robotframework. Corresponds to the `--pythonpath` option of __robot__.\n\n> **WARNING:**\n>\n> The default value for this will changed in one of the next releases to `[]`, because there is the new `robot.toml` configuration file. Please use this file to configure the python path.",
+            "markdownDescription": "Specifies additional python paths for robotframework. Corresponds to the `--pythonpath` option of __robot__.",
             "scope": "resource"
           },
           "robotcode.robot.env": {
@@ -497,8 +494,8 @@
           },
           "robotcode.robot.outputDir": {
             "type": "string",
-            "default": "results",
-            "markdownDescription": "Specifies the output directory where robotframework saves output files. Corresponds to the `--outputdir` option of __robot__.\n\n> **WARNING:**\n>\n> The default value for this will changed in one of the next releases to `\"\"`, because there is the new `robot.toml` configuration file. Please use this file to configure the output directory.",
+            "default": "",
+            "markdownDescription": "Specifies the output directory where robotframework saves output files. Corresponds to the `--outputdir` option of __robot__.",
             "scope": "resource"
           },
           "robotcode.robot.mode": {

packages/robot/pyproject.toml

@@ -28,6 +28,7 @@ classifiers = [
 dependencies = [
   "robotframework>=4.1.0",
   "tomli>=1.1.0; python_version < '3.11'",
+  "platformdirs<3.9.0,>=3.2.0",
   "robotcode-core==0.48.0",
 ]
 dynamic = ["version"]

packages/robot/src/robotcode/robot/config/loader.py

@@ -16,22 +16,25 @@
 PYPROJECT_TOML = "pyproject.toml"
 ROBOT_TOML = "robot.toml"
 LOCAL_ROBOT_TOML = ".robot.toml"
+USER_DEFAULT_CONFIG_TOML = "default config"
 
 
 class DiscoverdBy(str, Enum):
     GIT = ".git directory"
     HG = "hg"
-    PYPROJECT_TOML = PYPROJECT_TOML
-    ROBOT_TOML = ROBOT_TOML
-    LOCAL_ROBOT_TOML = LOCAL_ROBOT_TOML
+    PYPROJECT_TOML = "pyproject.toml (project file))"
+    ROBOT_TOML = "robot.toml (project file)"
+    LOCAL_ROBOT_TOML = ".robot.toml (local file)"
+    USER_DEFAULT_CONFIG_TOML = "robot.toml (user default config)"
     NOT_FOUND = "not found"
 
 
 class ConfigType(str, Enum):
-    PYPROJECT_TOML = PYPROJECT_TOML
-    ROBOT_TOML = ROBOT_TOML
-    LOCAL_ROBOT_TOML = LOCAL_ROBOT_TOML
-    CUSTOM_TOML = ".toml"
+    PYPROJECT_TOML = "pyproject.toml (project file))"
+    ROBOT_TOML = "robot.toml (project file)"
+    LOCAL_ROBOT_TOML = ".robot.toml (local file)"
+    USER_DEFAULT_CONFIG_TOML = "robot.toml (user default config)"
+    CUSTOM_TOML = ".toml (custom file)"
 
 
 class ConfigValueError(ValueError):
@@ -72,6 +75,13 @@ def _load_config_data_from_path(__path: Path) -> RobotConfig:
         raise ConfigTypeError(__path, f'Parsing "{__path}" failed: {e}') from e
 
 
+def get_default_config() -> RobotConfig:
+    result = RobotConfig()
+    result.output_dir = "results"
+    result.python_path = ["./lib", "./resources"]
+    return result
+
+
 def load_config_from_path(*__paths: Union[Path, Tuple[Path, ConfigType]]) -> RobotConfig:
     result = RobotConfig()
 

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

@@ -8,6 +8,7 @@
 import re
 from dataclasses import dataclass
 from enum import Enum
+from pathlib import Path
 from typing import (
     Any,
     Callable,
@@ -20,7 +21,8 @@
     get_type_hints,
 )
 
-from robotcode.core.dataclasses import TypeValidationError, ValidateMixin, validate_types
+import tomli_w
+from robotcode.core.dataclasses import TypeValidationError, ValidateMixin, as_dict, validate_types
 from robotcode.core.utils.safe_eval import safe_eval
 from typing_extensions import Self
 
@@ -2101,6 +2103,11 @@ class RobotBaseProfile(CommonOptions, CommonExtraOptions, RobotOptions, RobotExt
         """
     )
 
+    def save(self, path: os.PathLike[str]) -> None:
+        Path(path).parent.mkdir(parents=True, exist_ok=True)
+        with Path(path).open("w", encoding="utf-8") as f:
+            f.write(tomli_w.dumps(as_dict(self, remove_defaults=True)))
+
 
 @dataclass
 class RobotExtraBaseProfile(RobotBaseProfile):

packages/robot/src/robotcode/robot/config/utils.py

@@ -1,12 +1,31 @@
 from pathlib import Path
 from typing import Callable, Optional, Sequence, Tuple, Union
 
-from .loader import (
-    ConfigType,
-    DiscoverdBy,
-    find_project_root,
-    get_config_files_from_folder,
-)
+import platformdirs
+
+from .loader import ConfigType, DiscoverdBy, find_project_root, get_config_files_from_folder, get_default_config
+
+
+def get_user_config_file(
+    create: bool = True, verbose_callback: Optional[Callable[[str], None]] = None
+) -> Optional[Path]:
+    result = Path(platformdirs.user_config_dir("robotcode", appauthor=False), "robot.toml")
+    if result.is_file():
+        if verbose_callback:
+            verbose_callback(f"Found user configuration file:\n    {result}")
+        return result
+
+    if not create:
+        if verbose_callback:
+            verbose_callback("User configuration file not found, but create is set to False.")
+        return None
+
+    if verbose_callback:
+        verbose_callback(f"User configuration file not found, try to create it at:\n    {result}")
+
+    get_default_config().save(result)
+
+    return result
 
 
 def get_config_files(
@@ -30,21 +49,27 @@ def get_config_files(
 
     if config_files:
         if verbose_callback:
-            verbose_callback("Using config file:" + "\n    ".join(str(config_files)))
+            verbose_callback("Using config file:" + "\n    ".join([str(f) for f in config_files]))
 
-        return [(f, ConfigType.CUSTOM_TOML) for f in config_files], root_folder, discovered_by
+        result: Sequence[Tuple[Path, ConfigType]] = [(f, ConfigType.CUSTOM_TOML) for f in config_files]
+    else:
+        result = get_config_files_from_folder(root_folder)
 
-    result = get_config_files_from_folder(root_folder)
+        if not result and raise_on_error:
+            raise FileNotFoundError("Cannot find any configuration file. 😥")
 
-    if not result and raise_on_error:
-        raise FileNotFoundError("Cannot find any configuration file. 😥")
+        if verbose_callback:
+            if result:
+                verbose_callback(
+                    "Found configuration files:\n    " + "\n    ".join(str(f[0]) for f in result),
+                )
+            else:
+                verbose_callback("No configuration files found.")
 
-    if verbose_callback:
-        if result:
-            verbose_callback(
-                "Found configuration files:\n    " + "\n    ".join(str(f[0]) for f in result),
-            )
-        else:
-            verbose_callback("No configuration files found.")
-
-    return result, root_folder, discovered_by
+    user_config = get_user_config_file(verbose_callback=verbose_callback)
+
+    return (
+        [*([(user_config, ConfigType.USER_DEFAULT_CONFIG_TOML)] if user_config else []), *result],
+        root_folder,
+        discovered_by,
+    )

src/robotcode/cli/commands/config.py

@@ -50,9 +50,9 @@ def show(
     robotcode --format json config show
     ```
     """
-    config_files, _, _ = get_config_files(paths, app.config.config_files, verbose_callback=app.verbose)
-
     try:
+        config_files, _, _ = get_config_files(paths, app.config.config_files, verbose_callback=app.verbose)
+
         if single:
             for file, _ in config_files:
                 config = load_config_from_path(file)
@@ -65,17 +65,15 @@ def show(
 
         app.print_data(config, remove_defaults=True, default_output_format=OutputFormat.TOML)
 
-    except (TypeError, ValueError) as e:
+    except (TypeError, ValueError, OSError) as e:
         raise UnknownError(str(e)) from e
 
 
 @config.command
 @click.argument("paths", type=click.Path(exists=True, path_type=Path), nargs=-1, required=False)
+@click.argument("user", type=bool, default=False)
 @pass_application
-def files(
-    app: Application,
-    paths: List[Path],
-) -> None:
+def files(app: Application, paths: List[Path], user: bool = False) -> None:
     """\
     Search for _robot_ configuration files and list them.
 
@@ -112,11 +110,11 @@ def files(
 
         if app.config.output_format is None or app.config.output_format == OutputFormat.TEXT:
             for entry in result["files"]:
-                app.echo(entry["path"])
+                app.echo(f'{entry["path"]} ({entry["type"].value})')
         else:
             app.print_data(result)
 
-    except FileNotFoundError as e:
+    except OSError as e:
         raise UnknownError(str(e)) from e
 
 

src/robotcode/cli/commands/profiles.py

@@ -41,7 +41,7 @@ def show(
 
         app.print_data(config, remove_defaults=True, default_output_format=OutputFormat.TOML)
 
-    except (TypeError, ValueError, FileNotFoundError) as e:
+    except (TypeError, ValueError, OSError) as e:
         raise UnknownError(str(e)) from e
 
 
@@ -90,5 +90,5 @@ def list(
         else:
             app.print_data(result)
 
-    except (TypeError, ValueError, FileNotFoundError) as e:
+    except (TypeError, ValueError, OSError) as e:
         raise UnknownError(str(e)) from e