Merge pull request #182351 from microsoft/merogge/interactive-editor-help

meganrogge · web-flow · commit 2946b1ee55db · 2023-05-17T19:02:22.000-07:00
add interactive editor session help menu
diff --git a/src/vs/workbench/contrib/accessibility/browser/accessibilityContribution.ts b/src/vs/workbench/contrib/accessibility/browser/accessibilityContribution.ts
@@ -7,25 +7,38 @@ import { localize } from 'vs/nls';
 import { Extensions, IConfigurationNode, IConfigurationRegistry } from 'vs/platform/configuration/common/configurationRegistry';
 import { Registry } from 'vs/platform/registry/common/platform';
 
+export const enum AccessibilityVerbositySettingId {
+	Terminal = 'accessibility.verbosity.terminal',
+	DiffEditor = 'accessibility.verbosity.diff-editor',
+	Chat = 'accessibility.verbosity.chat',
+	InteractiveEditor = 'accessibility.verbosity.interactiveEditor'
+}
+
 const configuration: IConfigurationNode = {
 	id: 'accessibility',
 	title: localize('accessibilityConfigurationTitle', "Accessibility"),
 	type: 'object',
 	properties: {
-		'accessibility.verbosity.terminal': {
+		[AccessibilityVerbositySettingId.Terminal]: {
 			description: localize('verbosity.terminal.description', 'Provide information about how to access the terminal accessibility help menu when the terminal is focused'),
 			type: 'boolean',
 			default: true,
 			tags: ['accessibility']
 		},
-		'accessibility.verbosity.diff-editor': {
+		[AccessibilityVerbositySettingId.DiffEditor]: {
 			description: localize('verbosity.diff-editor.description', 'Provide information about how to navigate changes in the diff editor when it is focused'),
 			type: 'boolean',
 			default: true,
 			tags: ['accessibility']
 		},
-		'accessibility.verbosity.chatInput': {
-			description: localize('verbosity.chatInput.description', 'Provide information about how to access the interactive session accessibility help menu when the interactive input is focused'),
+		[AccessibilityVerbositySettingId.Chat]: {
+			description: localize('verbosity.chat.description', 'Provide information about how to access the chat help menu when the chat input is focused'),
+			type: 'boolean',
+			default: true,
+			tags: ['accessibility']
+		},
+		[AccessibilityVerbositySettingId.InteractiveEditor]: {
+			description: localize('verbosity.interactiveEditor.description', 'Provide information about how to access the interactive editor accessibility help menu when the interactive editor input is focused'),
 			type: 'boolean',
 			default: true,
 			tags: ['accessibility']
diff --git a/src/vs/workbench/contrib/chat/browser/actions/chatAccessibilityHelp.ts b/src/vs/workbench/contrib/chat/browser/actions/chatAccessibilityHelp.ts
@@ -6,12 +6,44 @@
 import { localize } from 'vs/nls';
 import { format } from 'vs/base/common/strings';
 import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
+import { addStandardDisposableListener } from 'vs/base/browser/dom';
+import { withNullAsUndefined } from 'vs/base/common/types';
+import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
+import { ServicesAccessor } from 'vs/editor/browser/editorExtensions';
+import { KeyCode } from 'vs/base/common/keyCodes';
+import { IChatWidgetService } from 'vs/workbench/contrib/chat/browser/chat';
+import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
+import { EditMode } from 'vs/workbench/contrib/interactiveEditor/common/interactiveEditor';
 
-export function getAccessibilityHelpText(keybindingService: IKeybindingService): string {
+export function getAccessibilityHelpText(accessor: ServicesAccessor, type: 'chat' | 'editor', currentInput?: string): string {
+	const keybindingService = accessor.get(IKeybindingService);
+	const configurationService = accessor.get(IConfigurationService);
 	const content = [];
-	content.push(localize('interactiveSession.helpMenuExit', "Exit this menu and return to the interactive editor input via the Escape key."));
-	content.push(descriptionForCommand('chat.action.focus', localize('workbench.action.chat.focus', 'The Focus Chat command ({0}) focuses the chat request/response list, which can be navigated with UpArrow/DownArrow.',), localize('workbench.action.chat.focusNoKb', 'The Focus Interactive Session command focuses the chat request/response list, which can be navigated with UpArrow/DownArrow and is currently not triggerable by a keybinding.'), keybindingService));
-	content.push(descriptionForCommand('workbench.action.chat.focusInput', localize('workbench.action.chat.focusInput', 'The Focus Chat Input command ({0}) focuses the input box for chat requests.'), localize('workbench.action.interactiveSession.focusInputNoKb', 'Focus Interactive Session Input command focuses the input box for chat requests and is currently not triggerable by a keybinding.'), keybindingService));
+	content.push(localize('interactiveSession.helpMenuExit', "Exit this menu and return to the input via the Escape key."));
+	if (type === 'chat') {
+		content.push(descriptionForCommand('chat.action.focus', localize('workbench.action.chat.focus', 'The Focus Chat command ({0}) focuses the chat request/response list, which can be navigated with UpArrow/DownArrow.',), localize('workbench.action.chat.focusNoKb', 'The Focus Interactive Session command focuses the chat request/response list, which can be navigated with UpArrow/DownArrow and is currently not triggerable by a keybinding.'), keybindingService));
+		content.push(descriptionForCommand('workbench.action.chat.focusInput', localize('workbench.action.chat.focusInput', 'The Focus Chat Input command ({0}) focuses the input box for chat requests.'), localize('workbench.action.interactiveSession.focusInputNoKb', 'Focus Interactive Session Input command focuses the input box for chat requests and is currently not triggerable by a keybinding.'), keybindingService));
+	} else {
+		content.push(localize('interactiveSession.makeRequest', "Tab once to reach the make request button, which will re-run the request."));
+		const regex = /^(\/fix|\/explain)/;
+		const match = currentInput?.match(regex);
+		const command = match && match.length ? match[0].substring(1) : undefined;
+		if (command === 'fix') {
+			const editMode = configurationService.getValue('interactiveEditor.editMode');
+			if (editMode === EditMode.Preview) {
+				const keybinding = keybindingService.lookupKeybinding('editor.action.diffReview.next')?.getAriaLabel();
+				content.push(keybinding ? localize('interactiveSession.diff', "Tab again to enter the Diff editor with the changes and enter review mode with ({0}). Use Up/DownArrow to navigate lines with the proposed changes.", keybinding) : localize('interactiveSession.diffNoKb', "Tab again to enter the Diff editor with the changes and enter review mode with the Go to Next Difference Command. Use Up/DownArrow to navigate lines with the proposed changes."));
+				content.push(localize('interactiveSession.acceptReject', "Tab again to reach the action bar, which can be navigated with Left/RightArrow."));
+			}
+		} else if (command === 'explain') {
+			content.push(localize('interactiveSession.explain', "/explain commands will be run in the chat view."));
+			content.push(localize('interactiveSession.chatViewFocus', "To focus the chat view, run the GitHub Copilot: Focus on GitHub Copilot View command, which will focus the input box."));
+		} else {
+			content.push(localize('interactiveSession.toolbar', "Tab again to reach the action bar, if any, which can be navigated with Left/RightArrow."));
+			content.push(localize('interactiveSession.toolbarButtons', "Tab again to focus the response."));
+		}
+	}
+	content.push(localize('interactiveSession.exit', "Use Escape outside of this help menu to exit the session."));
 	return content.join('\n');
 }
 
@@ -22,3 +54,40 @@ function descriptionForCommand(commandId: string, msg: string, noKbMsg: string,
 	}
 	return format(noKbMsg, commandId);
 }
+
+export async function runAccessibilityHelpAction(accessor: ServicesAccessor, editor: ICodeEditor, type: 'chat' | 'editor'): Promise<void> {
+	const widgetService = accessor.get(IChatWidgetService);
+	const inputEditor: ICodeEditor | undefined = type === 'chat' ? widgetService.lastFocusedWidget?.inputEditor : editor;
+	const editorUri = editor.getModel()?.uri;
+
+	if (!inputEditor || !editorUri) {
+		return;
+	}
+	const domNode = withNullAsUndefined(inputEditor.getDomNode());
+	if (!domNode) {
+		return;
+	}
+
+	const cachedInput = inputEditor.getValue();
+	const cachedPosition = inputEditor.getPosition();
+	inputEditor.getSupportedActions();
+	const helpText = getAccessibilityHelpText(accessor, type, type === 'editor' ? cachedInput : undefined);
+	inputEditor.setValue(helpText);
+	inputEditor.updateOptions({ readOnly: true });
+	inputEditor.focus();
+	const disposable = addStandardDisposableListener(domNode, 'keydown', e => {
+		if (!inputEditor) {
+			return;
+		}
+		if (e.keyCode === KeyCode.Escape && inputEditor.getValue() === helpText) {
+			inputEditor.updateOptions({ readOnly: false });
+			inputEditor.setValue(cachedInput);
+			if (cachedPosition) {
+				inputEditor.setPosition(cachedPosition);
+			}
+			inputEditor.focus();
+			disposable.dispose();
+			e.stopPropagation();
+		}
+	});
+}
diff --git a/src/vs/workbench/contrib/chat/browser/actions/chatActions.ts b/src/vs/workbench/contrib/chat/browser/actions/chatActions.ts
@@ -3,22 +3,19 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { addStandardDisposableListener } from 'vs/base/browser/dom';
 import { Codicon } from 'vs/base/common/codicons';
 import { KeyCode, KeyMod } from 'vs/base/common/keyCodes';
-import { withNullAsUndefined } from 'vs/base/common/types';
 import { ICodeEditor } from 'vs/editor/browser/editorBrowser';
 import { EditorAction, ServicesAccessor, registerEditorAction } from 'vs/editor/browser/editorExtensions';
 import { EditorContextKeys } from 'vs/editor/common/editorContextKeys';
 import { localize } from 'vs/nls';
 import { Action2, IAction2Options, MenuId, registerAction2 } from 'vs/platform/actions/common/actions';
 import { ContextKeyExpr } from 'vs/platform/contextkey/common/contextkey';
-import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
 import { KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry';
 import { IQuickInputService, IQuickPickItem } from 'vs/platform/quickinput/common/quickInput';
 import { ViewAction } from 'vs/workbench/browser/parts/views/viewPane';
 import { ActiveEditorContext } from 'vs/workbench/common/contextkeys';
-import { getAccessibilityHelpText } from 'vs/workbench/contrib/chat/browser/actions/chatAccessibilityHelp';
+import { runAccessibilityHelpAction } from 'vs/workbench/contrib/chat/browser/actions/chatAccessibilityHelp';
 import { clearChatEditor, clearChatSession } from 'vs/workbench/contrib/chat/browser/actions/chatClear';
 import { IChatWidgetService } from 'vs/workbench/contrib/chat/browser/chat';
 import { IChatEditorOptions } from 'vs/workbench/contrib/chat/browser/chatEditor';
@@ -141,42 +138,8 @@ export function registerChatActions() {
 				}
 			});
 		}
-
 		async run(accessor: ServicesAccessor, editor: ICodeEditor): Promise<void> {
-			const widgetService = accessor.get(IChatWidgetService);
-			const keybindingService = accessor.get(IKeybindingService);
-			const inputEditor = widgetService.lastFocusedWidget?.inputEditor;
-			const editorUri = editor.getModel()?.uri;
-
-			if (!inputEditor || !editorUri) {
-				return;
-			}
-
-			const widget = widgetService.getWidgetByInputUri(editorUri);
-			const domNode = withNullAsUndefined(inputEditor.getDomNode());
-
-			if (!domNode || !widget) {
-				return;
-			}
-
-			const cachedInput = inputEditor.getValue();
-			const cachedPosition = inputEditor.getPosition();
-
-			const helpText = getAccessibilityHelpText(keybindingService);
-			inputEditor.setValue(helpText);
-			inputEditor.updateOptions({ readOnly: true });
-			inputEditor.focus();
-			const disposable = addStandardDisposableListener(domNode, 'keydown', e => {
-				if (e.keyCode === KeyCode.Escape && inputEditor.getValue() === helpText) {
-					inputEditor.updateOptions({ readOnly: false });
-					inputEditor.setValue(cachedInput);
-					if (cachedPosition) {
-						inputEditor.setPosition(cachedPosition);
-					}
-					widget.focusInput();
-					disposable.dispose();
-				}
-			});
+			runAccessibilityHelpAction(accessor, editor, 'chat');
 		}
 	});
 
diff --git a/src/vs/workbench/contrib/chat/browser/chatInputPart.ts b/src/vs/workbench/contrib/chat/browser/chatInputPart.ts
@@ -30,6 +30,7 @@ import { ChatFollowups } from 'vs/workbench/contrib/chat/browser/chatFollowups';
 import { CONTEXT_INTERACTIVE_INPUT_HAS_TEXT, CONTEXT_IN_INTERACTIVE_INPUT } from 'vs/workbench/contrib/chat/common/chatContextKeys';
 import { IChatReplyFollowup } from 'vs/workbench/contrib/chat/common/chatService';
 import { IChatWidgetHistoryService } from 'vs/workbench/contrib/chat/common/chatWidgetHistoryService';
+import { AccessibilityVerbositySettingId } from 'vs/workbench/contrib/accessibility/browser/accessibilityContribution';
 
 const $ = dom.$;
 
@@ -85,19 +86,19 @@ export class ChatInputPart extends Disposable implements IHistoryNavigationWidge
 		this.history = new HistoryNavigator([], 5);
 		this._register(this.historyService.onDidClearHistory(() => this.history.clear()));
 		this._register(this.configurationService.onDidChangeConfiguration(e => {
-			if (e.affectsConfiguration('accessibility.verbosity.chatInput')) {
+			if (e.affectsConfiguration(AccessibilityVerbositySettingId.Chat)) {
 				this.inputEditor.updateOptions({ ariaLabel: this._getAriaLabel() });
 			}
 		}));
 	}
 
 	private _getAriaLabel(): string {
-		const verbose = this.configurationService.getValue<boolean>('accessibility.verbosity.chatInput');
+		const verbose = this.configurationService.getValue<boolean>(AccessibilityVerbositySettingId.Chat);
 		if (verbose) {
 			const kbLabel = this.keybindingService.lookupKeybinding('chat.action.accessibilityHelp')?.getLabel();
-			return kbLabel ? localize('actions.chat.accessibiltyHelp', "Chat Input,  Type code here and press enter to run. Use {0} for Chat Accessibility Help.", kbLabel) : localize('interactiveSessionInput.accessibilityHelpNoKb', "Chat Input,  Type code here and press Enter to run. Use the Chat Accessibility Help command for more information.");
+			return kbLabel ? localize('actions.chat.accessibiltyHelp', "Chat Input,  Type code here and press enter to run. Use {0} for Chat Accessibility Help.", kbLabel) : localize('chatInput.accessibilityHelpNoKb', "Chat Input,  Type code here and press Enter to run. Use the Chat Accessibility Help command for more information.");
 		}
-		return localize('interactiveSessionInput', "Chat Input");
+		return localize('chatInput', "Chat Input");
 	}
 
 	setState(providerId: string, inputValue: string): void {
diff --git a/src/vs/workbench/contrib/interactiveEditor/browser/interactiveEditor.contribution.ts b/src/vs/workbench/contrib/interactiveEditor/browser/interactiveEditor.contribution.ts
@@ -33,6 +33,7 @@ registerAction2(interactiveEditorActions.NextFromHistory);
 registerAction2(interactiveEditorActions.ViewInChatAction);
 registerAction2(interactiveEditorActions.ExpandMessageAction);
 registerAction2(interactiveEditorActions.ContractMessageAction);
+registerAction2(interactiveEditorActions.AccessibilityHelpEditorAction);
 
 registerAction2(interactiveEditorActions.ToggleInlineDiff);
 registerAction2(interactiveEditorActions.FeebackHelpfulCommand);
diff --git a/src/vs/workbench/contrib/interactiveEditor/browser/interactiveEditorActions.ts b/src/vs/workbench/contrib/interactiveEditor/browser/interactiveEditorActions.ts
@@ -24,6 +24,7 @@ import { ICodeEditorService } from 'vs/editor/browser/services/codeEditorService
 import { Range } from 'vs/editor/common/core/range';
 import { fromNow } from 'vs/base/common/date';
 import { IInteractiveEditorSessionService, Recording } from 'vs/workbench/contrib/interactiveEditor/browser/interactiveEditorSession';
+import { runAccessibilityHelpAction } from 'vs/workbench/contrib/chat/browser/actions/chatAccessibilityHelp';
 
 
 export class StartSessionAction extends EditorAction2 {
@@ -547,3 +548,21 @@ export class ContractMessageAction extends AbstractInteractiveEditorAction {
 		ctrl.updateExpansionState(false);
 	}
 }
+
+export class AccessibilityHelpEditorAction extends EditorAction2 {
+	constructor() {
+		super({
+			id: 'interactiveEditor.accessibilityHelp',
+			title: localize('actions.interactiveSession.accessibiltyHelpEditor', "Interactive Session Editor Accessibility Help"),
+			category: AbstractInteractiveEditorAction.category,
+			keybinding: {
+				when: CTX_INTERACTIVE_EDITOR_FOCUSED,
+				primary: KeyMod.Alt | KeyCode.F1,
+				weight: KeybindingWeight.EditorContrib
+			}
+		});
+	}
+	async runEditorCommand(accessor: ServicesAccessor, editor: ICodeEditor): Promise<void> {
+		runAccessibilityHelpAction(accessor, editor, 'editor');
+	}
+}
diff --git a/src/vs/workbench/contrib/interactiveEditor/browser/interactiveEditorWidget.ts b/src/vs/workbench/contrib/interactiveEditor/browser/interactiveEditorWidget.ts
@@ -43,7 +43,13 @@ import { LineRangeMapping } from 'vs/editor/common/diff/linesDiffComputer';
 import { invertLineRange, lineRangeAsRange } from 'vs/workbench/contrib/interactiveEditor/browser/utils';
 import { ICodeEditorViewState, ScrollType } from 'vs/editor/common/editorCommon';
 import { LineRange } from 'vs/editor/common/core/lineRange';
+import { IAccessibilityService } from 'vs/platform/accessibility/common/accessibility';
 import { SubmenuItemAction } from 'vs/platform/actions/common/actions';
+import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
+import { IKeybindingService } from 'vs/platform/keybinding/common/keybinding';
+import { AccessibilityVerbositySettingId } from 'vs/workbench/contrib/accessibility/browser/accessibilityContribution';
+
+const defaultAriaLabel = localize('aria-label', "Interactive Editor Input");
 
 const _inputEditorOptions: IEditorConstructionOptions = {
 	padding: { top: 3, bottom: 2 },
@@ -84,7 +90,7 @@ const _inputEditorOptions: IEditorConstructionOptions = {
 		showStatusBar: false,
 	},
 	wordWrap: 'on',
-	ariaLabel: localize('aria-label', "Interactive Editor Input"),
+	ariaLabel: defaultAriaLabel,
 	fontFamily: DEFAULT_FONT_FAMILY,
 	fontSize: 13,
 	lineHeight: 20,
@@ -172,7 +178,10 @@ export class InteractiveEditorWidget {
 		@ILanguageService private readonly _languageService: ILanguageService,
 		@IContextKeyService private readonly _contextKeyService: IContextKeyService,
 		@ILanguageFeaturesService private readonly _languageFeaturesService: ILanguageFeaturesService,
+		@IKeybindingService private readonly _keybindingService: IKeybindingService,
 		@IInstantiationService private readonly _instantiationService: IInstantiationService,
+		@IAccessibilityService private readonly _accessibilityService: IAccessibilityService,
+		@IConfigurationService private readonly _configurationService: IConfigurationService
 	) {
 
 		// input editor logic
@@ -185,10 +194,16 @@ export class InteractiveEditorWidget {
 		};
 
 		this._inputEditor = <IActiveCodeEditor>this._instantiationService.createInstance(EmbeddedCodeEditorWidget, this._elements.editor, _inputEditorOptions, codeEditorWidgetOptions, parentEditor);
+		this._updateAriaLabel();
 		this._store.add(this._inputEditor);
 		this._store.add(this._inputEditor.onDidChangeModelContent(() => this._onDidChangeInput.fire(this)));
 		this._store.add(this._inputEditor.onDidLayoutChange(() => this._onDidChangeHeight.fire()));
 		this._store.add(this._inputEditor.onDidContentSizeChange(() => this._onDidChangeHeight.fire()));
+		this._store.add(this._configurationService.onDidChangeConfiguration(e => {
+			if (e.affectsConfiguration(AccessibilityVerbositySettingId.InteractiveEditor)) {
+				this._updateAriaLabel();
+			}
+		}));
 
 		const uri = URI.from({ scheme: 'vscode', authority: 'interactive-editor', path: `/interactive-editor/model${InteractiveEditorWidget._modelPool++}.txt` });
 		this._inputModel = this._modelService.getModel(uri) ?? this._modelService.createModel('', null, uri);
@@ -289,6 +304,19 @@ export class InteractiveEditorWidget {
 		this._store.add(markdownMessageToolbar);
 	}
 
+	private _updateAriaLabel(): void {
+		if (!this._accessibilityService.isScreenReaderOptimized()) {
+			return;
+		}
+		let label = defaultAriaLabel;
+		if (this._configurationService.getValue<boolean>(AccessibilityVerbositySettingId.InteractiveEditor)) {
+			const kbLabel = this._keybindingService.lookupKeybinding('interactiveEditor.accessibilityHelp')?.getLabel();
+			label = kbLabel ? localize('interactiveEditor.accessibilityHelp', "Interactive Editor Input, Use {0} for Interactive Editor Accessibility Help.", kbLabel) : localize('interactiveSessionInput.accessibilityHelpNoKb', "Interactive Editor Input, Run the Interactive Editor Accessibility Help command for more information.");
+		}
+		_inputEditorOptions.ariaLabel = label;
+		this._inputEditor.updateOptions({ ariaLabel: label });
+	}
+
 	dispose(): void {
 		this._store.dispose();
 		this._ctxInputEmpty.reset();
diff --git a/src/vs/workbench/contrib/notebook/browser/diff/diffComponents.ts b/src/vs/workbench/contrib/notebook/browser/diff/diffComponents.ts
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalInstance.ts b/src/vs/workbench/contrib/terminal/browser/terminalInstance.ts
