feature: Allow diagnostics messages to have markdown content

.eslint-ignore

@@ -4,6 +4,7 @@
 **/extensions/**/build/**
 **/extensions/**/colorize-fixtures/**
 **/extensions/css-language-features/server/test/pathCompletionFixtures/**
+**/extensions/sample-diagnostic-extension/**
 **/extensions/html-language-features/server/lib/jquery.d.ts
 **/extensions/html-language-features/server/src/test/pathCompletionFixtures/**
 **/extensions/ipynb/notebook-out/**

extensions/json-language-features/client/src/jsonClient.ts

@@ -235,7 +235,7 @@ async function startClientWithParticipants(context: ExtensionContext, languagePa
 		const schemaErrorIndex = diagnostics.findIndex(isSchemaResolveError);
 		if (schemaErrorIndex !== -1) {
 			const schemaResolveDiagnostic = diagnostics[schemaErrorIndex];
-			fileSchemaErrors.set(uri.toString(), schemaResolveDiagnostic.message);
+			fileSchemaErrors.set(uri.toString(), schemaResolveDiagnostic.message.toString());
 			if (!schemaDownloadEnabled) {
 				diagnostics = diagnostics.filter(d => !isSchemaResolveError(d));
 			}
@@ -484,7 +484,7 @@ async function startClientWithParticipants(context: ExtensionContext, languagePa
 				if (schemaErrorIndex !== -1) {
 					// Show schema resolution errors in status bar only; ref: #51032
 					const schemaResolveDiagnostic = diagnostics[schemaErrorIndex];
-					fileSchemaErrors.set(activeDocUri, schemaResolveDiagnostic.message);
+					fileSchemaErrors.set(activeDocUri, schemaResolveDiagnostic.message.toString());
 				} else {
 					schemaResolutionErrorStatusBarItem.hide();
 				}

extensions/sample-diagnostic-extension/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "diagnostic-related-information-sample",
+  "displayName": "Diagnostic Related Information Sample",
+  "description": "Diagnostic Related Information Sample",
+  "version": "0.0.1",
+  "publisher": "vscode-samples",
+  "private": true,
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Microsoft/vscode-extension-samples"
+  },
+  "engines": {
+    "vscode": "^1.73.0"
+  },
+  "categories": [
+    "Other"
+  ],
+  "activationEvents": [
+    "onStartupFinished"
+  ],
+  "main": "./out/extension.js",
+  "scripts": {
+    "vscode:prepublish": "npm run compile",
+    "compile": "tsc -p ./",
+    "lint": "eslint \"src/**/*.ts\"",
+    "watch": "tsc -watch -p ./"
+  },
+  "devDependencies": {}
+}

extensions/sample-diagnostic-extension/sample-demo.rs

@@ -0,0 +1,11 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+fn main() {
+let x = 5;
+println!("The value of x is: {}", x);
+x = 6;
+println!("The value of x is: {}", x);
+}

extensions/sample-diagnostic-extension/src/extension.ts

