feat(robotcode): internal cli args are now hidden

If you want to show these args set the environment variable `ROBOTCODE_SHOW_HIDDEN_ARGS` to `true` or `1`.

Author: d-biehl

packages/core/src/robotcode/core/lsp/__init__.py

@@ -0,0 +1,5 @@
+import os
+
+
+def show_hidden_arguments() -> bool:
+    return os.environ.get("ROBOTCODE_SHOW_HIDDEN_ARGS", "").lower() not in ["true", "1"]

packages/core/src/robotcode/core/utils/__init__.py

@@ -2,6 +2,7 @@
 
 import click
 from robotcode.core.types import ServerMode
+from robotcode.core.utils.cli import show_hidden_arguments
 from robotcode.plugin import Application, UnknownError, pass_application
 from robotcode.plugin.click_helper.options import resolve_server_options, server_options
 from robotcode.plugin.click_helper.types import (
@@ -17,7 +18,7 @@
 
 @click.command(
     add_help_option=True,
-    hidden=True,
+    hidden=show_hidden_arguments(),
 )
 @add_options(*server_options(ServerMode.STDIO, default_port=LAUNCHER_DEFAULT_PORT))
 @click.version_option(version=__version__, prog_name="RobotCode Launcher")

packages/core/src/robotcode/core/utils/cli.py

@@ -28,6 +28,7 @@
     Range,
 )
 from robotcode.core.uri import Uri
+from robotcode.core.utils.cli import show_hidden_arguments
 from robotcode.plugin import Application, OutputFormat, UnknownError, pass_application
 from robotcode.plugin.click_helper.types import add_options
 from robotcode.robot.utils import get_robot_version
@@ -335,7 +336,7 @@ def visit_test(self, test: TestCase) -> None:
     "--read-from-stdin",
     is_flag=True,
     help="Read file contents from stdin. This is an internal option.",
-    hidden=True,
+    hidden=show_hidden_arguments(),
 )
 @pass_application
 def discover(app: Application, read_from_stdin: bool) -> None:

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

@@ -4,6 +4,7 @@
 
 import click
 from robotcode.core.logging import LoggingDescriptor
+from robotcode.core.utils.cli import show_hidden_arguments
 from robotcode.plugin import Application, ColoredOutput, OutputFormat, pass_application
 from robotcode.plugin.click_helper.aliases import AliasedGroup
 from robotcode.plugin.click_helper.types import EnumChoice
@@ -98,17 +99,20 @@
     "-dp",
     type=click.Path(exists=False, resolve_path=False, path_type=str),
     multiple=True,
-    help="Default path to use if no path is given or defined in a profile. Can be specified multiple times.",
+    hidden=show_hidden_arguments(),
+    help="Default path to use if no path is given or defined in a profile. Can be specified multiple times. "
+    "**This is an internal option for running in vscode",
 )
 @click.option(
     "--launcher-script",
-    hidden=True,
+    hidden=show_hidden_arguments(),
     type=str,
     help="Path to the launcher script. This is an internal option.",
 )
 @click.option(
     "--debugpy",
     is_flag=True,
+    hidden=show_hidden_arguments(),
     help="Starts a debugpy session. "
     "**This is an internal option and should only be use if you want to debug _RobotCode_.**",
 )
@@ -117,11 +121,13 @@
     type=int,
     default=5678,
     show_default=True,
+    hidden=show_hidden_arguments(),
     help="Defines the port to use for the debugpy session.",
 )
 @click.option(
     "--debugpy-wait-for-client",
     is_flag=True,
+    hidden=show_hidden_arguments(),
     help="Waits for a debugpy client to connect before starting the debugpy session.",
 )
 @click.version_option(version=__version__, prog_name="robotcode")