quick access - editors picker to have an action to close editors and indicate dirty state

Benjamin Pasero · Benjamin Pasero · commit a6d692e48370 · 2020-03-11T12:20:58.000+01:00
diff --git a/src/vs/platform/quickinput/common/quickAccess.ts b/src/vs/platform/quickinput/common/quickAccess.ts
@@ -177,9 +177,10 @@ export interface IPickerQuickAccessItem extends IQuickPickItem {
 	 * @param buttonIndex index of the button of the item that
 	 * was clicked.
 	 *
-	 * @returns a value that indicates what should happen after the trigger.
+	 * @returns a value that indicates what should happen after the trigger
+	 * which can be a `Promise` for long running operations.
 	 */
-	trigger?(buttonIndex: number): TriggerAction;
+	trigger?(buttonIndex: number): TriggerAction | Promise<TriggerAction>;
 }
 
 export abstract class PickerQuickAccessProvider<T extends IPickerQuickAccessItem> implements IQuickAccessProvider {
@@ -210,13 +211,18 @@ export abstract class PickerQuickAccessProvider<T extends IPickerQuickAccessItem
 			} else {
 				picker.busy = true;
 				try {
-					picker.items = await res;
+					const items = await res;
+					if (token.isCancellationRequested) {
+						return;
+					}
+
+					picker.items = items;
 				} finally {
-					picker.busy = false;
+					if (!token.isCancellationRequested) {
+						picker.busy = false;
+					}
 				}
 			}
-
-			this.getPicks(picker.value.substr(this.prefix.length).trim(), picksCts.token);
 		};
 		disposables.add(picker.onDidChangeValue(() => updatePickerItems()));
 		updatePickerItems();
@@ -231,11 +237,17 @@ export abstract class PickerQuickAccessProvider<T extends IPickerQuickAccessItem
 		}));
 
 		// Trigger the pick with button index if button triggered
-		disposables.add(picker.onDidTriggerItemButton(({ button, item }) => {
+		disposables.add(picker.onDidTriggerItemButton(async ({ button, item }) => {
 			if (typeof item.trigger === 'function') {
 				const buttonIndex = item.buttons?.indexOf(button) ?? -1;
 				if (buttonIndex >= 0) {
-					const action = item.trigger(buttonIndex);
+					const result = item.trigger(buttonIndex);
+					const action = (typeof result === 'number') ? result : await result;
+
+					if (token.isCancellationRequested) {
+						return;
+					}
+
 					switch (action) {
 						case TriggerAction.NO_ACTION:
 							break;
diff --git a/src/vs/workbench/browser/parts/editor/editorQuickAccess.ts b/src/vs/workbench/browser/parts/editor/editorQuickAccess.ts
@@ -5,7 +5,7 @@
 
 import { localize } from 'vs/nls';
 import { IQuickPickSeparator, quickPickItemScorerAccessor, IQuickPickItemWithResource } from 'vs/platform/quickinput/common/quickInput';
-import { PickerQuickAccessProvider, IPickerQuickAccessItem } from 'vs/platform/quickinput/common/quickAccess';
+import { PickerQuickAccessProvider, IPickerQuickAccessItem, TriggerAction } from 'vs/platform/quickinput/common/quickAccess';
 import { IEditorGroupsService, GroupsOrder } from 'vs/workbench/services/editor/common/editorGroupsService';
 import { EditorsOrder, IEditorIdentifier, toResource, SideBySideEditor } from 'vs/workbench/common/editor';
 import { IEditorService } from 'vs/workbench/services/editor/common/editorService';
@@ -83,19 +83,32 @@ export abstract class BaseEditorQuickAccessProvider extends PickerQuickAccessPro
 	}
 
 	private doGetEditorPickItems(): Array<IEditorQuickPickItem> {
-		return this.doGetEditors().map(({ editor, groupId }) => {
+		return this.doGetEditors().map(({ editor, groupId }): IEditorQuickPickItem => {
 			const resource = toResource(editor, { supportSideBySide: SideBySideEditor.MASTER });
+			const isDirty = editor.isDirty() && !editor.isSaving();
 
 			return {
 				editor,
 				groupId,
 				resource,
-				label: editor.isDirty() && !editor.isSaving() ? `$(circle-filled) ${editor.getName()}` : editor.getName(),
-				ariaLabel: localize('entryAriaLabel', "{0}, editor picker", editor.getName()),
+				label: editor.getName(),
+				ariaLabel: localize('entryAriaLabel', "{0}, editors picker", editor.getName()),
 				description: editor.getDescription(),
 				iconClasses: getIconClasses(this.modelService, this.modeService, resource),
 				italic: !this.editorGroupService.getGroup(groupId)?.isPinned(editor),
-				accept: () => this.editorGroupService.getGroup(groupId)?.openEditor(editor)
+				buttonsAlwaysVisible: isDirty,
+				buttons: [
+					{
+						iconClass: isDirty ? 'codicon-circle-filled' : 'codicon-close',
+						tooltip: localize('closeEditor', "Close Editor")
+					}
+				],
+				trigger: async () => {
+					await this.editorGroupService.getGroup(groupId)?.closeEditor(editor, { preserveFocus: true });
+
+					return TriggerAction.REFRESH_PICKER;
+				},
+				accept: () => this.editorGroupService.getGroup(groupId)?.openEditor(editor),
 			};
 		});
 	}
