feat(runner): add run alias for robot command in cli

Author: d-biehl

.vscode/launch.json

@@ -51,14 +51,15 @@
 				"CMD_VAR_LONG": "long",
 			},
 			"args": [
-				"--verbose",
+				// "--verbose",
 				// "robot"
 				// "debug-launch",
 				// "--pipe-server",
 				// "\\\\.\\pipe\\926ab05cd224ef08dc3aec29eda1ba61"
-				"debug",
-				"--",
-				"--help"
+				// "debug",
+				// "--",
+				// "--help"
+				"run"
 			]
 		},
 		{

packages/debugger/src/robotcode/debugger/cli.py

@@ -4,11 +4,11 @@
 import click
 from robotcode.core.types import ServerMode
 from robotcode.plugin import Application, UnknownError, pass_application
-from robotcode.plugin.click_helper.helper import (
+from robotcode.plugin.click_helper.server_options import resolve_server_options, server_options
+from robotcode.plugin.click_helper.types import (
     AddressesPort,
     add_options,
 )
-from robotcode.plugin.click_helper.server_options import resolve_server_options, server_options
 
 from .__version__ import __version__
 from .run import run_debugger

packages/debugger/src/robotcode/debugger/launcher/cli.py

@@ -3,11 +3,11 @@
 import click
 from robotcode.core.types import ServerMode
 from robotcode.plugin import Application, UnknownError, pass_application
-from robotcode.plugin.click_helper.helper import (
+from robotcode.plugin.click_helper.server_options import resolve_server_options, server_options
+from robotcode.plugin.click_helper.types import (
     AddressesPort,
     add_options,
 )
-from robotcode.plugin.click_helper.server_options import resolve_server_options, server_options
 
 from ..__version__ import __version__
 from .run import run_launcher

packages/plugin/src/robotcode/plugin/click_helper/aliases.py

@@ -0,0 +1,49 @@
+from typing import Any, Optional, Sequence
+
+import click
+
+
+class AliasedCommand(click.Command):
+    def __init__(self, *args: Any, aliases: Sequence[str] = [], **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.aliases = aliases
+
+
+class AliasedGroup(click.Group):
+    def get_command(self, ctx: click.Context, cmd_name: str) -> Optional[click.Command]:
+        rv = super().get_command(ctx, cmd_name)
+        if rv is not None:
+            return rv
+
+        for name, cmd in self.commands.items():
+            if isinstance(cmd, AliasedCommand) and cmd_name in cmd.aliases:
+                return cmd
+
+        return None
+
+    def format_commands(self, ctx: click.Context, formatter: click.HelpFormatter) -> None:
+        super().format_commands(ctx, formatter)
+
+        commands = []
+        for subcommand in self.list_commands(ctx):
+            cmd = self.get_command(ctx, subcommand)
+            if cmd is None:
+                continue
+            if cmd.hidden:
+                continue
+
+            if isinstance(cmd, AliasedCommand) and cmd.aliases:
+                subcommand = f"{', '.join(cmd.aliases)}"
+                commands.append((subcommand, cmd))
+
+        if len(commands):
+            limit = formatter.width - 6 - max(len(cmd[0]) for cmd in commands)
+
+            rows = []
+            for subcommand, cmd in commands:
+                help = cmd.get_short_help_str(limit)
+                rows.append((subcommand, help))
+                rows.append(("", f"(Alias for `{cmd.name}` command)"))
+            if rows:
+                with formatter.section("Aliases"):
+                    formatter.write_dl(rows)

packages/plugin/src/robotcode/plugin/click_helper/server_options.py

@@ -3,7 +3,7 @@
 import click
 from robotcode.core.types import ServerMode
 from robotcode.plugin import Application
-from robotcode.plugin.click_helper.helper import (
+from robotcode.plugin.click_helper.types import (
     AddressesPort,
     AddressParamType,
     AddressPortParamType,
@@ -13,7 +13,7 @@
     PortParamType,
 )
 
-from .helper import FC
+from .types import FC
 
 
 def server_options(

packages/plugin/src/robotcode/plugin/click_helper/helper.py renamed to packages/plugin/src/robotcode/plugin/click_helper/types.py

@@ -7,6 +7,7 @@
 from robot.run import USAGE, RobotFramework
 from robot.version import get_full_version
 from robotcode.plugin import Application, pass_application
+from robotcode.plugin.click_helper.aliases import AliasedCommand
 from robotcode.robot.config.loader import load_config_from_path
 from robotcode.robot.config.utils import get_config_files
 
@@ -54,6 +55,8 @@ def main(self, arguments: Any, **options: Any) -> Any:
 
 
 @click.command(
+    cls=AliasedCommand,
+    aliases=["run"],
     context_settings={
         "allow_extra_args": True,
         "ignore_unknown_options": True,
@@ -85,6 +88,11 @@ def robot(
     """Runs `robot` with the selected configuration, profiles, options and arguments.
 
     The options and arguments are passed to `robot` as is.
+
+    Examples:
+    ```
+    robotcode run
+    ```
     """
 
     robot_arguments: Optional[List[Union[str, Path]]] = None

packages/runner/src/robotcode/runner/cli/robot.py

@@ -5,13 +5,15 @@
 import click
 from robotcode.core.logging import LoggingDescriptor
 from robotcode.plugin import Application, ColoredOutput, pass_application
+from robotcode.plugin.click_helper.aliases import AliasedGroup
 from robotcode.plugin.manager import PluginManager
 
 from .__version__ import __version__
 from .commands import config, profiles
 
 
 @click.group(
+    cls=AliasedGroup,
     context_settings={"auto_envvar_prefix": "ROBOTCODE"},
     invoke_without_command=False,
 )

src/robotcode/cli/__init__.py

@@ -1,6 +1,6 @@
 import click
 from robotcode.plugin import OutputFormat
-from robotcode.plugin.click_helper.helper import EnumChoice
+from robotcode.plugin.click_helper.types import EnumChoice
 
 format_option = click.option(
     "-f",

src/robotcode/cli/commands/_common.py

@@ -6,7 +6,7 @@
 import click
 from robotcode.core.dataclasses import as_dict, encode_case
 from robotcode.plugin import Application, OutputFormat, UnknownError, pass_application
-from robotcode.plugin.click_helper.helper import add_options
+from robotcode.plugin.click_helper.types import add_options
 from robotcode.robot.config.loader import (
     find_project_root,
     load_config_from_path,