Support show range for inline edits (#237532)

Support a show range around the edit

src/vs/editor/common/config/editorOptions.ts

@@ -4200,7 +4200,6 @@ export interface IInlineSuggestOptions {
 			useWordInsertionView?: 'never' | 'whenPossible';
 			useWordReplacementView?: 'never' | 'whenPossible';
 
-			onlyShowWhenCloseToCursor?: boolean;
 			useGutterIndicator?: boolean;
 		};
 	};
@@ -4235,7 +4234,6 @@ class InlineEditorSuggest extends BaseEditorOption<EditorOption.inlineSuggest, I
 					useInterleavedLinesDiff: 'never',
 					useWordInsertionView: 'whenPossible',
 					useWordReplacementView: 'whenPossible',
-					onlyShowWhenCloseToCursor: true,
 					useGutterIndicator: true,
 				},
 			},
@@ -4304,11 +4302,6 @@ class InlineEditorSuggest extends BaseEditorOption<EditorOption.inlineSuggest, I
 					description: nls.localize('inlineSuggest.edits.experimental.useWordReplacementView', "Controls whether to enable experimental word replacement view in inline suggestions."),
 					enum: ['never', 'whenPossible'],
 				},
-				'editor.inlineSuggest.edits.experimental.onlyShowWhenCloseToCursor': {
-					type: 'boolean',
-					default: defaults.edits.experimental.onlyShowWhenCloseToCursor,
-					description: nls.localize('inlineSuggest.edits.experimental.onlyShowWhenCloseToCursor', "Controls whether to only show inline suggestions when the cursor is close to the suggestion.")
-				},
 				'editor.inlineSuggest.edits.experimental.useGutterIndicator': {
 					type: 'boolean',
 					default: defaults.edits.experimental.useGutterIndicator,
@@ -4338,7 +4331,6 @@ class InlineEditorSuggest extends BaseEditorOption<EditorOption.inlineSuggest, I
 					useInterleavedLinesDiff: stringSet(input.edits?.experimental?.useInterleavedLinesDiff, this.defaultValue.edits.experimental.useInterleavedLinesDiff, ['never', 'always', 'afterJump']),
 					useWordInsertionView: stringSet(input.edits?.experimental?.useWordInsertionView, this.defaultValue.edits.experimental.useWordInsertionView, ['never', 'whenPossible']),
 					useWordReplacementView: stringSet(input.edits?.experimental?.useWordReplacementView, this.defaultValue.edits.experimental.useWordReplacementView, ['never', 'whenPossible']),
-					onlyShowWhenCloseToCursor: boolean(input.edits?.experimental?.onlyShowWhenCloseToCursor, this.defaultValue.edits.experimental.onlyShowWhenCloseToCursor),
 					useGutterIndicator: boolean(input.edits?.experimental?.useGutterIndicator, this.defaultValue.edits.experimental.useGutterIndicator),
 				},
 			},

src/vs/editor/common/languages.ts

