DOCSP-5967: Clicking on an include or directive path opens file

Author: rayangler

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `textDocument/resolve` RPC endpoint to return the source file path of an artifact relative to the project's root (DOCSP-5967).
+
 ## [v0.1.8] - 2019-06-27
 
 ### Added

snooty/language_server.py

@@ -225,7 +225,7 @@ def m_initialize(
         self,
         processId: Optional[int] = None,
         rootUri: Optional[Uri] = None,
-        **kwargs: object
+        **kwargs: object,
     ) -> SerializableType:
         if rootUri:
             root_path = Path(rootUri.replace("file://", "", 1))
@@ -259,6 +259,16 @@ def m_initialized(self, **kwargs: object) -> None:
         # Ignore this message to avoid logging a pointless warning
         pass
 
+    def m_text_document__resolve(self, path: str) -> str:
+        """Given an artifact's path relative to the project's source directory, 
+        return a corresponding source file path relative to the project's root."""
+
+        if self.project is None:
+            logger.warn("Project uninitialized")
+            return path
+
+        return str(self.project.config.source_path) + path
+
     def m_text_document__did_open(self, textDocument: SerializableType) -> None:
         if not self.project:
             return

snooty/test_language_server.py

@@ -68,5 +68,20 @@ def test_workspace_entry() -> None:
 
 
 def test_language_server() -> None:
-    server = language_server.LanguageServer(sys.stdin.buffer, sys.stdout.buffer)
-    assert server.uri_to_path("file://foo.rst") == Path("foo.rst")
+    with language_server.LanguageServer(sys.stdin.buffer, sys.stdout.buffer) as server:
+        assert server.uri_to_path("file://foo.rst") == Path("foo.rst")
+
+
+def test_text_doc_resolve() -> None:
+    """Tests to see if m_text_document__resolve() returns the proper path combined with """
+    with language_server.LanguageServer(sys.stdin.buffer, sys.stdout.buffer) as server:
+        server.m_initialize(None, "file://test_data/test_project")
+
+        test_file = "/images/compass-create-database.png"
+
+        assert server.project is not None
+
+        assert (
+            server.m_text_document__resolve(test_file)
+            == str(server.project.config.source_path) + test_file
+        )