Address code review comments: add public API and improve documentation

Co-authored-by: observerw <[email protected]>

Author: Copilot

docs/configuration.md

@@ -202,5 +202,14 @@ from lsp_client.clients.rust_analyzer import RustAnalyzerClient
 
 client = RustAnalyzerClient()
 config_map = client.create_default_configuration_map()
-print(config_map._global_config)  # View the default settings
+
+# Check if configuration exists
+if config_map and config_map.has_global_config():
+    # Get specific configuration values
+    inlay_hints_enabled = config_map.get(None, "rust-analyzer.inlayHints.enable")
+    print(f"Inlay hints enabled: {inlay_hints_enabled}")
+    
+    # Get entire section
+    all_inlay_hints = config_map.get(None, "rust-analyzer.inlayHints")
+    print(f"All inlay hint settings: {all_inlay_hints}")
 ```

src/lsp_client/client/abc.py

@@ -117,8 +117,28 @@ def create_default_configuration_map(self) -> ConfigurationMap | None:
         This method can be overridden by subclasses to provide default configurations
         that enable extra features like inlay hints, diagnostics, etc.
 
+        The base implementation returns None, meaning no default configuration.
+        Subclasses that support configuration should override this method to provide
+        sensible defaults that enable commonly-used features.
+
         Returns:
             ConfigurationMap with default settings, or None if no defaults are needed.
+
+        Example:
+            Override this method in a client subclass to provide defaults:
+
+            ```python
+            @override
+            def create_default_configuration_map(self) -> ConfigurationMap | None:
+                config_map = ConfigurationMap()
+                config_map.update_global({
+                    "myserver": {
+                        "inlayHints": {"enable": True},
+                        "diagnostics": {"enable": True},
+                    }
+                })
+                return config_map
+            ```
         """
         return None
 

src/lsp_client/utils/config.py

@@ -105,3 +105,12 @@ def get(self, scope_uri: str | None, section: str | None) -> Any:
                 logger.warning(f"Failed to parse scope URI: {scope_uri}")
 
         return self._get_section(final_config, section)
+
+    def has_global_config(self) -> bool:
+        """
+        Check if the configuration map has any global configuration.
+
+        Returns:
+            True if global configuration is not empty, False otherwise.
+        """
+        return bool(self._global_config)

tests/test_default_configuration.py

@@ -10,19 +10,19 @@
 @pytest.mark.parametrize("client_cls", clients)
 def test_clients_have_default_configuration_method(client_cls):
     """Test that all clients have a create_default_configuration_map method."""
-    assert hasattr(
-        client_cls, "create_default_configuration_map"
-    ), f"{client_cls.__name__} should have create_default_configuration_map method"
+    assert hasattr(client_cls, "create_default_configuration_map"), (
+        f"{client_cls.__name__} should have create_default_configuration_map method"
+    )
 
 
 @pytest.mark.parametrize("client_cls", clients)
 def test_default_configuration_returns_valid_type(client_cls):
     """Test that create_default_configuration_map returns None or ConfigurationMap."""
     client = client_cls()
     result = client.create_default_configuration_map()
-    assert result is None or isinstance(
-        result, ConfigurationMap
-    ), f"{client_cls.__name__}.create_default_configuration_map() should return None or ConfigurationMap"
+    assert result is None or isinstance(result, ConfigurationMap), (
+        f"{client_cls.__name__}.create_default_configuration_map() should return None or ConfigurationMap"
+    )
 
 
 @pytest.mark.parametrize("client_cls", clients)
@@ -59,11 +59,10 @@ def test_default_configuration_has_content(client_cls):
     if config_map is None:
         pytest.skip(f"{client_cls.__name__} has no default configuration")
 
-    # Check that the configuration map has some content
-    # Access the private attribute to check if global config has content
-    assert (
-        config_map._global_config
-    ), f"{client_cls.__name__} default configuration should not be empty"
+    # Check that the configuration map has some content using public API
+    assert config_map.has_global_config(), (
+        f"{client_cls.__name__} default configuration should not be empty"
+    )
 
 
 @pytest.mark.asyncio