-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
quick-command-service.ts
242 lines (206 loc) · 8.74 KB
/
quick-command-service.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
// *****************************************************************************
// Copyright (C) 2021 SAP SE or an SAP affiliate company and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0.
//
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License v. 2.0 are satisfied: GNU General Public License, version 2
// with the GNU Classpath Exception which is available at
// https://www.gnu.org/software/classpath/license.html.
//
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
// *****************************************************************************
import { inject, injectable } from 'inversify';
import { KeybindingRegistry } from '../keybinding';
import { Disposable, Command, CommandRegistry, CancellationToken, nls } from '../../common';
import { ContextKeyService } from '../context-key-service';
import { CorePreferences } from '../core-preferences';
import { QuickAccessContribution, QuickAccessProvider, QuickAccessRegistry } from './quick-access';
import { filterItems, QuickPickItem, QuickPicks } from './quick-input-service';
import { KeySequence } from '../keys';
import { codiconArray } from '../widgets';
export const quickCommand: Command = {
id: 'workbench.action.showCommands'
};
export const CLEAR_COMMAND_HISTORY = Command.toDefaultLocalizedCommand({
id: 'clear.command.history',
label: 'Clear Command History'
});
@injectable()
export class QuickCommandService implements QuickAccessContribution, QuickAccessProvider {
static PREFIX = '>';
@inject(ContextKeyService)
protected readonly contextKeyService: ContextKeyService;
@inject(CommandRegistry)
protected readonly commandRegistry: CommandRegistry;
@inject(CorePreferences)
protected readonly corePreferences: CorePreferences;
@inject(QuickAccessRegistry)
protected readonly quickAccessRegistry: QuickAccessRegistry;
@inject(KeybindingRegistry)
protected readonly keybindingRegistry: KeybindingRegistry;
// The list of exempted commands not to be displayed in the recently used list.
readonly exemptedCommands: Command[] = [
CLEAR_COMMAND_HISTORY,
];
private recentItems: QuickPickItem[] = [];
private otherItems: QuickPickItem[] = [];
registerQuickAccessProvider(): void {
this.quickAccessRegistry.registerQuickAccessProvider({
getInstance: () => this,
prefix: QuickCommandService.PREFIX,
placeholder: '',
helpEntries: [{ description: 'Quick Command', needsEditor: false }]
});
}
reset(): void {
const { recent, other } = this.getCommands();
this.recentItems = [];
this.otherItems = [];
this.recentItems.push(...recent.map(command => this.toItem(command)));
this.otherItems.push(...other.map(command => this.toItem(command)));
}
getPicks(filter: string, token: CancellationToken): QuickPicks {
const items: QuickPicks = [];
// Update the list of commands by fetching them from the registry.
this.reset();
const recentItems = filterItems(this.recentItems.slice(), filter);
const otherItems = filterItems(this.otherItems.slice(), filter);
if (recentItems.length > 0) {
items.push({ type: 'separator', label: nls.localizeByDefault('recently used') }, ...recentItems);
}
if (otherItems.length > 0) {
if (recentItems.length > 0) {
items.push({ type: 'separator', label: nls.localizeByDefault('other commands') });
}
items.push(...otherItems);
}
return items;
}
toItem(command: Command): QuickPickItem {
const label = (command.category) ? `${command.category}: ` + command.label! : command.label!;
const iconClasses = this.getItemIconClasses(command);
const activeElement = window.document.activeElement as HTMLElement;
const originalLabel = command.originalLabel || command.label!;
const originalCategory = command.originalCategory || command.category;
let detail: string | undefined = originalCategory ? `${originalCategory}: ${originalLabel}` : originalLabel;
if (label === detail) {
detail = undefined;
}
return {
label,
detail,
iconClasses,
alwaysShow: !!this.commandRegistry.getActiveHandler(command.id),
keySequence: this.getKeybinding(command),
execute: () => {
activeElement.focus({ preventScroll: true });
this.commandRegistry.executeCommand(command.id);
this.commandRegistry.addRecentCommand(command);
}
};
}
private getKeybinding(command: Command): KeySequence | undefined {
const keybindings = this.keybindingRegistry.getKeybindingsForCommand(command.id);
if (!keybindings || keybindings.length === 0) {
return undefined;
}
try {
return this.keybindingRegistry.resolveKeybinding(keybindings[0]);
} catch (error) {
return undefined;
}
}
private getItemIconClasses(command: Command): string[] | undefined {
const toggledHandler = this.commandRegistry.getToggledHandler(command.id);
if (toggledHandler) {
return codiconArray('check');
}
return undefined;
}
protected readonly contexts = new Map<string, string[]>();
pushCommandContext(commandId: string, when: string): Disposable {
const contexts = this.contexts.get(commandId) || [];
contexts.push(when);
this.contexts.set(commandId, contexts);
return Disposable.create(() => {
const index = contexts.indexOf(when);
if (index !== -1) {
contexts.splice(index, 1);
}
});
}
/**
* Get the list of valid commands.
*
* @param commands the list of raw commands.
* @returns the list of valid commands.
*/
protected getValidCommands(raw: Command[]): Command[] {
const valid: Command[] = [];
raw.forEach(command => {
if (command.label) {
const contexts = this.contexts.get(command.id);
if (!contexts || contexts.some(when => this.contextKeyService.match(when))) {
valid.push(command);
}
}
});
return valid;
}
/**
* Get the list of recently used and other commands.
*
* @returns the list of recently used commands and other commands.
*/
getCommands(): { recent: Command[], other: Command[] } {
// Get the list of recent commands.
const recentCommands = this.commandRegistry.recent;
// Get the list of all valid commands.
const allCommands = this.getValidCommands(this.commandRegistry.commands);
// Get the max history limit.
const limit = this.corePreferences['workbench.commandPalette.history'];
// Build the list of recent commands.
let rCommands: Command[] = [];
if (limit > 0) {
rCommands.push(...recentCommands.filter(r =>
!this.exemptedCommands.some(c => Command.equals(r, c)) &&
allCommands.some(c => Command.equals(r, c)))
);
if (rCommands.length > limit) {
rCommands = rCommands.slice(0, limit);
}
}
// Build the list of other commands.
const oCommands = allCommands.filter(c => !rCommands.some(r => Command.equals(r, c)));
// Normalize the list of recent commands.
const recent = this.normalize(rCommands);
// Normalize, and sort the list of other commands.
const other = this.sort(
this.normalize(oCommands)
);
return { recent, other };
}
/**
* Normalizes a list of commands.
* Normalization includes obtaining commands that have labels, are visible, and are enabled.
*
* @param commands the list of commands.
* @returns the list of normalized commands.
*/
private normalize(commands: Command[]): Command[] {
return commands.filter((a: Command) => a.label && (this.commandRegistry.isVisible(a.id) && this.commandRegistry.isEnabled(a.id)));
}
/**
* Sorts a list of commands alphabetically.
*
* @param commands the list of commands.
* @returns the list of sorted commands.
*/
private sort(commands: Command[]): Command[] {
return commands.sort((a: Command, b: Command) => Command.compareCommands(a, b));
}
}