add markup diagnostic message spec

microsoft · Mar 1, 2024 · 5542e25 · 5542e25
1 parent fbb32f4
commit 5542e25
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/_specifications/lsp/3.18/language/pullDiagnostics.md b/_specifications/lsp/3.18/language/pullDiagnostics.md
@@ -480,6 +480,14 @@ export interface DiagnosticWorkspaceClientCapabilities {
 	 * wide change that requires such a calculation.
 	 */
 	refreshSupport?: boolean;
+
+	/**
+	 * Whether the client supports `MarkupContent` in diagnostic messages.
+	 * 
+	 * @since 3.18.0
+	 * @proposed
+	 */
+	markupMessageSupport?: boolean;
 }
 ```
 

diff --git a/_specifications/lsp/3.18/types/diagnostic.md b/_specifications/lsp/3.18/types/diagnostic.md
@@ -1,5 +1,9 @@
 #### <a href="#diagnostic" name="diagnostic" class="anchor"> Diagnostic </a>
 
+- New in version 3.18: support for markup content in diagnostic messages. The support is guarded by the 
+client capability `workspace.diagnostic.markupMessageSupport`. If a client doesn't signal the capability, 
+servers shouldn't send `MarkupContent` diagnostic messages back to the client.
+
 Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.
 
 ```typescript
@@ -35,8 +39,11 @@ export interface Diagnostic {
 
 	/**
 	 * The diagnostic's message.
+	 * 
+	 * @since 3.18.0 - support for MarkupContent. This is guarded by the client
+	 * capability `workspace.diagnostic.markupMessageSupport`.
 	 */
-	message: string;
+	message: string | MarkupContent;
 
 	/**
 	 * Additional metadata about the diagnostic.