Add TextDocumentContentResult (#1538)

client-node-tests/src/servers/testServer.ts

@@ -526,7 +526,7 @@ connection.languages.inlineCompletion.on((_params) => {
 });
 
 connection.workspace.textDocumentContent.on((_params) => {
-	return 'Some test content';
+	return { text: 'Some test content' };
 });
 
 connection.onRequest(

client/src/common/textDocumentContent.ts

@@ -68,7 +68,7 @@ export class TextDocumentContentFeature extends WorkspaceFeature<TextDocumentCon
 						if (token.isCancellationRequested) {
 							return null;
 						}
-						return result;
+						return result.text;
 					}, (error) => {
 						return client.handleFailedRequest(TextDocumentContentRequest.type, token, error, null);
 					});

protocol/src/common/protocol.textDocumentContent.ts

@@ -56,6 +56,22 @@ export interface TextDocumentContentParams {
 	uri: DocumentUri;
 }
 
+/**
+ * Result of the `workspace/textDocumentContent` request.
+ *
+ * @since 3.18.0
+ * @proposed
+ */
+export interface TextDocumentContentResult {
+	/**
+	 * The text content of the text document. Please note, that the content of
+	 * any subsequent open notifications for the text document might differ
+	 * from the returned content due to whitespace and line ending
+	 * normalizations done on the client
+	 */
+	text: string;
+}
+
 /**
  * The `workspace/textDocumentContent` request is sent from the client to the
  * server to request the content of a text document.
@@ -66,8 +82,8 @@ export interface TextDocumentContentParams {
 export namespace TextDocumentContentRequest {
 	export const method: 'workspace/textDocumentContent' = 'workspace/textDocumentContent';
 	export const messageDirection: MessageDirection = MessageDirection.clientToServer;
-	export const type = new ProtocolRequestType<TextDocumentContentParams, string, void, void, TextDocumentContentRegistrationOptions>(method);
-	export type HandlerSignature = RequestHandler<TextDocumentContentParams, string, void>;
+	export const type = new ProtocolRequestType<TextDocumentContentParams, TextDocumentContentResult, void, void, TextDocumentContentRegistrationOptions>(method);
+	export type HandlerSignature = RequestHandler<TextDocumentContentParams, TextDocumentContentResult, void>;
 }
 
 /**

protocol/src/common/protocol.ts

@@ -126,7 +126,7 @@ import {
 } from './protocol.inlineCompletion';
 
 import {
-	TextDocumentContentClientCapabilities, TextDocumentContentOptions, TextDocumentContentRegistrationOptions, TextDocumentContentParams,
+	TextDocumentContentClientCapabilities, TextDocumentContentOptions, TextDocumentContentRegistrationOptions, TextDocumentContentParams, TextDocumentContentResult,
 	TextDocumentContentRequest, TextDocumentContentRefreshParams, TextDocumentContentRefreshRequest
 } from './protocol.textDocumentContent';
 
@@ -4310,8 +4310,8 @@ export {
 	// Inline Completions
 	InlineCompletionClientCapabilities, InlineCompletionOptions, InlineCompletionParams, InlineCompletionRegistrationOptions, InlineCompletionRequest,
 	// Text Document Content
-	TextDocumentContentClientCapabilities, TextDocumentContentOptions, TextDocumentContentRegistrationOptions, TextDocumentContentParams, TextDocumentContentRequest,
-	TextDocumentContentRefreshParams, TextDocumentContentRefreshRequest
+	TextDocumentContentClientCapabilities, TextDocumentContentOptions, TextDocumentContentRegistrationOptions, TextDocumentContentParams, TextDocumentContentResult,
+	TextDocumentContentRequest, TextDocumentContentRefreshParams, TextDocumentContentRefreshRequest
 };
 
 // To be backwards compatible

server/src/common/textDocumentContent.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import { TextDocumentContentRefreshRequest, TextDocumentContentRequest, type Disposable, type DocumentUri, type RequestHandler, type TextDocumentContentParams } from 'vscode-languageserver-protocol';
+import { TextDocumentContentRefreshRequest, TextDocumentContentRequest, type Disposable, type DocumentUri, type RequestHandler, type TextDocumentContentParams, type TextDocumentContentResult } from 'vscode-languageserver-protocol';
 
 import type { Feature, _RemoteWorkspace } from './server';
 
@@ -16,7 +16,7 @@ import type { Feature, _RemoteWorkspace } from './server';
 export interface TextDocumentContentFeatureShape {
 	textDocumentContent: {
 		refresh(uri: DocumentUri): Promise<void>;
-		on(handler: RequestHandler<TextDocumentContentParams, string | null, void>): Disposable;
+		on(handler: RequestHandler<TextDocumentContentParams, TextDocumentContentResult | null, void>): Disposable;
 	};
 }
 
@@ -27,7 +27,7 @@ export const TextDocumentContentFeature: Feature<_RemoteWorkspace, TextDocumentC
 				refresh: (uri: DocumentUri): Promise<void> => {
 					return this.connection.sendRequest(TextDocumentContentRefreshRequest.type, { uri });
 				},
-				on: (handler: RequestHandler<TextDocumentContentParams, string | null, void>): Disposable => {
+				on: (handler: RequestHandler<TextDocumentContentParams, TextDocumentContentResult | null, void>): Disposable => {
 					return this.connection.onRequest(TextDocumentContentRequest.type, (params, cancel) => {
 						return handler(params, cancel);
 					});

testbed/server/src/server.ts

@@ -699,7 +699,7 @@ connection.languages.semanticTokens.onRange((params) => {
 
 let counter = 0;
 connection.workspace.textDocumentContent.on((_param) => {
-	return `Text content version ${counter++}`;
+	return { text: `Text content version ${counter++}` };
 });
 
 const refreshNotification: NotificationType<string> = new NotificationType<string>('testbed/refreshContent');