refactor(core): move some files from core to utils

Author: d-biehl

docs/cli/reference.md

@@ -4,3 +4,4 @@
     :prog_name: robotcode
     :remove_ascii_art: true
     :list_subcommands: true
+    :style: table

hatch.toml

@@ -139,7 +139,7 @@ extra-dependencies = [
   "mkdocs-glightbox",
 
   # Extensions
-  "mkdocs-click~=0.8.0",
+  "mkdocs-click~=0.8.1",
   "pymdown-extensions~=9.6.0",
   # Necessary for syntax highlighting in code blocks
   "pygments",

packages/analyze/src/robotcode/analyze/analyzer.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+
+from robotcode.robot.config.model import RobotConfig
+
+from .config import AnalyzerConfig
+
+
+class Analyzer:
+    def __init__(self, config: AnalyzerConfig, robot_config: RobotConfig, root_folder: Path):
+        self.config = config
+        self.robot_config = robot_config
+        self.root_folder = root_folder
+
+    # def run(self, *paths: Path) -> Iterator[Diagnostic]:
+    #     yield Diagnostic()

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

@@ -1,18 +1,52 @@
 # ruff: noqa: RUF009
 from dataclasses import dataclass
-from typing import List, Optional, Union
+from enum import Enum
+from typing import List, Optional
 
 from robotcode.robot.config.model import BaseOptions, field
 
 
-@dataclass
-class Dummy:
-    some_field: Optional[str] = field(default="some value", description="Some field")
+class CacheSaveLocation(Enum):
+    WORKSPACE_FOLDER = "workspaceFolder"
+    WORKSPACE_STORAGE = "workspaceStorage"
 
 
 @dataclass
 class AnalyzerConfig(BaseOptions):
-    select: Optional[List[Union[str, Dummy]]] = field(description="Selects which rules are run.")
-    extend_select: Optional[List[Union[str, Dummy]]] = field(description="Extends the rules which are run.")
+    select: Optional[List[str]] = field(description="Selects which rules are run.")
+    extend_select: Optional[List[str]] = field(description="Extends the rules which are run.")
     ignore: Optional[List[str]] = field(description="Defines which rules are ignored.")
     extend_ignore: Optional[List[str]] = field(description="Extends the rules which are ignored.")
+    exclude_patterns: List[str] = field(default_factory=list)
+
+    cache_dir: Optional[str] = field(description="Path to the cache directory.")
+
+    ignored_libraries: List[str] = field(
+        default_factory=list,
+        description="""\
+            Specifies the library names that should not be cached.
+            This is useful if you have a dynamic or hybrid library that has different keywords depending on
+            the arguments. You can specify a glob pattern that matches the library name or the source file.
+
+            Examples:
+            - `**/mylibfolder/mylib.py`
+            - `MyLib`\n- `mylib.subpackage.subpackage`
+
+            For robot framework internal libraries, you have to specify the full module name like
+            `robot.libraries.Remote`.
+            """,
+    )
+    ignored_variables: List[str] = field(
+        default_factory=list,
+        description="""\
+            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.
+
+            Examples:
+            - `**/variables/myvars.py`
+            - `MyVariables`
+            - `myvars.subpackage.subpackage`
+            """,
+    )

packages/core/src/robotcode/core/async_tools.py

@@ -16,7 +16,6 @@
 from typing import (
     Any,
     AsyncIterator,
-    Awaitable,
     Callable,
     Coroutine,
     Deque,
@@ -26,6 +25,7 @@
     MutableSet,
     Optional,
     Protocol,
+    Set,
     Type,
     TypeVar,
     Union,
@@ -559,14 +559,19 @@ def release(self) -> None:
             self._task = None
 
 
+_global_futures_set: Set[asyncio.Future[Any]] = set()
+
+
 class FutureInfo:
     def __init__(self, future: asyncio.Future[Any]) -> None:
         self.task: weakref.ref[asyncio.Future[Any]] = weakref.ref(future)
         self.children: weakref.WeakSet[asyncio.Future[Any]] = weakref.WeakSet()
-
+        _global_futures_set.add(future)
         future.add_done_callback(self._done)
 
     def _done(self, future: asyncio.Future[Any]) -> None:
+        _global_futures_set.discard(future)
+
         if future.cancelled():
             for t in self.children.copy():
                 if not t.done() and not t.cancelled() and t.get_loop().is_running():
@@ -628,19 +633,6 @@ async def create_task(
     return result
 
 
-def create_delayed_sub_task(
-    coro: Awaitable[_T], *, delay: float, name: Optional[str] = None, loop: Optional[asyncio.AbstractEventLoop] = None
-) -> asyncio.Task[Optional[_T]]:
-    async def run() -> Optional[_T]:
-        try:
-            await asyncio.sleep(delay)
-            return await coro
-        except asyncio.CancelledError:
-            return None
-
-    return create_sub_task(run(), name=name, loop=loop)
-
-
 def create_sub_future(loop: Optional[asyncio.AbstractEventLoop] = None) -> asyncio.Future[Any]:
     ct = get_current_future_info()
 

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

@@ -13,7 +13,7 @@
 from dataclasses import dataclass
 from typing import Any, Dict, Iterator, List, Literal, Optional, Tuple, Union
 
-from robotcode.core.dataclasses import CamelSnakeMixin
+from robotcode.core.utils.dataclasses import CamelSnakeMixin
 
 __lsp_version__ = "3.17.0"
 

packages/core/src/robotcode/core/dataclasses.py renamed to packages/core/src/robotcode/core/utils/dataclasses.py

@@ -1,6 +1,6 @@
 from typing import Optional, Sequence, Tuple, Union
 
-from ..logging import LoggingDescriptor
+from .logging import LoggingDescriptor
 from .net import find_free_port
 
 _logger = LoggingDescriptor(name=__name__)

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

@@ -4,7 +4,7 @@
 from enum import Enum
 from typing import Any, Dict, Iterator, List, Literal, Optional, Union
 
-from robotcode.core.dataclasses import to_camel_case, to_snake_case
+from robotcode.core.utils.dataclasses import to_camel_case, to_snake_case
 
 
 @dataclass