feat(analyzer): introduce robotcode.analysis.robot.globalLibrarySearchOrder setting to specify a global search for libs and resources

Implemented this, because analyse `Set Library Search Order` is to hard.

Author: d-biehl

package.json

@@ -564,6 +564,15 @@
             "markdownDescription": "Specifies the variable files that should not be cached. This is useful if you have a dynamic or hybrid variable files that has different variables depending on the arguments. You can specify a glob pattern that matches the variable module name or the source file. \n\nExamples:\n- `**/variables/myvars.py`\n- `MyVariables`\n- `myvars.subpackage.subpackage` \n\nIf you change this setting, you may need to run the command `RobotCode: Clear Cache and Restart Language Servers`.",
             "scope": "resource"
           },
+          "robotcode.analysis.robot.globalLibrarySearchOrder": {
+            "type": "array",
+            "default": [],
+            "items": {
+              "type": "string"
+            },
+            "markdownDescription": "Specifies a global [search order](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#specifying-explicit-priority-between-libraries-and-resources) for libraries and resources. This is handy when you have libraries containing keywords with the same name. RobotCode is unable to analyze the library search order in a file specified with [`Set Library Search Order`](https://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Set%20Library%20Search%20Order), so you can define a global order here. Just make sure to call the `Set Library Search Order` keyword somewhere in your robot file or internally in your library.",
+            "scope": "resource"
+          },
           "robotcode.run.openOutputAfterRun": {
             "type": "string",
             "enum": [

packages/analyze/src/robotcode/analyze/config.py

@@ -50,3 +50,10 @@ class AnalyzerConfig(BaseOptions):
             - `myvars.subpackage.subpackage`
             """,
     )
+
+    global_library_search_order: List[str] = field(
+        default_factory=list,
+        description="""\
+            TODO
+        """,
+    )

packages/language_server/src/robotcode/language_server/robotframework/configuration.py

@@ -3,7 +3,7 @@
 
 from robotcode.core.workspace import ConfigBase, config_section
 from robotcode.language_server.common.parts.diagnostics import AnalysisProgressMode, DiagnosticsMode
-from robotcode.robot.diagnostics.workspace_config import CacheConfig, RobotConfig
+from robotcode.robot.diagnostics.workspace_config import AnalysisRobotConfig, CacheConfig, RobotConfig
 
 
 @config_section("robotcode.languageServer")
@@ -67,6 +67,7 @@ class AnalysisConfig(ConfigBase):
     references_code_lens: bool = False
     find_unused_references: bool = False
     cache: CacheConfig = field(default_factory=CacheConfig)
+    robot: AnalysisRobotConfig = field(default_factory=AnalysisRobotConfig)
 
 
 @config_section("robotcode")

packages/robot/src/robotcode/robot/diagnostics/document_cache_helper.py

@@ -33,7 +33,7 @@
 from ..utils.stubs import Languages
 from .imports_manager import ImportsManager
 from .namespace import DocumentType, Namespace
-from .workspace_config import CacheConfig, RobotConfig
+from .workspace_config import AnalysisRobotConfig, CacheConfig, RobotConfig
 
 
 class UnknownFileTypeError(Exception):
@@ -474,6 +474,7 @@ def create_imports_manager(self, root_uri: Uri) -> ImportsManager:
             *robot_config.variable_files,
         ]
 
+        analysis_config = self.workspace.get_configuration(AnalysisRobotConfig, root_uri)
         return ImportsManager(
             self.documents_manager,
             self.file_watcher_manager,
@@ -484,6 +485,7 @@ def create_imports_manager(self, root_uri: Uri) -> ImportsManager:
             environment,
             cache_config.ignored_libraries,
             cache_config.ignored_variables,
+            analysis_config.global_library_search_order,
             cache_base_path,
         )
 

packages/robot/src/robotcode/robot/diagnostics/imports_manager.py

@@ -489,6 +489,7 @@ def __init__(
         environment: Optional[Dict[str, str]],
         ignored_libraries: List[str],
         ignored_variables: List[str],
+        global_library_search_order: List[str],
         cache_base_path: Optional[Path],
     ) -> None:
         super().__init__()
@@ -530,6 +531,9 @@ def __init__(
 
         self.ignored_libraries_patters = [Pattern(s) for s in ignored_libraries]
         self.ignored_variables_patters = [Pattern(s) for s in ignored_variables]
+
+        self.global_library_search_order = global_library_search_order
+
         self._libaries_lock = threading.RLock()
         self._libaries: OrderedDict[_LibrariesEntryKey, _LibrariesEntry] = OrderedDict()
         self._resources_lock = threading.RLock()

packages/robot/src/robotcode/robot/diagnostics/namespace.py

@@ -596,7 +596,7 @@ def __init__(
         self._keywords_lock = RLock(default_timeout=120, name="Namespace.keywords")
 
         # TODO: how to get the search order from model
-        self.search_order: Tuple[str, ...] = ()
+        self._search_order: Optional[Tuple[str, ...]] = None
 
         self._finder: Optional[KeywordFinder] = None
 
@@ -625,6 +625,13 @@ def has_analysed(sender) -> None: ...
     def document(self) -> Optional[TextDocument]:
         return self._document() if self._document is not None else None
 
+    @property
+    def search_order(self) -> Tuple[str, ...]:
+        if self._search_order is None:
+            return tuple(self.imports_manager.global_library_search_order)
+
+        return self._search_order
+
     def imports_changed(self, sender: Any, uri: DocumentUri) -> None:
         # TODO: optimise this by checking our imports
         if self.document is not None:

packages/robot/src/robotcode/robot/diagnostics/workspace_config.py

@@ -48,3 +48,9 @@ class CacheConfig(ConfigBase):
     save_location: CacheSaveLocation = CacheSaveLocation.WORKSPACE_STORAGE
     ignored_libraries: List[str] = field(default_factory=list)
     ignored_variables: List[str] = field(default_factory=list)
+
+
+@config_section("robotcode.analysis.robot")
+@dataclass
+class AnalysisRobotConfig(ConfigBase):
+    global_library_search_order: List[str] = field(default_factory=list)