Support llmGenerated property on CodeAction (#1557)

* add new property to codeAction

* add proposed api

* change to use codeActionTag

* add proposed

* add proposed to metaModel

* wording tweaks

* hygiene

* add client capability

client-node-tests/src/converter.test.ts

@@ -1547,6 +1547,26 @@ suite('Code Converter', () => {
 		strictEqual(result.triggerKind, proto.CodeActionTriggerKind.Automatic);
 	});
 
+	test('CodeAction - LLMGenerated tag c2p', () => {
+		const item: vscode.CodeAction = {
+			title: 'title',
+			isAI: true
+		};
+
+		const result = c2p.asCodeActionSync(item);
+		strictEqual(result.tags![0], proto.CodeActionTag.LLMGenerated);
+	});
+
+	test('CodeAction - LLMGenerated tag p2c', async () => {
+		const item: proto.CodeAction = {
+			title: 'title',
+			tags: [proto.CodeActionTag.LLMGenerated]
+		};
+
+		const result = await p2c.asCodeAction(item);
+		strictEqual(result.isAI, true);
+	});
+
 	test('Uri Rewrite', () => {
 		const converter = codeConverter.createConverter((value: vscode.Uri) => {
 			return `${value.toString()}.vscode`;

client/package.json

@@ -15,7 +15,7 @@
 	"bugs": {
 		"url": "https://github.com/Microsoft/vscode-languageserver-node/issues"
 	},
-	"enabledApiProposals": [],
+	"enabledApiProposals": ["codeActionAI"],
 	"exports": {
 		".": {
 			"types": "./lib/common/api.d.ts",

client/src/common/codeAction.ts

@@ -9,7 +9,8 @@ import {
 } from 'vscode';
 
 import {
-	ClientCapabilities, CancellationToken, ServerCapabilities, DocumentSelector, CodeActionRequest, CodeActionOptions, CodeActionRegistrationOptions, CodeActionParams, CodeActionResolveRequest, CodeActionKind
+	ClientCapabilities, CancellationToken, ServerCapabilities, DocumentSelector, CodeActionRequest, CodeActionOptions, CodeActionRegistrationOptions, CodeActionParams, CodeActionResolveRequest, CodeActionKind,
+	CodeActionTag
 } from 'vscode-languageserver-protocol';
 
 import * as UUID from './utils/uuid';
@@ -63,6 +64,9 @@ export class CodeActionFeature extends TextDocumentLanguageFeature<boolean | Cod
 		};
 		cap.honorsChangeAnnotations = true;
 		cap.documentationSupport = true;
+		cap.tagSupport = {
+			valueSet: [CodeActionTag.LLMGenerated]
+		};
 	}
 
 	public initialize(capabilities: ServerCapabilities, documentSelector: DocumentSelector): void {

client/src/common/codeConverter.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
+/// <reference path="../../typings/vscode.proposed.codeActionAI.d.ts" />
 
 import * as code from 'vscode';
 import * as proto from 'vscode-languageserver-protocol';
@@ -742,6 +743,10 @@ export function createConverter(uriConverter?: URIConverter): Converter {
 		if (item.command !== undefined) { result.command = asCommand(item.command); }
 		if (item.isPreferred !== undefined) { result.isPreferred = item.isPreferred; }
 		if (item.disabled !== undefined) { result.disabled = { reason: item.disabled.reason }; }
+		if (item.isAI) {
+			result.tags ??= [];
+			result.tags.push(proto.CodeActionTag.LLMGenerated);
+		}
 		return result;
 	}
 
@@ -756,6 +761,10 @@ export function createConverter(uriConverter?: URIConverter): Converter {
 		if (item.command !== undefined) { result.command = asCommand(item.command); }
 		if (item.isPreferred !== undefined) { result.isPreferred = item.isPreferred; }
 		if (item.disabled !== undefined) { result.disabled = { reason: item.disabled.reason }; }
+		if (item.isAI) {
+			result.tags ??= [];
+			result.tags.push(proto.CodeActionTag.LLMGenerated);
+		}
 		return result;
 	}
 

client/src/common/protocolConverter.ts

@@ -2,6 +2,7 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
+/// <reference path="../../typings/vscode.proposed.codeActionAI.d.ts" />
 
 import * as code from 'vscode';
 import * as ls from 'vscode-languageserver-protocol';
@@ -1020,6 +1021,10 @@ export function createConverter(
 		if (item.command !== undefined) { result.command = asCommand(item.command); }
 		if (item.isPreferred !== undefined) { result.isPreferred = item.isPreferred; }
 		if (item.disabled !== undefined) { result.disabled = { reason: item.disabled.reason }; }
+		if (item.tags?.includes(ls.CodeActionTag.LLMGenerated)) {
+			result.isAI = true;
+		}
+
 		return result;
 	}
 

client/typings/vscode.proposed.codeActionAI.d.ts

@@ -0,0 +1,16 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module 'vscode' {
+
+	export interface CodeAction {
+		/**
+		 * Marks this as an AI action.
+		 *
+		 * Ex: A quick fix should be marked AI if it invokes AI.
+		 */
+		isAI?: boolean;
+	}
+}

protocol/metaModel.json

@@ -5812,6 +5812,19 @@
 					"optional": true,
 					"documentation": "A data entry field that is preserved on a code action between\na `textDocument/codeAction` and a `codeAction/resolve` request.\n\n@since 3.16.0",
 					"since": "3.16.0"
+				},
+				{
+					"name": "tags",
+					"type": {
+						"kind": "array",
+						"element": {
+							"kind": "reference",
+							"name": "CodeActionTag"
+						}
+					},
+					"optional": true,
+					"documentation": "Tags for this code action.\n\n@since 3.18.0 - proposed",
+					"since": "3.18.0 - proposed"
 				}
 			],
 			"documentation": "A code action represents a change that can be performed in code, e.g. to fix a problem or\nto refactor code.\n\nA CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed."
@@ -12681,6 +12694,16 @@
 					"documentation": "Whether the client supports documentation for a class of\ncode actions.\n\n@since 3.18.0\n@proposed",
 					"since": "3.18.0",
 					"proposed": true
+				},
+				{
+					"name": "tagSupport",
+					"type": {
+						"kind": "reference",
+						"name": "CodeActionTagOptions"
+					},
+					"optional": true,
+					"documentation": "Client supports the tag property on a code action. Clients\nsupporting tags have to handle unknown tags gracefully.\n\n@since 3.18.0 - proposed",
+					"since": "3.18.0 - proposed"
 				}
 			],
 			"documentation": "The Client Capabilities of a {@link CodeActionRequest}."
@@ -13624,6 +13647,24 @@
 			"documentation": "@since 3.18.0",
 			"since": "3.18.0"
 		},
+		{
+			"name": "CodeActionTagOptions",
+			"properties": [
+				{
+					"name": "valueSet",
+					"type": {
+						"kind": "array",
+						"element": {
+							"kind": "reference",
+							"name": "CodeActionTag"
+						}
+					},
+					"documentation": "The tags supported by the client."
+				}
+			],
+			"documentation": "@since 3.18.0 - proposed",
+			"since": "3.18.0 - proposed"
+		},
 		{
 			"name": "ClientCodeLensResolveOptions",
 			"properties": [
@@ -14772,6 +14813,22 @@
 			"supportsCustomValues": true,
 			"documentation": "A set of predefined code action kinds"
 		},
+		{
+			"name": "CodeActionTag",
+			"type": {
+				"kind": "base",
+				"name": "uinteger"
+			},
+			"values": [
+				{
+					"name": "LLMGenerated",
+					"value": 1,
+					"documentation": "Marks the code action as LLM-generated."
+				}
+			],
+			"documentation": "Code action tags are extra annotations that tweak the behavior of a code action.\n\n@since 3.18.0 - proposed",
+			"since": "3.18.0 - proposed"
+		},
 		{
 			"name": "TraceValue",
 			"type": {

protocol/src/common/protocol.ts

@@ -13,7 +13,8 @@ import {
 	Hover, SignatureHelp, Definition, DefinitionLink, ReferenceContext, DocumentHighlight, SymbolInformation,
 	CodeLens, CodeActionContext, FormattingOptions, DocumentLink, MarkupKind, SymbolKind, CompletionItemKind,
 	CodeAction, CodeActionKind, DocumentSymbol, CompletionItemTag, DiagnosticTag, SymbolTag, uinteger, integer,
-	InsertTextMode, LSPAny, WorkspaceSymbol, URI, WorkspaceFolder
+	InsertTextMode, LSPAny, WorkspaceSymbol, URI, WorkspaceFolder,
+	CodeActionTag
 } from 'vscode-languageserver-types';
 
 import * as Is from './utils/is';
@@ -3300,8 +3301,26 @@ export interface CodeActionClientCapabilities {
 	 * @proposed
 	 */
 	 documentationSupport?: boolean;
+
+	/**
+	 * Client supports the tag property on a code action. Clients
+	 * supporting tags have to handle unknown tags gracefully.
+	 *
+	 * @since 3.18.0 - proposed
+	 */
+	tagSupport?: CodeActionTagOptions;
 }
 
+/**
+ * @since 3.18.0 - proposed
+ */
+export type CodeActionTagOptions = {
+	/**
+	 * The tags supported by the client.
+	 */
+	valueSet: CodeActionTag[];
+};
+
 /**
  * The parameters of a {@link CodeActionRequest}.
  */

types/src/main.ts

@@ -3372,6 +3372,26 @@ export type CodeActionDisabled = {
 	reason: string;
 };
 
+/**
+ * Code action tags are extra annotations that tweak the behavior of a code action.
+ *
+ * @since 3.18.0 - proposed
+ */
+export namespace CodeActionTag {
+	/**
+	 * Marks the code action as LLM-generated.
+	 */
+	export const LLMGenerated = 1;
+
+	/**
+	 * Checks whether the given literal conforms to the {@link CodeActionTag} interface.
+	 */
+	export function is(value: any): value is CodeActionTag {
+		return Is.defined(value) && value === CodeActionTag.LLMGenerated;
+	}
+}
+export type CodeActionTag = 1;
+
 /**
  * A code action represents a change that can be performed in code, e.g. to fix a problem or
  * to refactor code.
@@ -3446,6 +3466,13 @@ export interface CodeAction {
 	 * @since 3.16.0
 	 */
 	data?: LSPAny;
+
+	/**
+ 	 * Tags for this code action.
+	 *
+	 * @since 3.18.0 - proposed
+	 */
+	tags?: CodeActionTag[];
 }
 
 export namespace CodeAction {
@@ -3499,7 +3526,8 @@ export namespace CodeAction {
 			(candidate.edit !== undefined || candidate.command !== undefined) &&
 			(candidate.command === undefined || Command.is(candidate.command)) &&
 			(candidate.isPreferred === undefined || Is.boolean(candidate.isPreferred)) &&
-			(candidate.edit === undefined || WorkspaceEdit.is(candidate.edit));
+			(candidate.edit === undefined || WorkspaceEdit.is(candidate.edit)) &&
+			(candidate.tags === undefined || Is.typedArray(candidate.tags, CodeActionTag.is));
 	}
 }