@@ -0,0 +1,75 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+import * as path from 'path';
+
+export const activate = (context: vscode.ExtensionContext) => {
+	const collection = vscode.languages.createDiagnosticCollection('test');
+	if (vscode.window.activeTextEditor) {
+		updateDiagnostics(vscode.window.activeTextEditor.document, collection);
+	}
+	context.subscriptions.push(
+		vscode.window.onDidChangeActiveTextEditor((editor) => {
+			if (editor) {
+				updateDiagnostics(editor.document, collection);
+			}
+		})
+	);
+};
+
+function updateDiagnostics(
+	document: vscode.TextDocument,
+	collection: vscode.DiagnosticCollection
+): void {
+	if (document && path.basename(document.uri.fsPath) === 'sample-demo.rs') {
+		const message = new vscode.MarkdownString(
+			'cannot assign twice to immutable variable `x`',
+		);
+		message.appendText('\n');
+		message.appendMarkdown(`https://example.com`);
+		message.appendText('\n');
+		message.appendMarkdown(`**This is bold text**
+
+__This is bold text__
+
+*This is italic text*
+
+_This is italic text_
+
+~~Strikethrough~~
+
+
+
+`);
+		message.plainTextValue = 'cannot assign twice to immutable variable `x`';
+		collection.set(document.uri, [
+			{
+				code: '',
+				message,
+				range: new vscode.Range(
+					new vscode.Position(3, 4),
+					new vscode.Position(3, 10)
+				),
+				severity: vscode.DiagnosticSeverity.Error,
+				source: '',
+				relatedInformation: [
+					new vscode.DiagnosticRelatedInformation(
+						new vscode.Location(
+							document.uri,
+							new vscode.Range(
+								new vscode.Position(1, 8),
+								new vscode.Position(1, 9)
+							)
+						),
+						'first assignment to `x`'
+					),
+				],
+			},
+		]);
+	} else {
+		collection.clear();
+	}
+}

extensions/sample-diagnostic-extension/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"extends": "../tsconfig.base.json",
+	"compilerOptions": {
+		"outDir": "./out",
+		"skipLibCheck": true
+	},
+	"include": ["src/**/*", "../../src/vscode-dts/vscode.d.ts"]
+}

src/vs/base/common/htmlContent.ts

