feat: --root command line argument to specify a project root and disable autodetection of project root

closes #201

Author: d-biehl

packages/analyze/src/robotcode/analyze/cli.py

@@ -26,7 +26,9 @@
 def analyze(app: Application, paths: Tuple[str]) -> Union[str, int, None]:
     """TODO: Analyzes a Robot Framework project."""
 
-    config_files, root_folder, _ = get_config_files(paths, app.config.config_files, verbose_callback=app.verbose)
+    config_files, root_folder, _ = get_config_files(
+        paths, app.config.config_files, root_folder=app.config.root, verbose_callback=app.verbose
+    )
 
     try:
         robot_config = load_robot_config_from_path(

packages/language_server/src/robotcode/language_server/cli.py

@@ -82,7 +82,9 @@ def language_server(
     profile: Optional[RobotBaseProfile] = None
     analysis_config: Optional[WorkspaceAnalysisConfig] = None
 
-    config_files, root_folder, _ = get_config_files(paths, app.config.config_files, verbose_callback=app.verbose)
+    config_files, root_folder, _ = get_config_files(
+        paths, app.config.config_files, root_folder=app.config.root, verbose_callback=app.verbose
+    )
     if root_folder:
         os.chdir(root_folder)
 

packages/plugin/src/robotcode/plugin/__init__.py

@@ -64,6 +64,7 @@ def __str__(self) -> str:
 class CommonConfig:
     config_files: Optional[Sequence[Path]] = None
     profiles: Optional[Sequence[str]] = None
+    root: Optional[Path] = None
     dry: bool = False
     verbose: bool = False
     colored_output: ColoredOutput = ColoredOutput.AUTO

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

@@ -28,6 +28,7 @@ class DiscoverdBy(str, Enum):
     LOCAL_ROBOT_TOML = ".robot.toml (local file)"
     USER_DEFAULT_CONFIG_TOML = "robot.toml (user default config)"
     NOT_FOUND = "not found"
+    COMMAND_LINE = "command line"
 
 
 class ConfigType(str, Enum):
@@ -191,7 +192,12 @@ def load_robot_config_from_path(
 
 def find_project_root(
     *sources: Union[str, Path],
+    root_folder: Optional[Path] = None,
 ) -> Tuple[Optional[Path], DiscoverdBy]:
+
+    if root_folder:
+        return root_folder.absolute(), DiscoverdBy.COMMAND_LINE
+
     if not sources:
         sources = (str(Path.cwd().absolute()),)
 

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

@@ -43,10 +43,11 @@ def get_user_config_file(
 def get_config_files(
     paths: Optional[Sequence[Union[str, Path]]] = None,
     config_files: Optional[Sequence[Path]] = None,
+    root_folder: Optional[Path] = None,
     *,
     verbose_callback: Optional[Callable[[str], None]] = None,
 ) -> Tuple[Sequence[Tuple[Path, ConfigType]], Optional[Path], DiscoverdBy]:
-    root_folder, discovered_by = find_project_root(*(paths or []))
+    root_folder, discovered_by = find_project_root(*(paths or []), root_folder=root_folder)
 
     if root_folder is None:
         root_folder = Path.cwd()

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

@@ -67,7 +67,7 @@ def libdoc(app: Application, robot_options_and_args: Tuple[str, ...]) -> None:
         pass
 
     config_files, root_folder, _ = get_config_files(
-        robot_arguments, app.config.config_files, verbose_callback=app.verbose
+        robot_arguments, app.config.config_files, root_folder=app.config.root, verbose_callback=app.verbose
     )
     try:
         profile = (

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

@@ -68,7 +68,7 @@ def rebot(app: Application, robot_options_and_args: Tuple[str, ...]) -> None:
         pass
 
     config_files, root_folder, _ = get_config_files(
-        robot_arguments, app.config.config_files, verbose_callback=app.verbose
+        robot_arguments, app.config.config_files, root_folder=app.config.root, verbose_callback=app.verbose
     )
 
     try:

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

@@ -255,7 +255,7 @@ def handle_robot_options(
         sys.path = old_sys_path
 
     config_files, root_folder, _ = get_config_files(
-        robot_arguments, app.config.config_files, verbose_callback=app.verbose
+        robot_arguments, app.config.config_files, root_folder=app.config.root, verbose_callback=app.verbose
     )
     try:
         profile = (

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

@@ -67,7 +67,7 @@ def testdoc(app: Application, robot_options_and_args: Tuple[str, ...]) -> None:
         pass
 
     config_files, root_folder, _ = get_config_files(
-        robot_arguments, app.config.config_files, verbose_callback=app.verbose
+        robot_arguments, app.config.config_files, root_folder=app.config.root, verbose_callback=app.verbose
     )
 
     try:

src/robotcode/cli/__init__.py

@@ -49,6 +49,15 @@
         If not specified, the default profile is used.
         """,
 )
+@click.option(
+    "-r",
+    "--root",
+    "root",
+    type=click.Path(exists=True, path_type=Path, dir_okay=True, file_okay=False, resolve_path=True),
+    multiple=False,
+    show_envvar=True,
+    help="Specifies the root path to be used for the project. It will be automatically detected if not provided.",
+)
 @click.option(
     "-f",
     "--format",
@@ -176,6 +185,7 @@ def robotcode(
     app: Application,
     config_files: Optional[List[Path]],
     profiles: Optional[List[str]],
+    root: Optional[Path],
     format: Optional[OutputFormat],
     dry: bool,
     verbose: bool,
@@ -207,6 +217,7 @@ def robotcode(
     app.config.profiles = profiles
     app.config.dry = dry
     app.config.verbose = verbose
+    app.config.root = root
 
     if color is None:
         app.config.colored_output = ColoredOutput.AUTO