-
Notifications
You must be signed in to change notification settings - Fork 28.8k
/
quickInputExploration.ts
604 lines (525 loc) · 16.2 KB
/
quickInputExploration.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { QuickInputToolbarItem3, ExtensionContext, commands, QuickPickItem, window, QuickInputSession9, QuickInput3, Disposable, CancellationToken, QuickInput7, QuickInput6 } from 'vscode';
export function activate(context: ExtensionContext) {
context.subscriptions.push(commands.registerCommand('foobar', async () => {
const inputs1 = await collectInputs1();
const inputs2 = await collectInputs2();
const inputs3 = await collectInputs3();
const inputs4 = await collectInputs4();
const inputs5 = await collectInputs5();
const inputs6 = await collectInputs6();
const inputs7 = await collectInputs7();
const inputs8 = await collectInputs8();
const inputs9 = await collectInputs9();
const inputs10 = await collectInputs10();
}));
}
const resourceGroups: QuickPickItem[] = ['vscode-data-function', 'vscode-website-microservices', 'vscode-website-monitor', 'vscode-website-preview', 'vscode-website-prod']
.map(label => ({ label }));
// #region Take 1 --------------------------------------------------------------------------------
async function collectInputs1() {
return window.multiStepInput(async (input, token) => {
const resourceGroup = await input.showQuickPick(resourceGroups, { placeHolder: 'Pick a resource group' });
if (!resourceGroup || token.isCancellationRequested) {
return undefined;
}
const name = await input.showInputBox({
prompt: 'Choose a unique name',
validateInput: value => validateNameIsUnique(value)
});
if (!name || token.isCancellationRequested) {
return undefined;
}
const runtimes = await getAvailableRuntimes(resourceGroup, token);
const runtime = await input.showQuickPick(runtimes, { placeHolder: 'Pick a runtime' });
return { resourceGroup, name, runtime };
});
}
// #endregion
// #region Take 2 --------------------------------------------------------------------------------
async function collectInputs2() {
const input = window.createQuickInput2();
try {
const resourceGroup = await input.showQuickPick(resourceGroups, { placeHolder: 'Pick a resource group' });
if (!resourceGroup || input.token.isCancellationRequested) {
return undefined;
}
const name = await input.showInputBox({
prompt: 'Choose a unique name',
validateInput: value => validateNameIsUnique(value)
});
if (!name || input.token.isCancellationRequested) {
return undefined;
}
const runtimes = await getAvailableRuntimes(resourceGroup, input.token);
const runtime = await input.showQuickPick(runtimes, { placeHolder: 'Pick a runtime' });
return { resourceGroup, name, runtime };
} finally {
input.dispose();
}
}
// #endregion
// #region Take 3 --------------------------------------------------------------------------------
async function collectInputs3() {
const input = window.createQuickInput3();
const resourceGroup = await showQuickPick3({
input,
placeHolder: 'Pick a resource group',
items: resourceGroups
});
if (!resourceGroup) {
return undefined;
}
const name = await showInputBox3({
input,
prompt: 'Choose a unique name',
validate: validateNameIsUnique
});
if (name === undefined) {
return undefined;
}
const runtimes = await getAvailableRuntimes(resourceGroup, null /* token */);
const runtime = await showQuickPick3({
input,
placeHolder: 'Pick a runtime',
items: runtimes
});
if (!runtime) {
return undefined;
}
input.hide();
return { resourceGroup, name, runtime };
}
interface QuickPickParameters3 {
input: QuickInput3;
items: QuickPickItem[];
placeHolder: string;
}
async function showQuickPick3({ input, items, placeHolder }: QuickPickParameters3) {
const disposables: Disposable[] = [];
try {
return await new Promise<QuickPickItem>(resolve => {
input.placeholder = placeHolder;
input.text = '';
input.message = undefined;
input.items = items;
disposables.push(
input.onDidPickItem(item => resolve(item)),
input.onHide(() => resolve(undefined))
);
input.show();
});
} finally {
disposables.forEach(d => d.dispose());
}
}
interface InputBoxParameters3 {
input: QuickInput3;
prompt: string;
validate: (value: string) => Promise<string>;
}
async function showInputBox3({ input, prompt, validate }: InputBoxParameters3) {
const disposables: Disposable[] = [];
try {
return await new Promise<string>(resolve => {
input.placeholder = undefined;
input.text = '';
input.message = { text: prompt, severity: 0 };
input.items = undefined;
let validating = validate('');
disposables.push(
input.onDidAccept(async text => {
if (!(await validate(text))) {
resolve(text);
}
}),
input.onDidTextChange(async text => {
const current = validate(text);
validating = current;
const message = await current;
if (current === validating) {
if (message) {
input.message = { text: message, severity: 2 };
} else {
input.message = { text: prompt, severity: 0 };
}
}
}),
input.onHide(() => resolve(undefined))
);
input.show();
});
} finally {
disposables.forEach(d => d.dispose());
}
}
// #endregion
// #region Take 4 --------------------------------------------------------------------------------
async function collectInputs4() {
return window.multiStepInput4('resourceGroup', {
resourceGroup: {
kind: 'singlePick',
items: resourceGroups,
placeHolder: 'Pick a resource group',
nextStep: 'name'
},
name: {
kind: 'textInput',
prompt: 'Choose a unique name',
validateInput: value => validateNameIsUnique(value),
nextStep: 'runtime'
},
runtime: {
kind: 'singlePick',
items: await getAvailableRuntimes(null /* inputs.resourceGroup */, null /* token */),
placeHolder: 'Pick a runtime'
},
});
}
// #endregion
// #region Take 5 --------------------------------------------------------------------------------
async function collectInputs5() {
return window.multiStepInput5('resourceGroup', {
resourceGroup: async input => ({
value: input.showQuickPick(resourceGroups, { placeHolder: 'Pick a resource group' }),
next: 'name'
}),
name: async input => ({
value: input.showInputBox({
prompt: 'Choose a unique name',
validateInput: value => validateNameIsUnique(value)
}),
next: 'runtime'
}),
runtime: async (input, values) => {
const runtimes = await getAvailableRuntimes(values.resourceGroup, input.token);
return { value: input.showQuickPick(runtimes, { placeHolder: 'Pick a runtime' }) };
}
});
}
// #endregion
// #region Take 6 --------------------------------------------------------------------------------
async function collectInputs6() {
const result: Partial<Result> = {};
const resourceGroup = await window.showQuickPick(resourceGroups, {
placeHolder: 'Pick a resource group',
next: chooseName
});
async function chooseName(input: QuickInput6, resourceGroup: QuickPickItem) {
result.resourceGroup = resourceGroup;
const name = await input.showInputBox({
prompt: 'Choose a unique name',
validateInput: value => validateNameIsUnique(value),
next: chooseRuntime
});
}
async function chooseRuntime(input: QuickInput6, name: string) {
result.name = name;
const runtimes = await getAvailableRuntimes(result.resourceGroup, input.token);
const runtime = await input.showQuickPick(runtimes, { placeHolder: 'Pick a runtime' });
result.runtime = runtime;
}
return <Result>result;
}
// #endregion
// #region Take 7 --------------------------------------------------------------------------------
async function collectInputs7() {
let step = 1;
const result: Partial<Result> = {};
await window.multiStepInput7({
next: async input => {
await collectInput7(input, result, ++step);
},
previous: async input => {
await collectInput7(input, result, --step);
},
cancel: async input => {
input.close();
},
});
return <Result>result;
}
async function collectInput7(input: QuickInput7, result: Partial<Result>, step: number) {
switch (step) {
case 1:
result.resourceGroup = await input.showQuickPick(resourceGroups, { placeHolder: 'Pick a resource group' });
break;
case 2:
result.name = await input.showInputBox({
prompt: 'Choose a unique name',
validateInput: value => validateNameIsUnique(value)
});
break;
case 3:
const runtimes = await getAvailableRuntimes(result.resourceGroup, input.token);
result.runtime = await input.showQuickPick(runtimes, { placeHolder: 'Pick a runtime' });
break;
case 4:
input.close();
break;
}
}
// #endregion
// #region Take 8 --------------------------------------------------------------------------------
async function collectInputs8() {
const session = window.createQuickInputSession();
try {
const resourceGroup = await window.showQuickPick(resourceGroups, { placeHolder: 'Pick a resource group', session });
if (!resourceGroup || session.token.isCancellationRequested) {
return undefined;
}
const name = await window.showInputBox({
prompt: 'Choose a unique name',
validateInput: value => validateNameIsUnique(value),
session
});
if (!name || session.token.isCancellationRequested) {
return undefined;
}
const runtimes = await getAvailableRuntimes(resourceGroup, session.token);
const runtime = await window.showQuickPick(runtimes, { placeHolder: 'Pick a runtime', session });
return { resourceGroup, name, runtime };
} finally {
session.dispose();
}
}
// #endregion
// #region Take 9 --------------------------------------------------------------------------------
async function collectInputs9() {
// How to surface 'Back', 'Create Resource Group' as result?
const result: Partial<Result> = {};
window.multiStepInput9(async session => {
result.resourceGroup = await window.showQuickPick(resourceGroups, {
placeHolder: 'Pick a resource group',
session
});
return chooseName;
});
async function chooseName(session: QuickInputSession9) {
result.name = await window.showInputBox({
prompt: 'Choose a unique name',
validateInput: value => validateNameIsUnique(value),
session
});
return chooseRuntime;
}
async function chooseRuntime(session: QuickInputSession9) {
const runtimes = await getAvailableRuntimes(result.resourceGroup, session.token);
const runtime = await window.showQuickPick(runtimes, { placeHolder: 'Pick a runtime', session });
result.runtime = runtime;
}
return <Result>result;
}
// #endregion
// #region Take 10 --------------------------------------------------------------------------------
interface Result10 {
resourceGroup: QuickPickItem | string;
name: string;
runtime: QuickPickItem;
}
const createResourceGroupItem = { iconPath: 'createResourceGroup.svg' };
async function collectInputs10() {
const result: Partial<Result10> = {};
const multiStep = createMultiStepInput([pickResourceGroup]);
await stepThrough(multiStep);
async function pickResourceGroup() {
return showQuickPick10({
multiStep,
placeHolder: 'Pick a resource group',
items: resourceGroups,
toolbarItems: [createResourceGroupItem],
triggerToolbarItem: item => inputResourceGroupName,
pick: item => {
result.resourceGroup = item;
return inputName;
}
});
}
async function inputResourceGroupName() {
return showInputBox10({
multiStep,
prompt: 'Choose a unique name for the resource group',
validate: validateNameIsUnique,
accept: text => {
result.resourceGroup = text;
return inputName;
},
cancel: suspend
});
}
async function inputName() {
return showInputBox10({
multiStep,
prompt: 'Choose a unique name for the application service',
validate: validateNameIsUnique,
accept: text => {
result.name = text;
return pickRuntime;
},
cancel: suspend
});
}
async function pickRuntime() {
const runtimes = await getAvailableRuntimes(result.resourceGroup, null /* token */);
return showQuickPick10({
multiStep,
placeHolder: 'Pick a runtime',
items: runtimes,
pick: item => {
result.runtime = item;
},
cancel: suspend
});
}
function suspend() {
// Could show a notification with the option to resume.
const resume = async () => {
await stepThrough(multiStep);
};
}
return <Result10>result;
}
interface MultiStepInput {
input: QuickInput3;
steps: InputStep10[];
}
function createMultiStepInput(steps: InputStep10[]): MultiStepInput {
return {
input: window.createQuickInput3(),
steps
};
}
type InputStep10 = (() => Thenable<InputStep10>) | void;
async function stepThrough(multiStep: MultiStepInput) {
let step = multiStep.steps.pop();
while (step) {
multiStep.steps.push(step);
try {
step = await step();
} catch (e) {
if (e !== 'back') {
throw e;
}
multiStep.steps.pop();
step = multiStep.steps.pop();
}
}
multiStep.input.hide();
}
interface QuickPickParameters10 {
multiStep: MultiStepInput;
items: QuickPickItem[];
placeHolder: string;
toolbarItems?: QuickInputToolbarItem3[]; // TODO
triggerToolbarItem?: (item: QuickInputToolbarItem3) => InputStep10;
pick: (item: QuickPickItem) => InputStep10;
cancel?: () => void;
}
const backItem: QuickInputToolbarItem3 = { iconPath: 'back.svg' };
async function showQuickPick10({ multiStep, items, placeHolder, pick, cancel }: QuickPickParameters10) {
const disposables: Disposable[] = [];
try {
return await new Promise<InputStep10>((resolve, reject) => {
const input = multiStep.input;
input.placeholder = placeHolder;
input.text = '';
input.message = undefined;
input.items = items;
input.toolbarItems = multiStep.steps.length > 1 ? [backItem] : undefined;
input.onDidTriggerToolbarItem(item => {
if (item === backItem) {
reject('back');
}
});
disposables.push(
input.onDidPickItem(item => resolve(pick(item))),
input.onHide(() => {
if (cancel) {
cancel();
}
resolve();
})
);
input.show();
});
} finally {
disposables.forEach(d => d.dispose());
}
}
interface InputBoxParameters10 {
multiStep: MultiStepInput;
prompt: string;
validate: (value: string) => Promise<string>;
toolbarItems?: QuickInputToolbarItem3[]; // TODO
triggerToolbarItem?: (item: QuickInputToolbarItem3) => InputStep10;
accept: (text: string) => InputStep10;
cancel?: () => void;
}
async function showInputBox10({ multiStep, prompt, validate, accept, cancel }: InputBoxParameters10) {
const disposables: Disposable[] = [];
try {
return await new Promise<InputStep10>((resolve, reject) => {
const input = multiStep.input;
input.placeholder = undefined;
input.text = '';
input.message = { text: prompt, severity: 0 };
input.items = undefined;
input.toolbarItems = multiStep.steps.length > 1 ? [backItem] : undefined;
input.onDidTriggerToolbarItem(item => {
if (item === backItem) {
reject('back');
}
});
let validating = validate('');
disposables.push(
input.onDidAccept(async text => {
if (!(await validate(text))) {
resolve(accept(text));
}
}),
input.onDidTextChange(async text => {
const current = validate(text);
validating = current;
const message = await current;
if (current === validating) {
if (message) {
input.message = { text: message, severity: 2 };
} else {
input.message = { text: prompt, severity: 0 };
}
}
}),
input.onHide(() => {
if (cancel) {
cancel();
}
resolve();
})
);
input.show();
});
} finally {
disposables.forEach(d => d.dispose());
}
}
// #endregion
// ---------------------------------------------------------------------------------------
interface Result {
resourceGroup: QuickPickItem;
name: string;
runtime: QuickPickItem;
}
async function validateNameIsUnique(name: string) {
// ...validate...
await new Promise(resolve => setTimeout(resolve, 1000));
return name === 'vscode' ? 'Name not unique' : undefined;
}
async function getAvailableRuntimes(resourceGroup: QuickPickItem | string, token: CancellationToken): Promise<QuickPickItem[]> {
// ...retrieve...
await new Promise(resolve => setTimeout(resolve, 2000));
return ['Node 8.9', 'Node 6.11', 'Node 4.5']
.map(label => ({ label }));
}