refactor: move the config command to robotcode package

Author: d-biehl

etc/robot.toml.json

@@ -592,7 +592,7 @@
       "d-biehl (https://github.com/d-biehl)"
     ],
     "patterns": [
-      "^(.*(/|\\\\)\\.?robot\\.toml|\\.?robot\\.toml)$"
+      "^(.*(/|\\\\)robot\\.toml|robot\\.toml)$"
     ]
   }
 }

hatch.toml

@@ -23,7 +23,7 @@ dependencies = [
   "robotremoteserver",
   "apischema",
   "tomli-w",
-  "rich"
+  "rich",
 ]
 features = ["yaml", "rest", "lint", "tidy"]
 pre-install-commands = ["python ./scripts/install_packages.py"]

packages/robot/README.md

@@ -8,7 +8,7 @@
 
 ## Introduction
 
-Support classes and commands for [RobotCode](https://robotcode.io) for handling Robot Framework projects.
+Support classes for [RobotCode](https://robotcode.io) for handling Robot Framework projects.
 
 ## Installation
 

packages/robot/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "robotcode-robot"
-description = 'Some Robot Framework robot for RobotCode'
+description = 'Support classes for RobotCode for handling Robot Framework projects.'
 readme = { "file" = "README.md", "content-type" = "text/markdown" }
 requires-python = ">=3.8"
 license = "Apache-2.0"
@@ -29,13 +29,9 @@ dependencies = [
   "robotframework>=4.1.0",
   "tomli>=1.1.0; python_version < '3.11'",
   "robotcode-core",
-  "robotcode-plugin",
 ]
 dynamic = ["version"]
 
-[project.entry-points.robotcode]
-robot = "robotcode.robot.hooks"
-
 [project.urls]
 Homepage = "https://robotcode.io"
 Donate = "https://github.com/sponsors/d-biehl"

packages/robot/robotcode/robot/hooks.py

@@ -7,7 +7,7 @@ build-backend = "hatchling.build"
 name = "robotcode"
 description = "Language server, debugger and tools for Robot Framework"
 authors = [{ name = "Daniel Biehl", email = "[email protected]" }]
-readme = {"file" = "README.md", "content-type" = "text/markdown"}
+readme = { "file" = "README.md", "content-type" = "text/markdown" }
 license = { text = "Apache-2.0" }
 keywords = [
   "Test",
@@ -49,7 +49,7 @@ classifiers = [
   "Framework :: Robot Framework :: Tool",
 ]
 requires-python = ">=3.8"
-dependencies = ["robotcode-plugin"]
+dependencies = ["robotcode-plugin", "robotcode-robot"]
 dynamic = ["version"]
 
 
@@ -74,6 +74,15 @@ yaml = ["PyYAML>=5.4", "types-PyYAML>=5.4"]
 lint = ["robotframework-robocop>=2.0.0"]
 tidy = ["robotframework-tidy>=2.0.0"]
 rest = ["docutils"]
+all = [
+  "runner",
+  "debugger",
+  "language-server",
+  "analyze",
+  "yaml",
+  "lint",
+  "tidy",
+]
 
 
 [tool.semantic_release]
@@ -255,5 +264,5 @@ ignore_missing_imports = true
 
 [tool.pyright]
 exclude = ["**/.hatch", "**/node_modules", "**/__pycache__", "bundled/libs"]
-typeCheckingMode= "off"
+typeCheckingMode = "off"
 pythonVersion = "3.8"

pyproject.toml

@@ -7,6 +7,7 @@
 from robotcode.plugin.manager import PluginManager
 
 from .__version__ import __version__
+from .commands import config
 
 
 @click.group(
@@ -61,6 +62,8 @@ def robotcode(
     common_config.verbose = verbose
 
 
+robotcode.add_command(config)
+
 for p in PluginManager().cli_commands:
     for c in p:
         robotcode.add_command(c)

robotcode/cli/__init__.py

@@ -0,0 +1,3 @@
+from .config import config
+
+__all__ = ["config"]

robotcode/cli/commands/__init__.py

@@ -6,10 +6,8 @@
 
 from robotcode.core.dataclasses import as_dict, as_json
 from robotcode.plugin import CommonConfig, pass_common_config
-
-from ...__version__ import __version__
-from ..loader import find_project_root, get_config_files_from_folder, load_config_from_path
-from ..model import RobotConfig
+from robotcode.robot.config.loader import find_project_root, get_config_files_from_folder, load_config_from_path
+from robotcode.robot.config.model import RobotConfig
 
 if sys.version_info >= (3, 11):
     pass
@@ -21,7 +19,6 @@
     context_settings={"help_option_names": ["-h", "--help"], "auto_envvar_prefix": "ROBOTCODE"},
     invoke_without_command=False,
 )
-@click.version_option(version=__version__, package_name="robotcode.robot.config", prog_name="RobotCode Config")
 @click.pass_context
 @pass_common_config
 def config(
@@ -36,6 +33,40 @@ def config(
     return 0
 
 
+def print_config(config: RobotConfig, format: str, color: str) -> int:
+    text = None
+    if format == "toml":
+        try:
+            import tomli_w
+
+            text = tomli_w.dumps(as_dict(config, remove_defaults=True))
+        except ImportError:
+            click.secho("tomli-w is required to output toml.", fg="red", err=True)
+
+            format = "json"
+
+    if text is None:
+        text = as_json(config, indent=True)
+
+    if color in ["auto", "yes"]:
+        try:
+            from rich.console import Console
+            from rich.syntax import Syntax
+
+            Console().print(Syntax(text, format, background_color="default"))
+
+            return 0
+        except ImportError:
+            if color == "yes":
+                click.secho("rich is required to use colors.", fg="red", err=True)
+                return 1
+            pass
+
+    click.echo(text)
+
+    return 0
+
+
 @config.command
 @click.option(
     "-f", "--format", "format", type=click.Choice(["json", "toml"]), default="toml", help="Set the output format."
@@ -97,37 +128,3 @@ def show(
         return 1
 
     return print_config(config, format, color)
-
-
-def print_config(config: RobotConfig, format: str, color: str) -> int:
-    text = None
-    if format == "toml":
-        try:
-            import tomli_w
-
-            text = tomli_w.dumps(as_dict(config, remove_defaults=True))
-        except ImportError:
-            click.secho("tomli-w is required to output toml.", fg="red", err=True)
-
-            format = "json"
-
-    if text is None:
-        text = as_json(config, indent=True)
-
-    if color in ["auto", "yes"]:
-        try:
-            from rich.console import Console
-            from rich.syntax import Syntax
-
-            Console().print(Syntax(text, format, background_color="default"))
-
-            return 0
-        except ImportError:
-            if color == "yes":
-                click.secho("rich is required to use colors.", fg="red", err=True)
-                return 1
-            pass
-
-    click.echo(text)
-
-    return 0

packages/robot/robotcode/robot/config/cli/__init__.py renamed to robotcode/cli/commands/config.py

@@ -54,18 +54,27 @@ def method_base_schema(tp: Any, method: Callable[..., Any], alias: str) -> Optio
     apischema.settings.base_schema.field = field_base_schema
     apischema.settings.base_schema.method = method_base_schema
 
+    base_schema = apischema.schema(
+        extra={
+            "x-taplo-info": {
+                "authors": ["d-biehl (https://github.com/d-biehl)"],
+                "patterns": ["^(.*(/|\\\\)robot\\.toml|robot\\.toml)$"],
+            }
+        }
+    )
     schema = apischema.json_schema.deserialization_schema(
         RobotConfig,
         additional_properties=False,
         aliaser=lambda x: x.replace("_", "-"),
         version=apischema.json_schema.JsonSchemaVersion.DRAFT_7,
         all_refs=True,
+        schema=base_schema,
     )
 
-    schema["x-taplo-info"] = {
-        "authors": ["d-biehl (https://github.com/d-biehl)"],
-        "patterns": ["^(.*(/|\\\\)robot\\.toml|robot\\.toml)$"],
-    }
+    # schema["x-taplo-info"] = {
+    #     "authors": ["d-biehl (https://github.com/d-biehl)"],
+    #     "patterns": ["^(.*(/|\\\\)robot\\.toml|robot\\.toml)$"],
+    # }
 
     json_str = json.dumps(schema, indent=2, sort_keys=True)
     pathlib.Path("etc", "robot.toml.json").write_text(json_str, "utf-8")