feat: add project root detection and language-specific client base classes

Author: observerw

src/lsp_client/client/abc.py

@@ -95,6 +95,18 @@ def get_workspace(self) -> Workspace:
     def get_server(self) -> Server:
         return self._server
 
+    @classmethod
+    @abstractmethod
+    def check_project_root(cls, path: Path) -> bool:
+        """Check if the given path is a project root for this client."""
+
+    @classmethod
+    def find_project_root(cls, path: Path) -> Path | None:
+        """Find the project root for the given path by searching upwards."""
+        for parent in [path, *path.parents]:
+            if cls.check_project_root(parent):
+                return parent
+
     @abstractmethod
     def get_language_id(self) -> lsp_type.LanguageKind:
         """The language ID of the client."""

src/lsp_client/clients/__init__.py

@@ -31,5 +31,4 @@
     "PythonClient",
     "RustClient",
     "TypeScriptClient",
-    "client",
 ]

src/lsp_client/clients/base.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+from abc import ABC
+from pathlib import Path
+from typing import override
+
+from lsp_client.client.abc import Client
+from lsp_client.utils.types import lsp_type
+
+
+class PythonClientBase(Client, ABC):
+    @classmethod
+    def check_project_root(cls, path: Path) -> bool:
+        return any(
+            (path / f).exists()
+            for f in (
+                "pyproject.toml",
+                "setup.py",
+                "setup.cfg",
+                "requirements.txt",
+                ".python-version",
+            )
+        )
+
+    @override
+    def get_language_id(self) -> lsp_type.LanguageKind:
+        return lsp_type.LanguageKind.Python
+
+
+class RustClientBase(Client, ABC):
+    @classmethod
+    def check_project_root(cls, path: Path) -> bool:
+        return (path / "Cargo.toml").exists()
+
+    @override
+    def get_language_id(self) -> lsp_type.LanguageKind:
+        return lsp_type.LanguageKind.Rust
+
+
+class GoClientBase(Client, ABC):
+    @classmethod
+    def check_project_root(cls, path: Path) -> bool:
+        return (path / "go.mod").exists()
+
+    @override
+    def get_language_id(self) -> lsp_type.LanguageKind:
+        return lsp_type.LanguageKind.Go
+
+
+class TypeScriptClientBase(Client, ABC):
+    @classmethod
+    def check_project_root(cls, path: Path) -> bool:
+        return any(
+            (path / f).exists()
+            for f in ("package.json", "tsconfig.json", "jsconfig.json")
+        )
+
+    @override
+    def get_language_id(self) -> lsp_type.LanguageKind:
+        return lsp_type.LanguageKind.TypeScript

src/lsp_client/clients/deno/client.py

@@ -2,6 +2,7 @@
 
 import shutil
 from functools import partial
+from pathlib import Path
 from subprocess import CalledProcessError
 from typing import Any, override
 
@@ -158,6 +159,10 @@ class DenoClient(
     testing_enable: bool = False
     testing_args: list[str] = Factory(list)
 
+    @classmethod
+    def check_project_root(cls, path: Path) -> bool:
+        return any((path / f).exists() for f in ("deno.json", "deno.jsonc"))
+
     @override
     def get_language_id(self) -> lsp_type.LanguageKind:
         return lsp_type.LanguageKind.TypeScript

src/lsp_client/clients/gopls.py

@@ -39,7 +39,7 @@
     WithRespondShowMessageRequest,
     WithRespondWorkspaceFoldersRequest,
 )
-from lsp_client.client.abc import Client
+from lsp_client.clients.base import GoClientBase
 from lsp_client.server import DefaultServers, ServerInstallationError
 from lsp_client.server.container import ContainerServer
 from lsp_client.server.local import LocalServer
