Adds shown command to proposed inline edit API (#233916)

src/vs/editor/common/languages.ts

@@ -760,6 +760,11 @@ export interface InlineCompletion {
 
 	readonly command?: Command;
 
+	/**
+	 * Is called the first time an inline completion is shown.
+	*/
+	readonly shownCommand?: Command;
+
 	/**
 	 * If set to `true`, unopened closing brackets are removed and unclosed opening brackets are closed.
 	 * Defaults to `false`.
@@ -2345,6 +2350,7 @@ export interface IInlineEdit {
 	range: IRange;
 	accepted?: Command;
 	rejected?: Command;
+	shown?: Command;
 	commands?: Command[];
 }
 

src/vs/editor/contrib/inlineCompletions/browser/model/inlineCompletionsModel.ts

@@ -314,7 +314,7 @@ export class InlineCompletionsModel extends Disposable {
 
 			const commands = item.inlineEdit.inlineCompletion.source.inlineCompletions.commands;
 			const renderExplicitly = this._jumpedTo.read(reader);
-			const inlineEdit = new InlineEdit(edit, currentItemIsCollapsed, renderExplicitly, commands ?? []);
+			const inlineEdit = new InlineEdit(edit, currentItemIsCollapsed, renderExplicitly, commands ?? [], item.inlineEdit.inlineCompletion);
 
 			return { kind: 'inlineEdit', inlineEdit, inlineCompletion: item.inlineEdit, edits: [edit], cursorAtInlineEdit };
 		}
@@ -681,6 +681,17 @@ export class InlineCompletionsModel extends Disposable {
 			this._editor.focus();
 		});
 	}
+
+	public async handleInlineCompletionShown(inlineCompletion: InlineCompletionItem): Promise<void> {
+		if (!inlineCompletion.shownCommand) {
+			return;
+		}
+		if (inlineCompletion.didShow) {
+			return;
+		}
+		inlineCompletion.markAsShown();
+		await this._commandService.executeCommand(inlineCompletion.shownCommand.id, ...(inlineCompletion.shownCommand.arguments || []));
+	}
 }
 
 interface Repro {

src/vs/editor/contrib/inlineCompletions/browser/model/inlineEdit.ts

@@ -5,13 +5,15 @@
 
 import { SingleTextEdit } from '../../../../common/core/textEdit.js';
 import { Command } from '../../../../common/languages.js';
+import { InlineCompletionItem } from './provideInlineCompletions.js';
 
 export class InlineEdit {
 	constructor(
 		public readonly edit: SingleTextEdit,
 		public readonly isCollapsed: boolean,
 		public readonly renderExplicitly: boolean,
 		public readonly commands: readonly Command[],
+		public readonly inlineCompletion: InlineCompletionItem,
 	) { }
 
 	public get range() {
@@ -23,6 +25,9 @@ export class InlineEdit {
 	}
 
 	public equals(other: InlineEdit): boolean {
-		return this.edit.equals(other.edit) && this.isCollapsed === other.isCollapsed && this.renderExplicitly === other.renderExplicitly;
+		return this.edit.equals(other.edit)
+			&& this.isCollapsed === other.isCollapsed
+			&& this.renderExplicitly === other.renderExplicitly
+			&& this.inlineCompletion === other.inlineCompletion;
 	}
 }

src/vs/editor/contrib/inlineCompletions/browser/model/inlineEditsAdapter.ts

@@ -71,6 +71,7 @@ export class InlineEditsAdapter extends Disposable {
 								range: e.result.range,
 								insertText: e.result.text,
 								command: e.result.accepted,
+								shownCommand: e.result.shown,
 								isInlineEdit: true,
 								edit: e.result,
 							};

src/vs/editor/contrib/inlineCompletions/browser/model/provideInlineCompletions.ts

@@ -323,6 +323,7 @@ export class InlineCompletionItem {
 		return new InlineCompletionItem(
 			insertText,
 			inlineCompletion.command,
+			inlineCompletion.shownCommand,
 			range,
 			insertText,
 			snippetInfo,
@@ -332,9 +333,12 @@ export class InlineCompletionItem {
 		);
 	}
 
+	private _didCallShow = false;
+
 	constructor(
 		readonly filterText: string,
 		readonly command: Command | undefined,
+		readonly shownCommand: Command | undefined,
 		readonly range: Range,
 		readonly insertText: string,
 		readonly snippetInfo: SnippetInfo | undefined,
@@ -358,10 +362,18 @@ export class InlineCompletionItem {
 		insertText = filterText.replace(/\r\n|\r/g, '\n');
 	}
 
+	public get didShow(): boolean {
+		return this._didCallShow;
+	}
+	public markAsShown(): void {
+		this._didCallShow = true;
+	}
+
 	public withRange(updatedRange: Range): InlineCompletionItem {
 		return new InlineCompletionItem(
 			this.filterText,
 			this.command,
+			this.shownCommand,
 			updatedRange,
 			this.insertText,
 			this.snippetInfo,

src/vs/editor/contrib/inlineCompletions/browser/view/inlineEdits/inlineEditsView.ts

@@ -190,6 +190,8 @@ export class InlineEditsView extends Disposable {
 		const edit = this._edit.read(reader);
 		if (!edit) { return undefined; }
 
+		this._model.get()?.handleInlineCompletionShown(edit.inlineCompletion);
+
 		let mappings = RangeMapping.fromEdit(edit.edit);
 		let newText = edit.edit.apply(edit.originalText);
 		let diff = lineRangeMappingFromRangeMappings(mappings, edit.originalText, new StringText(newText));

src/vs/editor/contrib/inlineCompletions/browser/view/inlineEdits/inlineEditsViewAndDiffProducer.ts

@@ -22,6 +22,7 @@ import { TextModelText } from '../../../../../common/model/textModelText.js';
 import { IModelService } from '../../../../../common/services/model.js';
 import { InlineCompletionsModel } from '../../model/inlineCompletionsModel.js';
 import { InlineEdit } from '../../model/inlineEdit.js';
+import { InlineCompletionItem } from '../../model/provideInlineCompletions.js';
 import { InlineEditsView } from './inlineEditsView.js';
 import { UniqueUriGenerator } from './utils.js';
 
@@ -81,7 +82,7 @@ export class InlineEditsViewAndDiffProducer extends Disposable {
 			));
 			const diffEdits = new TextEdit(edits);
 
-			return new InlineEditWithChanges(text, diffEdits, inlineEdit.isCollapsed, inlineEdit.renderExplicitly, inlineEdit.commands); //inlineEdit.showInlineIfPossible);
+			return new InlineEditWithChanges(text, diffEdits, inlineEdit.isCollapsed, inlineEdit.renderExplicitly, inlineEdit.commands, inlineEdit.inlineCompletion); //inlineEdit.showInlineIfPossible);
 		});
 	});
 
@@ -112,7 +113,8 @@ export class InlineEditWithChanges {
 		public readonly edit: TextEdit,
 		public readonly isCollapsed: boolean,
 		public readonly userJumpedToIt: boolean,
-		public readonly commands: readonly Command[]
+		public readonly commands: readonly Command[],
+		public readonly inlineCompletion: InlineCompletionItem,
 	) {
 	}
 
@@ -121,6 +123,7 @@ export class InlineEditWithChanges {
 			this.edit.equals(other.edit) &&
 			this.isCollapsed === other.isCollapsed &&
 			this.userJumpedToIt === other.userJumpedToIt &&
-			this.commands === other.commands;
+			this.commands === other.commands &&
+			this.inlineCompletion === other.inlineCompletion;
 	}
 }

src/vs/monaco.d.ts

@@ -7246,6 +7246,10 @@ declare namespace monaco.languages {
 		*/
 		readonly range?: IRange;
 		readonly command?: Command;
+		/**
+		 * Is called the first time an inline completion is shown.
+		*/
+		readonly shownCommand?: Command;
 		/**
 		 * If set to `true`, unopened closing brackets are removed and unclosed opening brackets are closed.
 		 * Defaults to `false`.
@@ -8134,6 +8138,7 @@ declare namespace monaco.languages {
 		range: IRange;
 		accepted?: Command;
 		rejected?: Command;
+		shown?: Command;
 		commands?: Command[];
 	}
 

src/vs/workbench/api/common/extHostLanguageFeatures.ts

@@ -1554,6 +1554,14 @@ class InlineEditAdapter {
 			rejectCommand = this._commands.toInternal(result.rejected, disposableStore);
 		}
 
+		let shownCommand: languages.Command | undefined = undefined;
+		if (result.shown) {
+			if (!disposableStore) {
+				disposableStore = new DisposableStore();
+			}
+			shownCommand = this._commands.toInternal(result.shown, disposableStore);
+		}
+
 		if (!disposableStore) {
 			disposableStore = new DisposableStore();
 		}
@@ -1563,6 +1571,7 @@ class InlineEditAdapter {
 			range: typeConvert.Range.from(result.range),
 			accepted: acceptCommand,
 			rejected: rejectCommand,
+			shown: shownCommand,
 			commands: result.commands?.map(c => this._commands.toInternal(c, disposableStore)),
 		};
 

src/vscode-dts/vscode.proposed.inlineEdit.d.ts

@@ -28,6 +28,8 @@ declare module 'vscode' {
 		 */
 		rejected?: Command;
 
+		shown?: Command;
+
 		commands?: Command[];
 
 		/**