improve discoverability of terminal suggest configuration (microsoft#252543)

fix microsoft#252321

Author: meganrogge

src/vs/editor/contrib/suggest/browser/suggestWidgetStatus.ts

@@ -30,7 +30,7 @@ export class SuggestWidgetStatus {
 		this.element = dom.append(container, dom.$('.suggest-status-bar'));
 
 		const actionViewItemProvider = <IActionViewItemProvider>(action => {
-			return action instanceof MenuItemAction ? instantiationService.createInstance(TextOnlyMenuEntryActionViewItem, action, { useComma: true }) : undefined;
+			return action instanceof MenuItemAction ? instantiationService.createInstance(TextOnlyMenuEntryActionViewItem, action, { useComma: false }) : undefined;
 		});
 		this._leftActions = new ActionBar(this.element, { actionViewItemProvider });
 		this._rightActions = new ActionBar(this.element, { actionViewItemProvider });

src/vs/workbench/contrib/terminalContrib/suggest/browser/terminal.suggest.contribution.ts

@@ -39,7 +39,7 @@ import { ITextModelService } from '../../../../../editor/common/services/resolve
 import { ILanguageFeaturesService } from '../../../../../editor/common/services/languageFeatures.js';
 import { env } from '../../../../../base/common/process.js';
 import { PYLANCE_DEBUG_DISPLAY_NAME } from './lspTerminalUtil.js';
-
+import { IOpenerService } from '../../../../../platform/opener/common/opener.js';
 
 registerSingleton(ITerminalCompletionService, TerminalCompletionService, InstantiationType.Delayed);
 
@@ -286,6 +286,40 @@ registerTerminalAction({
 	run: (c, accessor) => accessor.get(IPreferencesService).openSettings({ query: terminalSuggestConfigSection })
 });
 
+registerTerminalAction({
+	id: TerminalSuggestCommandId.LearnMore,
+	title: localize2('workbench.action.terminal.learnMore', 'Learn More'),
+	f1: false,
+	precondition: ContextKeyExpr.and(ContextKeyExpr.or(TerminalContextKeys.processSupported, TerminalContextKeys.terminalHasBeenCreated), TerminalContextKeys.focus, TerminalContextKeys.isOpen, TerminalContextKeys.suggestWidgetVisible),
+	menu: {
+		id: MenuId.MenubarTerminalSuggestStatusMenu,
+		group: 'center',
+		order: 1
+	},
+	keybinding: {
+		primary: KeyMod.CtrlCmd | KeyCode.Slash,
+		mac: { primary: KeyMod.WinCtrl | KeyCode.KeyK },
+		weight: KeybindingWeight.WorkbenchContrib + 1
+	},
+	run: (c, accessor) => {
+		(accessor.get(IOpenerService)).open('https://code.visualstudio.com/docs/terminal/shell-integration#_intellisense');
+	}
+});
+
+registerActiveInstanceAction({
+	id: TerminalSuggestCommandId.ResetDiscoverability,
+	title: localize2('workbench.action.terminal.resetDiscoverability', 'Reset Suggest Discoverability'),
+	f1: true,
+	precondition: ContextKeyExpr.and(
+		ContextKeyExpr.or(TerminalContextKeys.processSupported, TerminalContextKeys.terminalHasBeenCreated),
+		TerminalContextKeys.isOpen,
+		ContextKeyExpr.equals(`config.${TerminalSuggestSettingId.Enabled}`, true)
+	),
+	run: (activeInstance) => {
+		TerminalSuggestContribution.get(activeInstance)?.addon?.resetDiscoverability();
+	}
+});
+
 registerActiveInstanceAction({
 	id: TerminalSuggestCommandId.RequestCompletions,
 	title: localize2('workbench.action.terminal.requestCompletions', 'Request Completions'),

src/vs/workbench/contrib/terminalContrib/suggest/browser/terminalSuggestAddon.ts

@@ -35,6 +35,7 @@ import { IntervalTimer, TimeoutTimer } from '../../../../../base/common/async.js
 import { localize } from '../../../../../nls.js';
 import { TerminalSuggestTelemetry } from './terminalSuggestTelemetry.js';
 import { terminalSymbolAliasIcon, terminalSymbolArgumentIcon, terminalSymbolEnumMember, terminalSymbolFileIcon, terminalSymbolFlagIcon, terminalSymbolInlineSuggestionIcon, terminalSymbolMethodIcon, terminalSymbolOptionIcon, terminalSymbolFolderIcon, terminalSymbolSymbolicLinkFileIcon, terminalSymbolSymbolicLinkFolderIcon } from './terminalSymbolIcons.js';
+import { TerminalSuggestShownTracker } from './terminalSuggestShownTracker.js';
 
 export interface ISuggestController {
 	isPasting: boolean;
@@ -46,9 +47,6 @@ export interface ISuggestController {
 	hideSuggestWidget(cancelAnyRequests: boolean, wasClosedByUser?: boolean): void;
 }
 
-
-let firstShownTracker: { shell: Set<TerminalShellType>; window: boolean } | undefined = undefined;
-
 export function isInlineCompletionSupported(shellType: TerminalShellType | undefined): boolean {
 	if (!shellType) {
 		return false;
@@ -89,6 +87,8 @@ export class SuggestAddon extends Disposable implements ITerminalAddon, ISuggest
 
 	private _cancellationTokenSource: CancellationTokenSource | undefined;
 
+	private _discoverability: TerminalSuggestShownTracker | undefined;
+
 	isPasting: boolean = false;
 	shellType: TerminalShellType | undefined;
 	private readonly _shellTypeInit: Promise<void>;
@@ -161,7 +161,7 @@ export class SuggestAddon extends Disposable implements ITerminalAddon, ISuggest
 		@IConfigurationService private readonly _configurationService: IConfigurationService,
 		@IInstantiationService private readonly _instantiationService: IInstantiationService,
 		@IExtensionService private readonly _extensionService: IExtensionService,
-		@ITerminalConfigurationService private readonly _terminalConfigurationService: ITerminalConfigurationService,
+		@ITerminalConfigurationService private readonly _terminalConfigurationService: ITerminalConfigurationService
 	) {
 		super();
 
@@ -231,7 +231,6 @@ export class SuggestAddon extends Disposable implements ITerminalAddon, ISuggest
 				this._model?.forceRefilterAll();
 			}
 		}));
-		this._register(this._extensionService.onWillStop(() => firstShownTracker = undefined));
 	}
 
 	activate(xterm: Terminal): void {
@@ -719,9 +718,9 @@ export class SuggestAddon extends Disposable implements ITerminalAddon, ISuggest
 		// Track the time when completions are shown for the first time
 		if (this._completionRequestTimestamp !== undefined) {
 			const completionLatency = Date.now() - this._completionRequestTimestamp;
-			if (this._suggestTelemetry && this.shellType) {
-				const firstShown = this.getFirstShown(this.shellType);
-				this.updateShown();
+			if (this._suggestTelemetry && this.shellType && this._discoverability) {
+				const firstShown = this._discoverability.getFirstShown(this.shellType);
+				this._discoverability.updateShown();
 				this._suggestTelemetry.logCompletionLatency(this._sessionId, completionLatency, firstShown);
 			}
 			this._completionRequestTimestamp = undefined;
@@ -764,6 +763,7 @@ export class SuggestAddon extends Disposable implements ITerminalAddon, ISuggest
 				}));
 			}
 
+			this._register(this._suggestWidget.onDidShow(() => this._updateDiscoverabilityState()));
 			this._register(this._suggestWidget.onDidBlurDetails((e) => {
 				const elt = e.relatedTarget as HTMLElement;
 				if (this._terminal?.element?.contains(elt)) {
@@ -779,6 +779,21 @@ export class SuggestAddon extends Disposable implements ITerminalAddon, ISuggest
 		return this._suggestWidget;
 	}
 
+	private _updateDiscoverabilityState(): void {
+		if (!this._discoverability) {
+			this._discoverability = this._register(this._instantiationService.createInstance(TerminalSuggestShownTracker, this.shellType));
+		}
+
+		if (!this._suggestWidget || this._discoverability?.done) {
+			return;
+		}
+		this._discoverability?.update(this._suggestWidget.element.domNode);
+	}
+
+	resetDiscoverability(): void {
+		this._discoverability?.resetState();
+	}
+
 	selectPreviousSuggestion(): void {
 		this._suggestWidget?.selectPrevious();
 	}
@@ -901,36 +916,6 @@ export class SuggestAddon extends Disposable implements ITerminalAddon, ISuggest
 		this._suggestWidget?.hide();
 	}
 
-	getFirstShown(shellType: TerminalShellType): { window: boolean; shell: boolean } {
-		if (!firstShownTracker) {
-			firstShownTracker = {
-				window: true,
-				shell: new Set([shellType])
-			};
-			return { window: true, shell: true };
-		}
-
-		const isFirstForWindow = firstShownTracker.window;
-		const isFirstForShell = !firstShownTracker.shell.has(shellType);
-
-		if (isFirstForWindow || isFirstForShell) {
-			this.updateShown();
-		}
-
-		return {
-			window: isFirstForWindow,
-			shell: isFirstForShell
-		};
-	}
-
-	updateShown(): void {
-		if (!this.shellType || !firstShownTracker) {
-			return;
-		}
-
-		firstShownTracker.window = false;
-		firstShownTracker.shell.add(this.shellType);
-	}
 }
 
 class PersistedWidgetSize {

src/vs/workbench/contrib/terminalContrib/suggest/browser/terminalSuggestShownTracker.ts

@@ -0,0 +1,116 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { Disposable, IDisposable } from '../../../../../base/common/lifecycle.js';
+import { IStorageService, StorageScope, StorageTarget } from '../../../../../platform/storage/common/storage.js';
+import { TerminalShellType } from '../../../../../platform/terminal/common/terminal.js';
+import { IExtensionService } from '../../../../services/extensions/common/extensions.js';
+
+
+export const TERMINAL_SUGGEST_DISCOVERABILITY_KEY = 'terminal.suggest.increasedDiscoverability';
+export const TERMINAL_SUGGEST_DISCOVERABILITY_COUNT_KEY = 'terminal.suggest.increasedDiscoverabilityCount';
+const TERMINAL_SUGGEST_DISCOVERABILITY_MAX_COUNT = 10;
+const TERMINAL_SUGGEST_DISCOVERABILITY_MIN_MS = 10000;
+
+interface ITerminalSuggestShownTracker extends IDisposable {
+	getFirstShown(shellType: TerminalShellType): { window: boolean; shell: boolean };
+	updateShown(): void;
+	resetState(): void;
+}
+
+export class TerminalSuggestShownTracker extends Disposable implements ITerminalSuggestShownTracker {
+	private _done: boolean;
+	private _count: number;
+	private _timeout: Timeout | undefined;
+	private _start: number | undefined;
+
+	private _firstShownTracker: { shell: Set<TerminalShellType>; window: boolean } | undefined = undefined;
+
+	constructor(
+		private readonly _shellType: TerminalShellType | undefined,
+		@IStorageService private readonly _storageService: IStorageService,
+		@IExtensionService private readonly _extensionService: IExtensionService
+
+	) {
+		super();
+		this._done = this._storageService.getBoolean(TERMINAL_SUGGEST_DISCOVERABILITY_KEY, StorageScope.APPLICATION, false);
+		this._count = this._storageService.getNumber(TERMINAL_SUGGEST_DISCOVERABILITY_COUNT_KEY, StorageScope.APPLICATION, 0);
+		this._register(this._extensionService.onWillStop(() => this._firstShownTracker = undefined));
+	}
+
+	get done(): boolean {
+		return this._done;
+	}
+
+	resetState(): void {
+		this._done = false;
+		this._count = 0;
+		this._start = undefined;
+		this._firstShownTracker = undefined;
+	}
+
+	update(widgetElt: HTMLElement | undefined): void {
+		if (this._done) {
+			return;
+		}
+		this._count++;
+		this._storageService.store(TERMINAL_SUGGEST_DISCOVERABILITY_COUNT_KEY, this._count, StorageScope.APPLICATION, StorageTarget.USER);
+		if (widgetElt && !widgetElt.classList.contains('increased-discoverability')) {
+			widgetElt.classList.add('increased-discoverability');
+		}
+		if (this._count >= TERMINAL_SUGGEST_DISCOVERABILITY_MAX_COUNT) {
+			this._setDone(widgetElt);
+		} else if (!this._start) {
+			this._start = Date.now();
+			this._timeout = setTimeout(() => {
+				this._setDone(widgetElt);
+			}, TERMINAL_SUGGEST_DISCOVERABILITY_MIN_MS);
+		}
+	}
+
+	private _setDone(widgetElt: HTMLElement | undefined) {
+		this._done = true;
+		this._storageService.store(TERMINAL_SUGGEST_DISCOVERABILITY_KEY, true, StorageScope.APPLICATION, StorageTarget.USER);
+		if (widgetElt) {
+			widgetElt.classList.remove('increased-discoverability');
+		}
+		if (this._timeout) {
+			clearTimeout(this._timeout);
+			this._timeout = undefined;
+		}
+		this._start = undefined;
+	}
+
+	getFirstShown(shellType: TerminalShellType): { window: boolean; shell: boolean } {
+		if (!this._firstShownTracker) {
+			this._firstShownTracker = {
+				window: true,
+				shell: new Set([shellType])
+			};
+			return { window: true, shell: true };
+		}
+
+		const isFirstForWindow = this._firstShownTracker.window;
+		const isFirstForShell = !this._firstShownTracker.shell.has(shellType);
+
+		if (isFirstForWindow || isFirstForShell) {
+			this.updateShown();
+		}
+
+		return {
+			window: isFirstForWindow,
+			shell: isFirstForShell
+		};
+	}
+
+	updateShown(): void {
+		if (!this._shellType || !this._firstShownTracker) {
+			return;
+		}
+
+		this._firstShownTracker.window = false;
+		this._firstShownTracker.shell.add(this._shellType);
+	}
+}

src/vs/workbench/contrib/terminalContrib/suggest/common/terminal.suggest.ts

@@ -17,6 +17,8 @@ export const enum TerminalSuggestCommandId {
 	ToggleDetails = 'workbench.action.terminal.suggestToggleDetails',
 	ToggleDetailsFocus = 'workbench.action.terminal.suggestToggleDetailsFocus',
 	ConfigureSettings = 'workbench.action.terminal.configureSuggestSettings',
+	LearnMore = 'workbench.action.terminal.suggestLearnMore',
+	ResetDiscoverability = 'workbench.action.terminal.resetDiscoverability'
 }
 
 export const defaultTerminalSuggestCommandsToSkipShell = [

src/vs/workbench/services/suggest/browser/media/suggest.css

@@ -87,11 +87,12 @@
 	margin-right: 0;
 }
 
-.monaco-workbench .workbench-suggest-widget.with-status-bar .suggest-status-bar .action-item:not(:last-of-type) .action-label::after {
-	content: ', ';
-	margin-right: 0.3em;
+.monaco-workbench .workbench-suggest-widget.increased-discoverability.with-status-bar .suggest-status-bar .monaco-action-bar.right .actions-container .action-item:first-child .action-label {
+	color: var(--vscode-button-foreground);
+	background-color: var(--vscode-button-background);
 }
 
+
 .monaco-workbench .workbench-suggest-widget.with-status-bar .monaco-list .monaco-list-row > .contents > .main > .right > .readMore,
 .monaco-workbench .workbench-suggest-widget.with-status-bar .monaco-list .monaco-list-row.focused.string-label > .contents > .main > .right > .readMore {
 	display: none;