feat: redesign configuration mechanism

Author: observerw

src/lsp_client/capability/notification/did_change_configuration.py

@@ -45,10 +45,13 @@ async def _notify_change_configuration(
             lsp_type.DidChangeConfigurationNotification(params=params)
         )
 
-    def get_default_settings(self) -> Any:
-        return {}
+    async def notify_change_configuration(self, settings: Any | None = None) -> None:
+        """
+        Notify the server that the configuration has changed.
+
+        For most clients, the `settings` parameter is often set to `None`, indicating that the server should fetch the updated configuration itself.
+        """
 
-    async def notify_change_configuration(self, settings: Any | None) -> None:
         return await self._notify_change_configuration(
             lsp_type.DidChangeConfigurationParams(settings=settings)
         )

src/lsp_client/capability/server_request/__init__.py

@@ -2,10 +2,10 @@
 
 from typing import Final
 
+from .configuration import WithRespondConfigurationRequest
 from .inlay_hint_refresh import WithRespondInlayHintRefresh
 from .show_document_request import WithRespondShowDocumentRequest
 from .show_message_request import WithRespondShowMessageRequest
-from .workspace_configuration import WithRespondConfigurationRequest
 from .workspace_folders import WithRespondWorkspaceFoldersRequest
 
 capabilities: Final = (

…erver_request/workspace_configuration.py …pability/server_request/configuration.pysrc/lsp_client/capability/server_request/workspace_configuration.py renamed to src/lsp_client/capability/server_request/configuration.py src/lsp_client/capability/server_request/workspace_configuration.py renamed to src/lsp_client/capability/server_request/configuration.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from abc import abstractmethod
 from collections.abc import Iterator
 from typing import Any, Protocol, override, runtime_checkable
 
@@ -45,14 +46,26 @@ def register_workspace_capability(
     def check_server_capability(cls, cap: lsp_type.ServerCapabilities) -> None:
         super().check_server_capability(cap)
 
+    @abstractmethod
+    def get_configuration(self, scope_uri: str | None, section: str | None) -> Any:
+        """
+        Get the configuration value for the given scope URI and section.
+
+        If a client supports this capability, it's the user's responsibility to implement this method to return the appropriate configuration value.
+
+        :param scope_uri: The scope URI for which to get the configuration.
+        :param section: The section of the configuration to get.
+        :return: The configuration value.
+        """
+
     async def _respond_configuration(
         self, params: lsp_type.ConfigurationParams
     ) -> list[Any]:
         logger.debug("Responding to configuration request")
-
-        # TODO add reasonable default behavior
-
-        return [None for _ in params.items]
+        return [
+            self.get_configuration(item.scope_uri, item.section)
+            for item in params.items
+        ]
 
     async def respond_configuration_request(
         self, req: lsp_type.ConfigurationRequest

src/lsp_client/client/abc.py

@@ -18,9 +18,6 @@
     build_server_request_hooks,
 )
 from lsp_client.capability.notification import WithNotifyTextDocumentSynchronize
-from lsp_client.capability.notification.did_change_configuration import (
-    WithNotifyDidChangeConfiguration,
-)
 from lsp_client.client.buffer import LSPFileBuffer
 from lsp_client.jsonrpc.convert import (
     notification_serialize,
@@ -294,10 +291,6 @@ async def __asynccontextmanager__(self) -> AsyncGenerator[Self]:
                 )
             )
 
-            # send initial configuration if supported
-            if isinstance(self, WithNotifyDidChangeConfiguration):
-                await self.notify_change_configuration(self.get_default_settings())
-
             try:
                 yield self
             finally: