Merge pull request microsoft#273106 from microsoft/benibenj/scattered-sailfish

Add jumpToEdit support for inline completions

Author: benibenj

src/vs/editor/common/languages.ts

@@ -854,6 +854,7 @@ export interface InlineCompletionDisplayLocation {
 	range: IRange;
 	kind: InlineCompletionDisplayLocationKind;
 	label: string;
+	jumpToEdit: boolean;
 }
 
 /**

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

@@ -73,14 +73,7 @@ export class InlineCompletionsModel extends Disposable {
 			return false;
 		}
 
-		const targetRange = state.inlineCompletion.targetRange;
-		const visibleRanges = this._editorObs.editor.getVisibleRanges();
-		if (visibleRanges.length < 1) {
-			return false;
-		}
-
-		const viewportRange = new Range(visibleRanges[0].startLineNumber, visibleRanges[0].startColumn, visibleRanges[visibleRanges.length - 1].endLineNumber, visibleRanges[visibleRanges.length - 1].endColumn);
-		return viewportRange.containsRange(targetRange);
+		return isSuggestionInViewport(this._editor, state.inlineCompletion);
 	});
 	public get isAcceptingPartially() { return this._isAcceptingPartially; }
 
@@ -828,7 +821,7 @@ export class InlineCompletionsModel extends Disposable {
 		if (this._tabShouldIndent.read(reader)) {
 			return false;
 		}
-		if (this._inAcceptFlow.read(reader) && this._appearedInsideViewport.read(reader)) {
+		if (this._inAcceptFlow.read(reader) && this._appearedInsideViewport.read(reader) && !s.inlineCompletion.displayLocation?.jumpToEdit) {
 			return true;
 		}
 		if (s.inlineCompletion.targetRange.startLineNumber === this._editorObs.cursorLineNumber.read(reader)) {
@@ -1120,6 +1113,8 @@ export class InlineCompletionsModel extends Disposable {
 				this._editor.revealRange(revealRange, ScrollType.Immediate);
 			}
 
+			s.inlineCompletion.identity.setJumpTo(tx);
+
 			this._editor.focus();
 		});
 	}
@@ -1210,3 +1205,14 @@ class FadeoutDecoration extends Disposable {
 		}));
 	}
 }
+
+function isSuggestionInViewport(editor: ICodeEditor, suggestion: InlineSuggestionItem): boolean {
+	const targetRange = suggestion.targetRange;
+	const visibleRanges = editor.getVisibleRanges();
+	if (visibleRanges.length < 1) {
+		return false;
+	}
+
+	const viewportRange = new Range(visibleRanges[0].startLineNumber, visibleRanges[0].startColumn, visibleRanges[visibleRanges.length - 1].endLineNumber, visibleRanges[visibleRanges.length - 1].endColumn);
+	return viewportRange.containsRange(targetRange);
+}

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

@@ -268,6 +268,7 @@ export class InlineCompletionsSource extends Disposable {
 					const result = suggestions.map(c => ({
 						range: c.editRange.toString(),
 						text: c.insertText,
+						displayLocation: c.displayLocation ? { label: c.displayLocation.label, range: c.displayLocation.range.toString(), kind: c.displayLocation.kind, jumpToEdit: c.displayLocation.jumpToEdit } : undefined,
 						isInlineEdit: c.isInlineEdit,
 						showInlineEditMenu: c.showInlineEditMenu,
 						providerId: c.source.provider.providerId?.toString(),

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

@@ -5,7 +5,7 @@
 
 import { BugIndicatingError } from '../../../../../base/common/errors.js';
 import { matchesSubString } from '../../../../../base/common/filters.js';
-import { IObservable, observableSignal } from '../../../../../base/common/observable.js';
+import { IObservable, ITransaction, observableSignal, observableValue } from '../../../../../base/common/observable.js';
 import { commonPrefixLength, commonSuffixLength, splitLines } from '../../../../../base/common/strings.js';
 import { ICommandService } from '../../../../../platform/commands/common/commands.js';
 import { ISingleEditOperation } from '../../../../common/core/editOperation.js';
@@ -57,7 +57,7 @@ abstract class InlineSuggestionItemBase {
 	public get isFromExplicitRequest(): boolean { return this._data.context.triggerKind === InlineCompletionTriggerKind.Explicit; }
 	public get forwardStable(): boolean { return this.source.inlineSuggestions.enableForwardStability ?? false; }
 	public get editRange(): Range { return this.getSingleTextEdit().range; }
-	public get targetRange(): Range { return this.displayLocation?.range ?? this.editRange; }
+	public get targetRange(): Range { return this.displayLocation?.range && !this.displayLocation.jumpToEdit ? this.displayLocation?.range : this.editRange; }
 	public get insertText(): string { return this.getSingleTextEdit().text; }
 	public get semanticId(): string { return this.hash; }
 	public get action(): Command | undefined { return this._sourceInlineCompletion.action; }
@@ -143,6 +143,11 @@ export class InlineSuggestionIdentity {
 	private readonly _onDispose = observableSignal(this);
 	public readonly onDispose: IObservable<void> = this._onDispose;
 
+	private readonly _jumpedTo = observableValue(this, false);
+	public get jumpedTo(): IObservable<boolean> {
+		return this._jumpedTo;
+	}
+
 	private _refCount = 1;
 	public readonly id = 'InlineCompletionIdentity' + InlineSuggestionIdentity.idCounter++;
 
@@ -156,6 +161,10 @@ export class InlineSuggestionIdentity {
 			this._onDispose.trigger(undefined);
 		}
 	}
+
+	setJumpTo(tx: ITransaction | undefined): void {
+		this._jumpedTo.set(true, tx);
+	}
 }
 
 class InlineSuggestDisplayLocation implements IDisplayLocation {
@@ -164,14 +173,16 @@ class InlineSuggestDisplayLocation implements IDisplayLocation {
 		return new InlineSuggestDisplayLocation(
 			displayLocation.range,
 			displayLocation.label,
-			displayLocation.kind
+			displayLocation.kind,
+			displayLocation.jumpToEdit
 		);
 	}
 
 	private constructor(
 		public readonly range: Range,
 		public readonly label: string,
-		public readonly kind: InlineCompletionDisplayLocationKind
+		public readonly kind: InlineCompletionDisplayLocationKind,
+		public readonly jumpToEdit: boolean,
 	) { }
 
 	public withEdit(edit: StringEdit, positionOffsetTransformer: PositionOffsetTransformerBase): InlineSuggestDisplayLocation | undefined {
@@ -187,7 +198,7 @@ class InlineSuggestDisplayLocation implements IDisplayLocation {
 
 		const newRange = positionOffsetTransformer.getRange(newOffsetRange);
 
-		return new InlineSuggestDisplayLocation(newRange, this.label, this.kind);
+		return new InlineSuggestDisplayLocation(newRange, this.label, this.kind, this.jumpToEdit);
 	}
 }
 

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

@@ -231,7 +231,8 @@ function toInlineSuggestData(
 	const displayLocation = inlineCompletion.displayLocation ? {
 		range: Range.lift(inlineCompletion.displayLocation.range),
 		label: inlineCompletion.displayLocation.label,
-		kind: inlineCompletion.displayLocation.kind
+		kind: inlineCompletion.displayLocation.kind,
+		jumpToEdit: inlineCompletion.displayLocation.jumpToEdit,
 	} : undefined;
 
 	return new InlineSuggestData(
@@ -476,6 +477,7 @@ export interface IDisplayLocation {
 	range: Range;
 	label: string;
 	kind: InlineCompletionDisplayLocationKind;
+	jumpToEdit: boolean;
 }
 
 export enum InlineCompletionEditorType {

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

@@ -46,7 +46,7 @@ export class InlineEditsView extends Disposable {
 
 	private readonly _tabAction;
 
-	private _previousView: {
+	private _previousView: { // TODO, move into identity
 		id: string;
 		view: ReturnType<typeof InlineEditsView.prototype.determineView>;
 		editorWidth: number;
@@ -384,7 +384,7 @@ export class InlineEditsView extends Disposable {
 	private determineView(model: IInlineEditModel, reader: IReader, diff: DetailedLineRangeMapping[], newText: StringText): InlineCompletionViewKind {
 		// Check if we can use the previous view if it is the same InlineCompletion as previously shown
 		const inlineEdit = model.inlineEdit;
-		const canUseCache = this._previousView?.id === this.getCacheId(model);
+		const canUseCache = this._previousView?.id === this.getCacheId(model) && !model.displayLocation?.jumpToEdit;
 		const reconsiderViewEditorWidthChange = this._previousView?.editorWidth !== this._editorObs.layoutInfoWidth.read(reader) &&
 			(
 				this._previousView?.view === InlineCompletionViewKind.SideBySide ||
@@ -395,7 +395,7 @@ export class InlineEditsView extends Disposable {
 			return this._previousView!.view;
 		}
 
-		if (model.displayLocation) {
+		if (model.displayLocation && !model.inlineEdit.inlineCompletion.identity.jumpedTo.read(reader)) {
 			return InlineCompletionViewKind.Custom;
 		}
 

src/vs/monaco.d.ts

@@ -7566,6 +7566,7 @@ declare namespace monaco.languages {
 		range: IRange;
 		kind: InlineCompletionDisplayLocationKind;
 		label: string;
+		jumpToEdit: boolean;
 	}
 
 	/**

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

@@ -1440,6 +1440,7 @@ class InlineCompletionAdapter {
 						range: typeConvert.Range.from(item.displayLocation.range),
 						label: item.displayLocation.label,
 						kind: item.displayLocation.kind ? typeConvert.InlineCompletionDisplayLocationKind.from(item.displayLocation.kind) : InlineCompletionDisplayLocationKind.Code,
+						jumpToEdit: item.displayLocation.jumpToEdit ?? false,
 					} : undefined,
 					warning: (item.warning && this._isAdditionsProposedApiEnabled) ? {
 						message: typeConvert.MarkdownString.from(item.warning.message),

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

@@ -78,6 +78,7 @@ declare module 'vscode' {
 		range: Range;
 		kind: InlineCompletionDisplayLocationKind;
 		label: string;
+		jumpToEdit?: boolean;
 	}
 
 	export interface InlineCompletionWarning {