feat(analyze): analyze code command now also uses the settings in the robot.toml file.

d-biehl · d-biehl · commit bd17a5d18372 · 2024-11-11T23:25:08.000+01:00
closes #347
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -20,9 +20,9 @@
 			"request": "launch",
 			"module": "robotcode.cli",
 			"justMyCode": false,
-			"cwd": "${workspaceFolder}/tests/robotcode/language_server/robotframework/parts/data",
+			//"cwd": "${workspaceFolder}/tests/robotcode/language_server/robotframework/parts/data",
 			//"cwd": "${workspaceFolder}/..",
-			//"cwd": "${workspaceFolder}",
+			"cwd": "${workspaceFolder}",
 			//"cwd": "E:/source/uvtestprj",
 			//"cwd": "e:\\develop\\robot\\robotframework",
 			// "env": {
diff --git a/packages/analyze/src/robotcode/analyze/cli.py b/packages/analyze/src/robotcode/analyze/cli.py
@@ -75,6 +75,31 @@ def __str__(self) -> str:
         Glob pattern to filter files to analyze. Can be specified multiple times.
         """,
 )
+@click.option(
+    "-v",
+    "--variable",
+    metavar="name:value",
+    type=str,
+    multiple=True,
+    help="Set variables in the test data. see `robot --variable` option.",
+)
+@click.option(
+    "-V",
+    "--variablefile",
+    metavar="path",
+    type=str,
+    multiple=True,
+    help="Python or YAML file file to read variables from. see `robot --variablefile` option.",
+)
+@click.option(
+    "-P",
+    "--pythonpath",
+    metavar="path",
+    type=str,
+    multiple=True,
+    help="Additional locations (directories, ZIPs, JARs) where to search test libraries"
+    " and other extensions when they are imported. see `robot --pythonpath` option.",
+)
 @click.argument(
     "paths", nargs=-1, type=click.Path(exists=True, dir_okay=True, file_okay=True, readable=True, path_type=Path)
 )
@@ -109,7 +134,10 @@ def code(app: Application, filter: Tuple[str], paths: Tuple[Path]) -> None:
 
         statistics = Statistic()
         for e in CodeAnalyzer(
-            app=app, config=analyzer_config, robot_profile=robot_profile, root_folder=root_folder
+            app=app,
+            analysis_config=analyzer_config.to_workspace_analysis_config(),
+            robot_profile=robot_profile,
+            root_folder=root_folder,
         ).run(paths=paths, filter=filter):
             statistics.files.add(e.document)
 
diff --git a/packages/analyze/src/robotcode/analyze/code_analyzer.py b/packages/analyze/src/robotcode/analyze/code_analyzer.py
@@ -12,7 +12,6 @@
 from robotcode.robot.config.model import RobotBaseProfile
 from robotcode.robot.diagnostics.workspace_config import WorkspaceAnalysisConfig
 
-from .config import AnalyzeConfig
 from .diagnostics_context import DiagnosticHandlers, DiagnosticsContext
 from .robot_framework_language_provider import RobotFrameworkLanguageProvider
 
@@ -27,12 +26,13 @@ class CodeAnalyzer(DiagnosticsContext):
     def __init__(
         self,
         app: Application,
-        config: AnalyzeConfig,
+        analysis_config: WorkspaceAnalysisConfig,
         robot_profile: RobotBaseProfile,
         root_folder: Optional[Path],
     ):
         self.app = app
-        self._config = config
+        self._analysis_config = analysis_config or WorkspaceAnalysisConfig()
+
         self._robot_profile = robot_profile
         self._root_folder = root_folder if root_folder is not None else Path.cwd()
 
@@ -53,8 +53,8 @@ def __init__(
                 handler.verbose_callback = app.verbose
 
     @property
-    def analysis_config(self) -> Optional[WorkspaceAnalysisConfig]:
-        return None
+    def analysis_config(self) -> WorkspaceAnalysisConfig:
+        return self._analysis_config
 
     @property
     def profile(self) -> RobotBaseProfile:
diff --git a/packages/analyze/src/robotcode/analyze/config.py b/packages/analyze/src/robotcode/analyze/config.py
@@ -3,6 +3,12 @@
 from typing import List, Optional
 
 from robotcode.robot.config.model import BaseOptions, field
+from robotcode.robot.diagnostics.workspace_config import (
+    AnalysisDiagnosticModifiersConfig,
+    AnalysisRobotConfig,
+    WorkspaceAnalysisConfig,
+)
+from robotcode.robot.diagnostics.workspace_config import CacheConfig as WorkspaceCacheConfig
 
 
 @dataclass
@@ -246,3 +252,30 @@ class AnalyzeConfig(BaseOptions):
     extend_global_library_search_order: Optional[List[str]] = field(
         description="Extend the global library search order setting."
     )
+
+    def to_workspace_analysis_config(self) -> WorkspaceAnalysisConfig:
+        return WorkspaceAnalysisConfig(
+            exclude_patterns=self.exclude_patterns or [],
+            cache=(
+                WorkspaceCacheConfig(
+                    # TODO savelocation
+                    ignored_libraries=self.cache.ignored_libraries or [],
+                    ignored_variables=self.cache.ignored_variables or [],
+                    ignore_arguments_for_library=self.cache.ignore_arguments_for_library or [],
+                )
+                if self.cache is not None
+                else WorkspaceCacheConfig()
+            ),
+            robot=AnalysisRobotConfig(global_library_search_order=self.global_library_search_order or []),
+            modifiers=(
+                AnalysisDiagnosticModifiersConfig(
+                    ignore=self.modifiers.ignore or [],
+                    error=self.modifiers.error or [],
+                    warning=self.modifiers.warning or [],
+                    information=self.modifiers.information or [],
+                    hint=self.modifiers.hint or [],
+                )
+                if self.modifiers is not None
+                else AnalysisDiagnosticModifiersConfig()
+            ),
+        )
diff --git a/packages/analyze/src/robotcode/analyze/diagnostics_context.py b/packages/analyze/src/robotcode/analyze/diagnostics_context.py
@@ -37,7 +37,7 @@ def collect_diagnostics(self, document: TextDocument) -> List[Union[List[Diagnos
 class DiagnosticsContext(ABC):
     @property
     @abstractmethod
-    def analysis_config(self) -> Optional[WorkspaceAnalysisConfig]: ...
+    def analysis_config(self) -> WorkspaceAnalysisConfig: ...
 
     @property
     @abstractmethod
diff --git a/packages/analyze/src/robotcode/analyze/robot_framework_language_provider.py b/packages/analyze/src/robotcode/analyze/robot_framework_language_provider.py
@@ -70,14 +70,18 @@ def collect_workspace_folder_files(self, folder: WorkspaceFolder) -> Iterable[Pa
 
         extensions = self.LANGUAGE_DEFINITION.extensions
 
+        exclude_patterns = [
+            *self.diagnostics_context.analysis_config.exclude_patterns,
+            *(config.exclude_patterns or []),
+        ]
         return filter(
             lambda f: f.suffix.lower() in extensions,
             iter_files(
                 folder.uri.to_path(),
                 ignore_files=[ROBOT_IGNORE_FILE, GIT_IGNORE_FILE],
                 include_hidden=False,
                 parent_spec=IgnoreSpec.from_list(
-                    [*DEFAULT_SPEC_RULES, *(config.exclude_patterns or [])],
+                    [*DEFAULT_SPEC_RULES, *exclude_patterns],
                     folder.uri.to_path(),
                 ),
                 verbose_callback=self.verbose_callback,
@@ -90,4 +94,4 @@ def analyze_document(self, sender: Any, document: TextDocument) -> Optional[List
 
         namespace.analyze()
 
-        return namespace.get_diagnostics()
+        return self._document_cache.get_diagnostic_modifier(document).modify_diagnostics(namespace.get_diagnostics())
diff --git a/packages/language_server/src/robotcode/language_server/cli.py b/packages/language_server/src/robotcode/language_server/cli.py
@@ -15,12 +15,7 @@
 from robotcode.robot.config.loader import load_robot_config_from_path
 from robotcode.robot.config.model import RobotBaseProfile
 from robotcode.robot.config.utils import get_config_files
-from robotcode.robot.diagnostics.workspace_config import (
-    AnalysisDiagnosticModifiersConfig,
-    AnalysisRobotConfig,
-    CacheConfig,
-    WorkspaceAnalysisConfig,
-)
+from robotcode.robot.diagnostics.workspace_config import WorkspaceAnalysisConfig
 
 from .__version__ import __version__
 
@@ -101,36 +96,13 @@ def language_server(
         if analyzer_config is None:
             analyzer_config = AnalyzeConfig()
 
-        analysis_config = WorkspaceAnalysisConfig(
-            cache=(
-                CacheConfig(
-                    # TODO savelocation
-                    ignored_libraries=analyzer_config.cache.ignored_libraries or [],
-                    ignored_variables=analyzer_config.cache.ignored_variables or [],
-                    ignore_arguments_for_library=analyzer_config.cache.ignore_arguments_for_library or [],
-                )
-                if analyzer_config.cache is not None
-                else CacheConfig()
-            ),
-            robot=AnalysisRobotConfig(global_library_search_order=analyzer_config.global_library_search_order or []),
-            modifiers=(
-                AnalysisDiagnosticModifiersConfig(
-                    ignore=analyzer_config.modifiers.ignore or [],
-                    error=analyzer_config.modifiers.error or [],
-                    warning=analyzer_config.modifiers.warning or [],
-                    information=analyzer_config.modifiers.information or [],
-                    hint=analyzer_config.modifiers.hint or [],
-                )
-                if analyzer_config.modifiers is not None
-                else AnalysisDiagnosticModifiersConfig()
-            ),
-        )
+        analysis_config = analyzer_config.to_workspace_analysis_config()
 
         profile = robot_config.combine_profiles(
             *(app.config.profiles or []), verbose_callback=app.verbose, error_callback=app.error
         ).evaluated_with_env(verbose_callback=app.verbose, error_callback=app.error)
     except (TypeError, ValueError) as e:
-        app.echo(str(e), err=True)
+        app.error(str(e), err=True)
 
     mode, port, bind, pipe_name = resolve_server_options(
         ctx, app, mode, port, bind, pipe_name, tcp, socket, stdio, pipe, None
diff --git a/packages/language_server/src/robotcode/language_server/robotframework/parts/robot_workspace.py b/packages/language_server/src/robotcode/language_server/robotframework/parts/robot_workspace.py
@@ -63,6 +63,12 @@ def load_workspace_documents(self, sender: Any) -> None:
                     config = self.parent.workspace.get_configuration(RobotCodeConfig, folder.uri)
 
                     extensions = [ROBOT_FILE_EXTENSION, RESOURCE_FILE_EXTENSION]
+
+                    exclude_patterns = [
+                        *self.parent.analysis_config.exclude_patterns,
+                        *(config.workspace.exclude_patterns or []),
+                    ]
+
                     with self.parent.window.progress("Collect sources", cancellable=False):
                         files = list(
                             filter(
@@ -72,7 +78,7 @@ def load_workspace_documents(self, sender: Any) -> None:
                                     ignore_files=[ROBOT_IGNORE_FILE, GIT_IGNORE_FILE],
                                     include_hidden=False,
                                     parent_spec=IgnoreSpec.from_list(
-                                        [*DEFAULT_SPEC_RULES, *(config.workspace.exclude_patterns or [])],
+                                        [*DEFAULT_SPEC_RULES, *exclude_patterns],
                                         folder.uri.to_path(),
                                     ),
                                     verbose_callback=self._logger.debug,
diff --git a/packages/robot/src/robotcode/robot/diagnostics/workspace_config.py b/packages/robot/src/robotcode/robot/diagnostics/workspace_config.py
@@ -75,6 +75,7 @@ class WorkspaceConfig(ConfigBase):
 
 @dataclass
 class WorkspaceAnalysisConfig:
+    exclude_patterns: List[str] = field(default_factory=list)
     cache: CacheConfig = field(default_factory=CacheConfig)
     robot: AnalysisRobotConfig = field(default_factory=AnalysisRobotConfig)
     modifiers: AnalysisDiagnosticModifiersConfig = field(default_factory=AnalysisDiagnosticModifiersConfig)
diff --git a/robot.toml b/robot.toml
@@ -11,6 +11,7 @@ a_robot_toml_variable = "a_robot_toml_value"
 [tool.robotcode-analyze]
 
 
-[tool.robotcode-analyze.extend-modifiers]
-warning = ["user"]
+[tool.robotcode-analyze.modifiers]
+warning = ["KeywordNotFound"]
+#warning = ["user"]
 extend-hint = ["a_second_hint"]
