feat: adds inline value support

examples/servers/json_server.py

@@ -195,6 +195,12 @@ def semantic_tokens(ls: JsonLanguageServer, params: lsp.SemanticTokensParams):
     return lsp.SemanticTokens(data=data)
 
 
+@json_server.feature(lsp.TEXT_DOCUMENT_INLINE_VALUE)
+def inline_value(params: lsp.InlineValueParams):
+    """Returns inline value."""
+    return [lsp.InlineValueText(range=params.range, text="Inline value")]
+
+
 @json_server.command(JsonLanguageServer.CMD_PROGRESS)
 async def progress(ls: JsonLanguageServer, *args):
     """Create and start the progress on the client."""

pygls/capabilities.py

@@ -34,6 +34,7 @@
     TEXT_DOCUMENT_HOVER,
     TEXT_DOCUMENT_IMPLEMENTATION,
     TEXT_DOCUMENT_INLAY_HINT,
+    TEXT_DOCUMENT_INLINE_VALUE,
     TEXT_DOCUMENT_ON_TYPE_FORMATTING,
     TEXT_DOCUMENT_RANGE_FORMATTING,
     TEXT_DOCUMENT_REFERENCES,
@@ -393,6 +394,12 @@ def _with_diagnostic_provider(self):
             self.server_cap.diagnostic_provider = value
         return self
 
+    def _with_inline_value_provider(self):
+        value = self._provider_options(TEXT_DOCUMENT_INLINE_VALUE)
+        if value is not None:
+            self.server_cap.inline_value_provider = value
+        return self
+
     def _build(self):
         return self.server_cap
 
@@ -428,5 +435,6 @@ def build(self):
             ._with_workspace_symbol()
             ._with_workspace_capabilities()
             ._with_diagnostic_provider()
+            ._with_inline_value_provider()
             ._build()
         )

tests/lsp/test_inline_value.py

@@ -0,0 +1,61 @@
+############################################################################
+# Copyright(c) Open Law Library. All rights reserved.                      #
+# See ThirdPartyNotices.txt in the project root for additional notices.    #
+#                                                                          #
+# Licensed under the Apache License, Version 2.0 (the "License")           #
+# you may not use this file except in compliance with the License.         #
+# You may obtain a copy of the License at                                  #
+#                                                                          #
+#     http: // www.apache.org/licenses/LICENSE-2.0                         #
+#                                                                          #
+# Unless required by applicable law or agreed to in writing, software      #
+# distributed under the License is distributed on an "AS IS" BASIS,        #
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
+# See the License for the specific language governing permissions and      #
+# limitations under the License.                                           #
+############################################################################
+import json
+from typing import Tuple
+
+from lsprotocol import types
+
+
+from ..client import LanguageClient
+
+
+async def test_inline_value(
+    json_server_client: Tuple[LanguageClient, types.InitializeResult],
+    uri_for,
+):
+    """Ensure that inline values are working as expected."""
+    client, _ = json_server_client
+
+    test_uri = uri_for("example.json")
+    assert test_uri is not None
+
+    document_content = '{\n"foo": "bar"\n}'
+    client.text_document_did_open(
+        types.DidOpenTextDocumentParams(
+            text_document=types.TextDocumentItem(
+                uri=test_uri, language_id="json", version=1, text=document_content
+            )
+        )
+    )
+
+    result = await client.text_document_inline_value_async(
+        types.InlineValueParams(
+            text_document=types.TextDocumentIdentifier(test_uri),
+            range=types.Range(
+                start=types.Position(line=1, character=0),
+                end=types.Position(line=1, character=6),
+            ),
+            context=types.InlineValueContext(
+                frame_id=1,
+                stopped_location=types.Range(
+                    start=types.Position(line=1, character=0),
+                    end=types.Position(line=1, character=6),
+                ),
+            ),
+        )
+    )
+    assert result[0].text == "Inline value"