@@ -774,6 +774,8 @@ export interface InlineCompletion {
 	readonly completeBracketPairs?: boolean;
 
 	readonly isInlineEdit?: boolean;
+
+	readonly showRange?: IRange;
 }
 
 export interface InlineCompletions<TItem extends InlineCompletion = InlineCompletion> {
@@ -2396,6 +2398,7 @@ export interface MappedEditsProvider {
 export interface IInlineEdit {
 	text: string;
 	range: IRange;
+	showRange?: IRange;
 	accepted?: Command;
 	rejected?: Command;
 	shown?: Command;

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

@@ -54,7 +54,6 @@ export class InlineCompletionsModel extends Disposable {
 
 	private readonly _editorObs = observableCodeEditor(this._editor);
 
-	private readonly _onlyShowWhenCloseToCursor = this._editorObs.getOption(EditorOption.inlineSuggest).map(v => !!v.edits.experimental.onlyShowWhenCloseToCursor);
 	private readonly _suggestPreviewEnabled = this._editorObs.getOption(EditorOption.suggest).map(v => v.preview);
 	private readonly _suggestPreviewMode = this._editorObs.getOption(EditorOption.suggest).map(v => v.previewMode);
 	private readonly _inlineSuggestMode = this._editorObs.getOption(EditorOption.inlineSuggest).map(v => v.mode);
@@ -358,12 +357,13 @@ export class InlineCompletionsModel extends Disposable {
 
 			const cursorPos = this.primaryPosition.read(reader);
 			const cursorAtInlineEdit = LineRange.fromRangeInclusive(edit.range).addMargin(1, 1).contains(cursorPos.lineNumber);
+			const cursorInsideShowRange = cursorAtInlineEdit || (item.inlineEdit.inlineCompletion.cursorShowRange?.containsPosition(cursorPos) ?? true);
 
-			const cursorDist = LineRange.fromRange(edit.range).distanceToLine(this.primaryPosition.read(reader).lineNumber);
-
-			if (this._onlyShowWhenCloseToCursor.read(reader) && cursorDist > 3 && !item.inlineEdit.request.isExplicitRequest && !this._inAcceptFlow.read(reader)) {
+			if (!cursorInsideShowRange && !this._inAcceptFlow.read(reader)) {
 				return undefined;
 			}
+
+			const cursorDist = LineRange.fromRange(edit.range).distanceToLine(this.primaryPosition.read(reader).lineNumber);
 			const disableCollapsing = true;
 			const currentItemIsCollapsed = !disableCollapsing && (cursorDist > 1 && this._collapsedInlineEditId.read(reader) === item.inlineEdit.semanticId);
 
@@ -575,6 +575,7 @@ export class InlineCompletionsModel extends Disposable {
 
 		editor.pushUndoStop();
 		if (completion.snippetInfo) {
+			// ...
 			editor.executeEdits(
 				'inlineSuggestion.accept',
 				[

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

@@ -69,6 +69,7 @@ export class InlineEditsAdapter extends Disposable {
 						items: definedEdits.map(e => {
 							return {
 								range: e.result.range,
+								showRange: e.result.showRange,
 								insertText: e.result.text,
 								command: e.result.accepted,
 								shownCommand: e.result.shown,

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

@@ -330,6 +330,7 @@ export class InlineCompletionItem {
 			range,
 			insertText,
 			snippetInfo,
+			Range.lift(inlineCompletion.showRange) ?? undefined,
 			inlineCompletion.additionalTextEdits || getReadonlyEmptyArray(),
 			inlineCompletion,
 			source,
@@ -345,6 +346,7 @@ export class InlineCompletionItem {
 		readonly range: Range,
 		readonly insertText: string,
 		readonly snippetInfo: SnippetInfo | undefined,
+		readonly cursorShowRange: Range | undefined,
 
 		readonly additionalTextEdits: readonly ISingleEditOperation[],
 
@@ -380,6 +382,7 @@ export class InlineCompletionItem {
 			updatedRange,
 			this.insertText,
 			this.snippetInfo,
+			this.cursorShowRange,
 			this.additionalTextEdits,
 			this.sourceInlineCompletion,
 			this.source,

src/vs/monaco.d.ts

@@ -4607,7 +4607,6 @@ declare namespace monaco.editor {
 				useInterleavedLinesDiff?: 'never' | 'always' | 'afterJump';
 				useWordInsertionView?: 'never' | 'whenPossible';
 				useWordReplacementView?: 'never' | 'whenPossible';
-				onlyShowWhenCloseToCursor?: boolean;
 				useGutterIndicator?: boolean;
 			};
 		};
@@ -7277,6 +7276,7 @@ declare namespace monaco.languages {
 		*/
 		readonly completeBracketPairs?: boolean;
 		readonly isInlineEdit?: boolean;
+		readonly showRange?: IRange;
 	}
 
 	export interface InlineCompletions<TItem extends InlineCompletion = InlineCompletion> {
@@ -8164,6 +8164,7 @@ declare namespace monaco.languages {
 	export interface IInlineEdit {
 		text: string;
 		range: IRange;
+		showRange?: IRange;
 		accepted?: Command;
 		rejected?: Command;
 		shown?: Command;

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

@@ -1577,6 +1577,7 @@ class InlineEditAdapter {
 			pid,
 			text: result.text,
 			range: typeConvert.Range.from(result.range),
+			showRange: typeConvert.Range.from(result.showRange),
 			accepted: acceptCommand,
 			rejected: rejectCommand,
 			shown: shownCommand,

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

@@ -13,11 +13,17 @@ declare module 'vscode' {
 		readonly text: string;
 
 		/**
-		 * An range that will be replaced by the text of the inline edit.
-		 * If change is only additive, this can be empty (same start and end position).
+		 * A range that will be replaced by the text of the inline edit.
+		 * If the change is only additive, this can be empty (same start and end position).
 		 */
 		readonly range: Range;
 
+		/**
+		 * A range specifying when the edit can be shown based on the cursor position.
+		 * If the cursor is within this range, the inline edit can be displayed.
+		 */
+		readonly showRange?: Range;
+
 		/**
 		 * An optional command that will be executed after applying the inline edit.
 		 */
@@ -36,7 +42,7 @@ declare module 'vscode' {
 		 * Creates a new inline edit.
 		 *
 		 * @param text The new text for this edit.
-		 * @param replaceRange An range that will be replaced by the text of the inline edit.
+		 * @param range A range that will be replaced by the text of the inline edit.
 		 */
 		constructor(text: string, range: Range);
 	}