feat: add --no-vcs command-line option to ignore VCS directories (e.g., .git) when detecting the project root

#closes 201

Author: d-biehl

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

@@ -27,7 +27,11 @@ 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, root_folder=app.config.root, verbose_callback=app.verbose
+        paths,
+        app.config.config_files,
+        root_folder=app.config.root,
+        no_vcs=app.config.no_vcs,
+        verbose_callback=app.verbose,
     )
 
     try:

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

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

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

@@ -65,6 +65,7 @@ class CommonConfig:
     config_files: Optional[Sequence[Path]] = None
     profiles: Optional[Sequence[str]] = None
     root: Optional[Path] = None
+    no_vcs: bool = False
     dry: bool = False
     verbose: bool = False
     colored_output: ColoredOutput = ColoredOutput.AUTO

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

@@ -193,6 +193,7 @@ def load_robot_config_from_path(
 def find_project_root(
     *sources: Union[str, Path],
     root_folder: Optional[Path] = None,
+    no_vcs: bool = False,
 ) -> Tuple[Optional[Path], DiscoverdBy]:
 
     if root_folder:
@@ -220,11 +221,12 @@ def find_project_root(
         if (directory / PYPROJECT_TOML).is_file():
             return directory, DiscoverdBy.PYPROJECT_TOML
 
-        if (directory / ".git").exists():
-            return directory, DiscoverdBy.GIT
+        if not no_vcs:
+            if (directory / ".git").exists():
+                return directory, DiscoverdBy.GIT
 
-        if (directory / ".hg").is_dir():
-            return directory, DiscoverdBy.HG
+            if (directory / ".hg").is_dir():
+                return directory, DiscoverdBy.HG
 
     return None, DiscoverdBy.NOT_FOUND
 

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

@@ -44,18 +44,19 @@ def get_config_files(
     paths: Optional[Sequence[Union[str, Path]]] = None,
     config_files: Optional[Sequence[Path]] = None,
     root_folder: Optional[Path] = None,
+    no_vcs: bool = False,
     *,
     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=root_folder)
+    root_folder, discovered_by = find_project_root(*(paths or []), root_folder=root_folder, no_vcs=no_vcs)
 
     if root_folder is None:
         root_folder = Path.cwd()
         if verbose_callback:
             verbose_callback(f"Cannot detect root folder. Use current folder '{root_folder}' as root.")
 
     if verbose_callback:
-        verbose_callback(f"Found root at:\n    {root_folder} ({discovered_by.value})")
+        verbose_callback(f"Use root at:\n    {root_folder} ({discovered_by.value})")
 
     if config_files:
         if verbose_callback:

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

@@ -67,7 +67,11 @@ 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, root_folder=app.config.root, verbose_callback=app.verbose
+        robot_arguments,
+        app.config.config_files,
+        root_folder=app.config.root,
+        no_vcs=app.config.no_vcs,
+        verbose_callback=app.verbose,
     )
     try:
         profile = (

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

@@ -68,7 +68,11 @@ 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, root_folder=app.config.root, verbose_callback=app.verbose
+        robot_arguments,
+        app.config.config_files,
+        root_folder=app.config.root,
+        no_vcs=app.config.no_vcs,
+        verbose_callback=app.verbose,
     )
 
     try:

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

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

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

@@ -67,7 +67,11 @@ 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, root_folder=app.config.root, verbose_callback=app.verbose
+        robot_arguments,
+        app.config.config_files,
+        root_folder=app.config.root,
+        no_vcs=app.config.no_vcs,
+        verbose_callback=app.verbose,
     )
 
     try:

src/robotcode/cli/__init__.py

@@ -58,6 +58,12 @@
     show_envvar=True,
     help="Specifies the root path to be used for the project. It will be automatically detected if not provided.",
 )
+@click.option(
+    "--no-vcs",
+    is_flag=True,
+    show_envvar=True,
+    help="Ignore version control system directories (e.g., .git, .hg) when detecting the project root.",
+)
 @click.option(
     "-f",
     "--format",
@@ -186,6 +192,7 @@ def robotcode(
     config_files: Optional[List[Path]],
     profiles: Optional[List[str]],
     root: Optional[Path],
+    no_vcs: bool,
     format: Optional[OutputFormat],
     dry: bool,
     verbose: bool,
@@ -218,6 +225,7 @@ def robotcode(
     app.config.dry = dry
     app.config.verbose = verbose
     app.config.root = root
+    app.config.no_vcs = no_vcs
 
     if color is None:
         app.config.colored_output = ColoredOutput.AUTO

src/robotcode/cli/commands/config.py

@@ -65,7 +65,11 @@ def show(app: Application, single: bool, paths: List[Path]) -> None:
     """
     try:
         config_files, _, _ = get_config_files(
-            paths, app.config.config_files, root_folder=app.config.root, verbose_callback=app.verbose
+            paths,
+            app.config.config_files,
+            root_folder=app.config.root,
+            no_vcs=app.config.no_vcs,
+            verbose_callback=app.verbose,
         )
 
         if single:
@@ -126,7 +130,11 @@ def files(app: Application, paths: List[Path], user: bool = False) -> None:
 
     try:
         config_files, _, discovered_by = get_config_files(
-            paths, app.config.config_files, root_folder=app.config.root, verbose_callback=app.verbose
+            paths,
+            app.config.config_files,
+            root_folder=app.config.root,
+            no_vcs=app.config.no_vcs,
+            verbose_callback=app.verbose,
         )
 
         result: Dict[str, Any] = {"files": [{"path": str(file), "type": type} for file, type in config_files]}
@@ -172,7 +180,9 @@ def root(app: Application, paths: List[Path]) -> None:
     ```
     """
 
-    root_folder, discovered_by = find_project_root(*(paths or []), root_folder=app.config.root)
+    root_folder, discovered_by = find_project_root(
+        *(paths or []), root_folder=app.config.root, no_vcs=app.config.no_vcs
+    )
 
     if root_folder is None and (app.config.output_format is None or app.config.output_format == OutputFormat.TEXT):
         raise click.ClickException("Cannot detect root folder. 😥")

src/robotcode/cli/commands/profiles.py

@@ -76,7 +76,11 @@ def list(app: Application, paths: List[Path], show_hidden: bool = False, sort_by
 
     try:
         config_files, _, discovered_by = get_config_files(
-            paths, app.config.config_files, root_folder=app.config.root, verbose_callback=app.verbose
+            paths,
+            app.config.config_files,
+            root_folder=app.config.root,
+            no_vcs=app.config.no_vcs,
+            verbose_callback=app.verbose,
         )
 
         config = load_robot_config_from_path(*config_files, verbose_callback=app.verbose)