Add text edit support for inlay hints

Author: dbaeumer

client/src/common/codeConverter.ts

@@ -860,6 +860,7 @@ export function createConverter(uriConverter?: URIConverter): Converter {
 			: item.label.map(asInlayHintLabelPart);
 		const result = proto.Proposed.InlayHint.create(asPosition(item.position), label);
 		if (item.kind !== undefined) { result.kind = item.kind; }
+		if (item.textEdits !== undefined) { result.textEdits = asTextEdits(item.textEdits); }
 		if (item.tooltip !== undefined) { result.tooltip = asTooltip(item.tooltip); }
 		if (item.paddingLeft !== undefined) { result.paddingLeft = item.paddingLeft; }
 		if (item.paddingRight !== undefined) { result.paddingRight = item.paddingRight; }

client/src/common/protocolConverter.ts

@@ -1203,6 +1203,7 @@ export function createConverter(uriConverter: URIConverter | undefined, trustMar
 			: await async.map(value.label, asInlayHintLabelPart, token);
 		const result = new code.InlayHint(asPosition(value.position), label);
 		if (value.kind !== undefined) { result.kind = value.kind; }
+		if (value.textEdits !== undefined) { result.textEdits = await asTextEdits(value.textEdits, token); }
 		if (value.tooltip !== undefined) { result.tooltip = asTooltip(value.tooltip); }
 		if (value.paddingLeft !== undefined) { result.paddingLeft = value.paddingLeft; }
 		if (value.paddingRight !== undefined) { result.paddingRight = value.paddingRight; }

client/typings/vscode.proposed.d.ts

@@ -4,4 +4,17 @@
  *--------------------------------------------------------------------------------------------*/
 
 declare module 'vscode' {
+	/**
+     * Inlay hint information.
+     */
+	export interface InlayHint {
+		/**
+		 * Optional {@link TextEdit text edits} that are performed when accepting this inlay hint. The default
+		 * gesture for accepting an inlay hint is the double click.
+		 *
+		 * *Note* that edits are expected to change the document so that the inlay hint (or its nearest variant) is
+		 * now part of the document and the inlay hint itself is now obsolete.
+		 */
+		textEdits?: TextEdit[];
+	}
 }

protocol/src/common/proposed.inlayHint.md

@@ -123,6 +123,15 @@ export type InlayHint = {
 	 */
 	kind?: InlayHintKind;
 
+	/**
+	 * Optional text edits that are performed when accepting this inlay hint.
+	 *
+	 * *Note* that edits are expected to change the document so that the inlay
+	 * hint (or its nearest variant) is now part of the document and the inlay
+	 * hint itself is now obsolete.
+	 */
+	textEdits?: TextEdit[];
+
 	/**
 	 * The tooltip text when you hover over this item.
 	 */

protocol/src/common/proposed.inlayHint.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { RequestHandler, RequestHandler0 } from 'vscode-jsonrpc';
-import { Command, Location, MarkupContent, Position, Range, TextDocumentIdentifier } from 'vscode-languageserver-types';
+import { Command, Location, MarkupContent, Position, Range, TextDocumentIdentifier, TextEdit } from 'vscode-languageserver-types';
 import { ProtocolRequestType, ProtocolRequestType0 } from './messages';
 
 import type { StaticRegistrationOptions, TextDocumentRegistrationOptions, WorkDoneProgressOptions, WorkDoneProgressParams } from './protocol';
@@ -162,6 +162,15 @@ export type InlayHint = {
 	 */
 	kind?: InlayHintKind;
 
+	/**
+	 * Optional text edits that are performed when accepting this inlay hint.
+	 *
+	 * *Note* that edits are expected to change the document so that the inlay
+	 * hint (or its nearest variant) is now part of the document and the inlay
+	 * hint itself is now obsolete.
+	 */
+	textEdits?: TextEdit[];
+
 	/**
 	 * The tooltip text when you hover over this item.
 	 */
@@ -201,6 +210,7 @@ export namespace InlayHint {
 		return Is.objectLiteral(candidate) && Position.is(candidate.position)
 			&& (Is.string(candidate.label) || Is.typedArray(candidate.label, InlayHintLabelPart.is))
 			&& (candidate.kind === undefined || InlayHintKind.is(candidate.kind))
+			&& (candidate.textEdits === undefined) || Is.typedArray(candidate.textEdits, TextEdit.is)
 			&& (candidate.tooltip === undefined || Is.string(candidate.tooltip) || MarkupContent.is(candidate.tooltip))
 			&& (candidate.paddingLeft === undefined || Is.boolean(candidate.paddingLeft))
 			&& (candidate.paddingRight === undefined || Is.boolean(candidate.paddingRight));