Merge pull request microsoft#126413 from microsoft/inline-suggest-prevent-auto-suggest

Do not auto-trigger suggest when typing exactly the inline suggestion

Author: hediet

src/vs/editor/contrib/inlineCompletions/ghostTextController.ts

@@ -19,7 +19,7 @@ import { ContextKeyExpr, IContextKeyService, RawContextKey } from 'vs/platform/c
 import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
 
 export class GhostTextController extends Disposable {
-	public static readonly inlineSuggestionVisible = new RawContextKey<boolean>('inlineSuggestionVisible ', false, nls.localize('inlineSuggestionVisible', "Whether an inline suggestion is visible"));
+	public static readonly inlineSuggestionVisible = new RawContextKey<boolean>('inlineSuggestionVisible', false, nls.localize('inlineSuggestionVisible', "Whether an inline suggestion is visible"));
 	public static readonly inlineSuggestionHasIndentation = new RawContextKey<boolean>('inlineSuggestionHasIndentation', false, nls.localize('inlineSuggestionHasIndentation', "Whether the inline suggestion starts with whitespace"));
 
 	static ID = 'editor.contrib.ghostTextController';
@@ -50,6 +50,9 @@ export class GhostTextController extends Disposable {
 			if (e.hasChanged(EditorOption.suggest)) {
 				this.updateModelController();
 			}
+			if (e.hasChanged(EditorOption.inlineSuggest)) {
+				this.updateModelController();
+			}
 		}));
 		this.updateModelController();
 	}

src/vs/editor/contrib/suggest/suggestModel.ts

@@ -24,6 +24,8 @@ import { isLowSurrogate, isHighSurrogate, getLeadingWhitespace } from 'vs/base/c
 import { IClipboardService } from 'vs/platform/clipboard/common/clipboardService';
 import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';
 import { ILogService } from 'vs/platform/log/common/log';
+import { IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
+import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
 
 export interface ICancelEvent {
 	readonly retrigger: boolean;
@@ -95,6 +97,20 @@ export const enum State {
 	Auto = 2
 }
 
+function shouldPreventQuickSuggest(contextKeyService: IContextKeyService, configurationService: IConfigurationService): boolean {
+	return (
+		Boolean(contextKeyService.getContextKeyValue<boolean>('inlineSuggestionVisible'))
+		&& !Boolean(configurationService.getValue<boolean>('editor.inlineSuggest.allowQuickSuggestions'))
+	);
+}
+
+function shouldPreventSuggestOnTriggerCharacters(contextKeyService: IContextKeyService, configurationService: IConfigurationService): boolean {
+	return (
+		Boolean(contextKeyService.getContextKeyValue<boolean>('inlineSuggestionVisible'))
+		&& !Boolean(configurationService.getValue<boolean>('editor.inlineSuggest.allowSuggestOnTriggerCharacters'))
+	);
+}
+
 export class SuggestModel implements IDisposable {
 
 	private readonly _toDispose = new DisposableStore();
@@ -123,6 +139,8 @@ export class SuggestModel implements IDisposable {
 		@IClipboardService private readonly _clipboardService: IClipboardService,
 		@ITelemetryService private readonly _telemetryService: ITelemetryService,
 		@ILogService private readonly _logService: ILogService,
+		@IContextKeyService private readonly _contextKeyService: IContextKeyService,
+		@IConfigurationService private readonly _configurationService: IConfigurationService,
 	) {
 		this._currentSelection = this._editor.getSelection() || new Selection(1, 1, 1, 1);
 
@@ -213,6 +231,10 @@ export class SuggestModel implements IDisposable {
 
 		const checkTriggerCharacter = (text?: string) => {
 
+			if (shouldPreventSuggestOnTriggerCharacters(this._contextKeyService, this._configurationService)) {
+				return;
+			}
+
 			if (!text) {
 				// came here from the compositionEnd-event
 				const position = this._editor.getPosition()!;
@@ -351,6 +373,11 @@ export class SuggestModel implements IDisposable {
 					}
 				}
 
+				if (shouldPreventQuickSuggest(this._contextKeyService, this._configurationService)) {
+					// do not trigger quick suggestions if inline suggestions are shown
+					return;
+				}
+
 				// we made it till here -> trigger now
 				this.trigger({ auto: true, shy: false });
 

src/vs/editor/contrib/suggest/test/suggestModel.test.ts

@@ -31,11 +31,12 @@ import { IEditorWorkerService } from 'vs/editor/common/services/editorWorkerServ
 import { ISuggestMemoryService } from 'vs/editor/contrib/suggest/suggestMemory';
 import { ITextModel } from 'vs/editor/common/model';
 import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
-import { MockKeybindingService } from 'vs/platform/keybinding/test/common/mockKeybindingService';
+import { MockKeybindingService, MockContextKeyService } from 'vs/platform/keybinding/test/common/mockKeybindingService';
 import { createTextModel } from 'vs/editor/test/common/editorTestUtils';
 import { IClipboardService } from 'vs/platform/clipboard/common/clipboardService';
 import { mock } from 'vs/base/test/common/mock';
 import { NullLogService } from 'vs/platform/log/common/log';
+import { TestConfigurationService } from 'vs/platform/configuration/test/common/testConfigurationService';
 
 
 function createMockEditor(model: TextModel): ITestCodeEditor {
@@ -204,7 +205,9 @@ suite('SuggestModel - TriggerAndCancelOracle', function () {
 					}
 				},
 				NullTelemetryService,
-				new NullLogService()
+				new NullLogService(),
+				new MockContextKeyService(),
+				new TestConfigurationService()
 			);
 			disposables.push(oracle, editor);