@@ -15,6 +15,7 @@ export interface MarkdownStringTrustedOptions {
 
 export interface IMarkdownString {
 	readonly value: string;
+	readonly plainTextValue?: string;
 	readonly isTrusted?: boolean | MarkdownStringTrustedOptions;
 	readonly supportThemeIcons?: boolean;
 	readonly supportHtml?: boolean;
@@ -30,16 +31,18 @@ export const enum MarkdownStringTextNewlineStyle {
 export class MarkdownString implements IMarkdownString {
 
 	public value: string;
+	public plainTextValue?: string;
 	public isTrusted?: boolean | MarkdownStringTrustedOptions;
 	public supportThemeIcons?: boolean;
 	public supportHtml?: boolean;
 	public baseUri?: URI;
 
 	constructor(
 		value: string = '',
-		isTrustedOrOptions: boolean | { isTrusted?: boolean | MarkdownStringTrustedOptions; supportThemeIcons?: boolean; supportHtml?: boolean } = false,
+		isTrustedOrOptions: boolean | { isTrusted?: boolean | MarkdownStringTrustedOptions; supportThemeIcons?: boolean; supportHtml?: boolean; plainTextValue?: string } = false,
 	) {
 		this.value = value;
+		this.plainTextValue = value;
 		if (typeof this.value !== 'string') {
 			throw illegalArgument('value');
 		}

src/vs/editor/contrib/gotoError/browser/gotoErrorWidget.ts

@@ -29,6 +29,7 @@ import { IOpenerService } from '../../../../platform/opener/common/opener.js';
 import { SeverityIcon } from '../../../../platform/severityIcon/browser/severityIcon.js';
 import { contrastBorder, editorBackground, editorErrorBorder, editorErrorForeground, editorInfoBorder, editorInfoForeground, editorWarningBorder, editorWarningForeground, oneOf, registerColor, transparent } from '../../../../platform/theme/common/colorRegistry.js';
 import { IColorTheme, IThemeService } from '../../../../platform/theme/common/themeService.js';
+import { isMarkdownString } from '../../../../base/common/htmlContent.js';
 
 class MessageWidget {
 
@@ -102,7 +103,8 @@ class MessageWidget {
 			}
 		}
 
-		const lines = splitLines(message);
+		const plainTextMessage = isMarkdownString(message) ? (message.plainTextValue || '') : message;
+		const lines = splitLines(plainTextMessage);
 		this._lines = lines.length;
 		this._longestLineLength = 0;
 		for (const line of lines) {

src/vs/editor/contrib/hover/browser/markdownHoverParticipant.ts

@@ -471,7 +471,7 @@ export function renderMarkdownHovers(
 	return new RenderedHoverParts(renderedHoverParts);
 }
 
-function renderMarkdownInContainer(
+export function renderMarkdownInContainer(
 	editor: ICodeEditor,
 	markdownHover: MarkdownHover,
 	languageService: ILanguageService,

src/vs/editor/contrib/hover/browser/markerHoverParticipant.ts

@@ -26,23 +26,24 @@ import { ITextEditorOptions } from '../../../../platform/editor/common/editor.js
 import { IMarker, IMarkerData, MarkerSeverity } from '../../../../platform/markers/common/markers.js';
 import { IOpenerService } from '../../../../platform/opener/common/opener.js';
 import { Progress } from '../../../../platform/progress/common/progress.js';
+import { IMarkdownString, isMarkdownString } from '../../../../base/common/htmlContent.js';
+import { MarkdownHover, renderMarkdownInContainer } from './markdownHoverParticipant.js';
+import { ILanguageService } from '../../../common/languages/language.js';
+
 
 const $ = dom.$;
 
-export class MarkerHover implements IHoverPart {
+export class MarkerHover extends MarkdownHover implements IHoverPart {
+	readonly marker: IMarker;
 
 	constructor(
-		public readonly owner: IEditorHoverParticipant<MarkerHover>,
-		public readonly range: Range,
-		public readonly marker: IMarker,
-	) { }
-
-	public isValidForHoverAnchor(anchor: HoverAnchor): boolean {
-		return (
-			anchor.type === HoverAnchorType.Range
-			&& this.range.startColumn <= anchor.range.startColumn
-			&& this.range.endColumn >= anchor.range.endColumn
-		);
+		owner: IEditorHoverParticipant<MarkerHover>,
+		range: Range,
+		contents: IMarkdownString[],
+		marker: IMarker,
+	) {
+		super(owner, range, contents, false, 1, undefined);
+		this.marker = marker;
 	}
 }
 
@@ -62,6 +63,7 @@ export class MarkerHoverParticipant implements IEditorHoverParticipant<MarkerHov
 		private readonly _editor: ICodeEditor,
 		@IMarkerDecorationsService private readonly _markerDecorationsService: IMarkerDecorationsService,
 		@IOpenerService private readonly _openerService: IOpenerService,
+		@ILanguageService private readonly _languageService: ILanguageService,
 		@ILanguageFeaturesService private readonly _languageFeaturesService: ILanguageFeaturesService,
 	) { }
 
@@ -84,7 +86,9 @@ export class MarkerHoverParticipant implements IEditorHoverParticipant<MarkerHov
 			}
 
 			const range = new Range(anchor.range.startLineNumber, startColumn, anchor.range.startLineNumber, endColumn);
-			result.push(new MarkerHover(this, range, marker));
+			if (isMarkdownString(marker.message)) {
+				result.push(new MarkerHover(this, range, [marker.message], marker));
+			}
 		}
 
 		return result;
@@ -97,7 +101,7 @@ export class MarkerHoverParticipant implements IEditorHoverParticipant<MarkerHov
 		const disposables = new DisposableStore();
 		const renderedHoverParts: IRenderedHoverPart<MarkerHover>[] = [];
 		hoverParts.forEach(hoverPart => {
-			const renderedMarkerHover = this._renderMarkerHover(hoverPart);
+			const renderedMarkerHover = this._renderMarkerHover(hoverPart, context,);
 			context.fragment.appendChild(renderedMarkerHover.hoverElement);
 			renderedHoverParts.push(renderedMarkerHover);
 		});
@@ -107,19 +111,27 @@ export class MarkerHoverParticipant implements IEditorHoverParticipant<MarkerHov
 	}
 
 	public getAccessibleContent(hoverPart: MarkerHover): string {
-		return hoverPart.marker.message;
+		return hoverPart.marker.message.toString();
 	}
 
-	private _renderMarkerHover(markerHover: MarkerHover): IRenderedHoverPart<MarkerHover> {
+	private _renderMarkerHover(markerHover: MarkerHover, context: IEditorHoverRenderContext): IRenderedHoverPart<MarkerHover> {
 		const disposables: DisposableStore = new DisposableStore();
 		const hoverElement = $('div.hover-row');
 		const markerElement = dom.append(hoverElement, $('div.marker.hover-contents'));
-		const { source, message, code, relatedInformation } = markerHover.marker;
+		const { source, message, code, relatedInformation, } = markerHover.marker;
 
+		console.log({ marker: markerHover.marker });
 		this._editor.applyFontInfo(markerElement);
 		const messageElement = dom.append(markerElement, $('span'));
 		messageElement.style.whiteSpace = 'pre-wrap';
-		messageElement.innerText = message;
+		if (isMarkdownString(message)) {
+			const renderedMarkdownPart = renderMarkdownInContainer(this._editor, markerHover, this._languageService, this._openerService, context.onContentsChanged);
+			disposables.add(renderedMarkdownPart);
+			const renderedMarkdownElement = renderedMarkdownPart.hoverElement;
+			messageElement.append(renderedMarkdownElement);
+		} else {
+			messageElement.innerText = message;
+		}
 
 		if (source || code) {
 			// Code has link

src/vs/monaco.d.ts

@@ -475,6 +475,7 @@ declare namespace monaco {
 
 	export interface IMarkdownString {
 		readonly value: string;
+		readonly plainTextValue?: string;
 		readonly isTrusted?: boolean | MarkdownStringTrustedOptions;
 		readonly supportThemeIcons?: boolean;
 		readonly supportHtml?: boolean;
@@ -1465,7 +1466,7 @@ declare namespace monaco.editor {
 			value: string;
 			target: Uri;
 		};
-		message: string;
+		message: string | IMarkdownString;
 		source?: string;
 		startLineNumber: number;
 		startColumn: number;
@@ -1485,7 +1486,7 @@ declare namespace monaco.editor {
 			target: Uri;
 		};
 		severity: MarkerSeverity;
-		message: string;
+		message: string | IMarkdownString;
 		source?: string;
 		startLineNumber: number;
 		startColumn: number;

src/vs/platform/markers/common/markers.ts

@@ -4,6 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { Event } from '../../../base/common/event.js';
+import { type IMarkdownString, isMarkdownString } from '../../../base/common/htmlContent.js';
 import Severity from '../../../base/common/severity.js';
 import { URI } from '../../../base/common/uri.js';
 import { localize } from '../../../nls.js';
@@ -89,7 +90,7 @@ export namespace MarkerSeverity {
 export interface IMarkerData {
 	code?: string | { value: string; target: URI };
 	severity: MarkerSeverity;
-	message: string;
+	message: string | IMarkdownString;
 	source?: string;
 	startLineNumber: number;
 	startColumn: number;
@@ -110,7 +111,7 @@ export interface IMarker {
 	resource: URI;
 	severity: MarkerSeverity;
 	code?: string | { value: string; target: URI };
-	message: string;
+	message: string | IMarkdownString;
 	source?: string;
 	startLineNumber: number;
 	startColumn: number;
@@ -159,7 +160,8 @@ export namespace IMarkerData {
 		// Modifed to not include the message as part of the marker key to work around
 		// https://github.com/microsoft/vscode/issues/77475
 		if (markerData.message && useMessage) {
-			result.push(markerData.message.replace('¦', '\\¦'));
+			const value = isMarkdownString(markerData.message) ? (markerData.message.plainTextValue || '') : markerData.message;
+			result.push(value.replace('¦', '\\¦'));
 		} else {
 			result.push(emptyString);
 		}