@@ -75,7 +75,7 @@ async def ensure_gopls_installed() -> None:
 
 @define
 class GoplsClient(
-    Client,
+    GoClientBase,
     WithNotifyDidChangeConfiguration,
     WithRequestCallHierarchy,
     WithRequestCompletion,
@@ -135,10 +135,6 @@ class GoplsClient(
     use_placeholders: bool = False
     verbose_output: bool = False
 
-    @override
-    def get_language_id(self) -> lsp_type.LanguageKind:
-        return lsp_type.LanguageKind.Go
-
     @override
     def create_default_servers(self) -> DefaultServers:
         return DefaultServers(

src/lsp_client/clients/pyrefly.py

@@ -39,7 +39,7 @@
     WithRespondShowMessageRequest,
     WithRespondWorkspaceFoldersRequest,
 )
-from lsp_client.client.abc import Client
+from lsp_client.clients.base import PythonClientBase
 from lsp_client.server import DefaultServers, ServerInstallationError
 from lsp_client.server.container import ContainerServer
 from lsp_client.server.local import LocalServer
@@ -80,7 +80,7 @@ async def ensure_pyrefly_installed() -> None:
 
 @define
 class PyreflyClient(
-    Client,
+    PythonClientBase,
     WithNotifyDidChangeConfiguration,
     WithRequestCallHierarchy,
     WithRequestCompletion,
@@ -118,10 +118,6 @@ class PyreflyClient(
     diagnostic_mode: Literal["Workspace", "OpenFilesOnly"] = "Workspace"
     """How diagnostics are reported"""
 
-    @override
-    def get_language_id(self) -> lsp_type.LanguageKind:
-        return lsp_type.LanguageKind.Python
-
     @override
     def create_default_servers(self) -> DefaultServers:
         return DefaultServers(

src/lsp_client/clients/pyright.py

@@ -37,7 +37,7 @@
     WithRespondShowMessageRequest,
     WithRespondWorkspaceFoldersRequest,
 )
-from lsp_client.client.abc import Client
+from lsp_client.clients.base import PythonClientBase
 from lsp_client.server import DefaultServers, ServerInstallationError
 from lsp_client.server.container import ContainerServer
 from lsp_client.server.local import LocalServer
@@ -75,7 +75,7 @@ async def ensure_pyright_installed() -> None:
 
 @define
 class PyrightClient(
-    Client,
+    PythonClientBase,
     WithNotifyDidChangeConfiguration,
     WithRequestCallHierarchy,
     WithRequestCompletion,
@@ -108,10 +108,6 @@ class PyrightClient(
     diagnostic_mode: Literal["openFilesOnly", "workspace"] = "workspace"
     disable_pull_diagnostics: bool = False
 
-    @override
-    def get_language_id(self) -> lsp_type.LanguageKind:
-        return lsp_type.LanguageKind.Python
-
     @override
     def create_default_servers(self) -> DefaultServers:
         return DefaultServers(

src/lsp_client/clients/rust_analyzer.py

@@ -40,7 +40,7 @@
     WithRespondShowMessageRequest,
     WithRespondWorkspaceFoldersRequest,
 )
-from lsp_client.client.abc import Client
+from lsp_client.clients.base import RustClientBase
 from lsp_client.server import DefaultServers, ServerInstallationError
 from lsp_client.server.container import ContainerServer
 from lsp_client.server.local import LocalServer
@@ -77,7 +77,7 @@ async def ensure_rust_analyzer_installed() -> None:
 
 @define
 class RustAnalyzerClient(
-    Client,
+    RustClientBase,
     WithNotifyDidChangeConfiguration,
     WithRequestCallHierarchy,
     WithRequestCompletion,
@@ -124,10 +124,6 @@ class RustAnalyzerClient(
     cargo_extra_args: list[str] = Factory(list)
     cargo_extra_env: dict[str, str] = Factory(dict)
 
-    @override
-    def get_language_id(self) -> lsp_type.LanguageKind:
-        return lsp_type.LanguageKind.Rust
-
     @override
     def create_default_servers(self) -> DefaultServers:
         return DefaultServers(

src/lsp_client/clients/ty.py

@@ -36,7 +36,7 @@
     WithRespondShowMessageRequest,
     WithRespondWorkspaceFoldersRequest,
 )
-from lsp_client.client.abc import Client
+from lsp_client.clients.base import PythonClientBase
 from lsp_client.server import DefaultServers, ServerInstallationError
 from lsp_client.server.container import ContainerServer
 from lsp_client.server.local import LocalServer
@@ -72,7 +72,7 @@ async def ensure_ty_installed() -> None:
 
 @define
 class TyClient(
-    Client,
+    PythonClientBase,
     WithNotifyDidChangeConfiguration,
     WithRequestCompletion,
     WithRequestDeclaration,
@@ -105,10 +105,6 @@ class TyClient(
     inlay_hints_variable_types: bool = True
     inlay_hints_call_argument_names: bool = True
 
-    @override
-    def get_language_id(self) -> lsp_type.LanguageKind:
-        return lsp_type.LanguageKind.Python
-
     @override
     def create_default_servers(self) -> DefaultServers:
         return DefaultServers(

src/lsp_client/clients/typescript.py

@@ -37,7 +37,7 @@
     WithRespondShowMessageRequest,
     WithRespondWorkspaceFoldersRequest,
 )
-from lsp_client.client.abc import Client
+from lsp_client.clients.base import TypeScriptClientBase
 from lsp_client.server import DefaultServers, ServerInstallationError
 from lsp_client.server.container import ContainerServer
 from lsp_client.server.local import LocalServer
@@ -81,7 +81,7 @@ async def ensure_typescript_installed() -> None:
 
 @define
 class TypescriptClient(
-    Client,
+    TypeScriptClientBase,
     WithNotifyDidChangeConfiguration,
     WithRequestCompletion,
     WithRequestHover,
@@ -118,10 +118,6 @@ class TypescriptClient(
     include_completions_for_module_exports: bool = True
     include_completions_with_insert_text: bool = True
 
-    @override
-    def get_language_id(self) -> lsp_type.LanguageKind:
-        return lsp_type.LanguageKind.TypeScript
-
     @override
     def create_default_servers(self) -> DefaultServers:
         return DefaultServers(