|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +from collections.abc import Sequence |
| 4 | +from typing import Protocol, override, runtime_checkable |
| 5 | + |
| 6 | +from lsp_client.jsonrpc.id import jsonrpc_uuid |
| 7 | +from lsp_client.protocol import ( |
| 8 | + CapabilityClientProtocol, |
| 9 | + TextDocumentCapabilityProtocol, |
| 10 | +) |
| 11 | +from lsp_client.utils.types import AnyPath, lsp_type |
| 12 | + |
| 13 | + |
| 14 | +@runtime_checkable |
| 15 | +class WithRequestPullDiagnostic( |
| 16 | + TextDocumentCapabilityProtocol, |
| 17 | + CapabilityClientProtocol, |
| 18 | + Protocol, |
| 19 | +): |
| 20 | + """ |
| 21 | + `textDocument/diagnostic` - https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_pullDiagnostics |
| 22 | + """ |
| 23 | + |
| 24 | + @override |
| 25 | + @classmethod |
| 26 | + def methods(cls) -> Sequence[str]: |
| 27 | + return (lsp_type.TEXT_DOCUMENT_DIAGNOSTIC,) |
| 28 | + |
| 29 | + @override |
| 30 | + @classmethod |
| 31 | + def register_text_document_capability( |
| 32 | + cls, cap: lsp_type.TextDocumentClientCapabilities |
| 33 | + ) -> None: |
| 34 | + super().register_text_document_capability(cap) |
| 35 | + cap.diagnostic = lsp_type.DiagnosticClientCapabilities( |
| 36 | + dynamic_registration=True, |
| 37 | + related_document_support=True, |
| 38 | + related_information=True, |
| 39 | + tag_support=lsp_type.ClientDiagnosticsTagOptions( |
| 40 | + value_set=[*lsp_type.DiagnosticTag] |
| 41 | + ), |
| 42 | + code_description_support=True, |
| 43 | + data_support=True, |
| 44 | + ) |
| 45 | + |
| 46 | + @override |
| 47 | + @classmethod |
| 48 | + def check_server_capability( |
| 49 | + cls, |
| 50 | + cap: lsp_type.ServerCapabilities, |
| 51 | + info: lsp_type.ServerInfo | None, |
| 52 | + ) -> None: |
| 53 | + super().check_server_capability(cap, info) |
| 54 | + assert cap.diagnostic_provider |
| 55 | + |
| 56 | + async def request_diagnostic_report( |
| 57 | + self, |
| 58 | + file_path: AnyPath, |
| 59 | + identifier: str | None = None, |
| 60 | + previous_result_id: str | None = None, |
| 61 | + ) -> lsp_type.DocumentDiagnosticReport | None: |
| 62 | + """ |
| 63 | + `textDocument/diagnostic` - Request a diagnostic report for a document. |
| 64 | + """ |
| 65 | + return await self.file_request( |
| 66 | + lsp_type.DocumentDiagnosticRequest( |
| 67 | + id=jsonrpc_uuid(), |
| 68 | + params=lsp_type.DocumentDiagnosticParams( |
| 69 | + text_document=lsp_type.TextDocumentIdentifier( |
| 70 | + uri=self.as_uri(file_path) |
| 71 | + ), |
| 72 | + identifier=identifier, |
| 73 | + previous_result_id=previous_result_id, |
| 74 | + ), |
| 75 | + ), |
| 76 | + schema=lsp_type.DocumentDiagnosticResponse, |
| 77 | + file_paths=[file_path], |
| 78 | + ) |
| 79 | + |
| 80 | + async def request_diagnostics( |
| 81 | + self, |
| 82 | + file_path: AnyPath, |
| 83 | + identifier: str | None = None, |
| 84 | + previous_result_id: str | None = None, |
| 85 | + ) -> Sequence[lsp_type.Diagnostic] | None: |
| 86 | + """ |
| 87 | + Request diagnostics for a document. Returns only the list of diagnostics. |
| 88 | + """ |
| 89 | + match await self.request_diagnostic( |
| 90 | + file_path, |
| 91 | + identifier=identifier, |
| 92 | + previous_result_id=previous_result_id, |
| 93 | + ): |
| 94 | + case lsp_type.RelatedFullDocumentDiagnosticReport(items=items): |
| 95 | + return items |
| 96 | + case lsp_type.FullDocumentDiagnosticReport(items=items): |
| 97 | + return items |
| 98 | + case _: |
| 99 | + return None |
0 commit comments