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
605
606
607
608
609
|
const { test } = require('tap')
const requireInject = require('require-inject')
const fs = require('fs')
const path = require('path')
const completionScript = fs.readFileSync(path.resolve(__dirname, '../../lib/utils/completion.sh'), { encoding: 'utf8' }).replace(/^#!.*?\n/, '')
const output = []
const npmConfig = {}
let accessCompletionError = false
const npm = {
config: {
set: (key, value) => {
npmConfig[key] = value
},
clear: () => {
for (const key in npmConfig)
delete npmConfig[key]
},
},
commands: {
completion: {
completion: () => [['>>', '~/.bashrc']],
},
adduser: {},
access: {
completion: () => {
if (accessCompletionError)
throw new Error('access completion failed')
return ['public', 'restricted']
},
},
promise: {
completion: () => Promise.resolve(['resolved_completion_promise']),
},
donothing: {
completion: () => {
return null
},
},
driveaboat: {
completion: () => {
return ' fast'
},
},
},
output: (line) => {
output.push(line)
},
}
const cmdList = {
aliases: {
login: 'adduser',
},
cmdList: [
'access',
'adduser',
'completion',
],
plumbing: [],
}
// only include a subset so that the snapshots aren't huge and
// don't change when we add/remove config definitions.
const definitions = require('../../lib/utils/config/definitions.js')
const config = {
definitions: {
global: definitions.global,
browser: definitions.browser,
registry: definitions.registry,
},
shorthands: {
reg: ['--registry'],
},
}
const deref = (cmd) => {
return cmd
}
const Completion = requireInject('../../lib/completion.js', {
'../../lib/utils/cmd-list.js': cmdList,
'../../lib/utils/config/index.js': config,
'../../lib/utils/deref-command.js': deref,
'../../lib/utils/is-windows-shell.js': false,
})
const completion = new Completion(npm)
test('completion completion', async t => {
const home = process.env.HOME
t.teardown(() => {
process.env.HOME = home
})
process.env.HOME = t.testdir({
'.bashrc': '',
'.zshrc': '',
})
const res = await completion.completion({ w: 2 })
t.strictSame(res, [
['>>', '~/.zshrc'],
['>>', '~/.bashrc'],
], 'identifies both shells')
t.end()
})
test('completion completion no known shells', async t => {
const home = process.env.HOME
t.teardown(() => {
process.env.HOME = home
})
process.env.HOME = t.testdir()
const res = await completion.completion({ w: 2 })
t.strictSame(res, [], 'no responses')
t.end()
})
test('completion completion wrong word count', async t => {
const res = await completion.completion({ w: 3 })
t.strictSame(res, undefined, 'no responses')
t.end()
})
test('completion errors in windows without bash', t => {
const Compl = requireInject('../../lib/completion.js', {
'../../lib/utils/is-windows-shell.js': true,
})
const compl = new Compl()
compl.exec({}, (err) => {
t.match(err, {
code: 'ENOTSUP',
message: /completion supported only in MINGW/,
}, 'returns the correct error')
t.end()
})
})
test('dump script when completion is not being attempted', t => {
const _write = process.stdout.write
const _on = process.stdout.on
t.teardown(() => {
process.stdout.write = _write
process.stdout.on = _on
})
let errorHandler
process.stdout.on = (event, handler) => {
errorHandler = handler
process.stdout.on = _on
}
let data
process.stdout.write = (chunk, callback) => {
data = chunk
process.stdout.write = _write
process.nextTick(() => {
callback()
errorHandler({ errno: 'EPIPE' })
})
}
completion.exec({}, (err) => {
if (err)
throw err
t.equal(data, completionScript, 'wrote the completion script')
t.end()
})
})
test('dump script exits correctly when EPIPE is emitted on stdout', t => {
const _write = process.stdout.write
const _on = process.stdout.on
t.teardown(() => {
process.stdout.write = _write
process.stdout.on = _on
})
let errorHandler
process.stdout.on = (event, handler) => {
errorHandler = handler
process.stdout.on = _on
}
let data
process.stdout.write = (chunk, callback) => {
data = chunk
process.stdout.write = _write
process.nextTick(() => {
errorHandler({ errno: 'EPIPE' })
callback()
})
}
completion.exec({}, (err) => {
if (err)
throw err
t.equal(data, completionScript, 'wrote the completion script')
t.end()
})
})
test('non EPIPE errors cause failures', t => {
const _write = process.stdout.write
const _on = process.stdout.on
t.teardown(() => {
process.stdout.write = _write
process.stdout.on = _on
})
let errorHandler
process.stdout.on = (event, handler) => {
errorHandler = handler
process.stdout.on = _on
}
let data
process.stdout.write = (chunk, callback) => {
data = chunk
process.stdout.write = _write
process.nextTick(() => {
errorHandler({ errno: 'ESOMETHINGELSE' })
callback()
})
}
completion.exec({}, (err) => {
t.equal(err.errno, 'ESOMETHINGELSE', 'propagated error')
t.equal(data, completionScript, 'wrote the completion script')
t.end()
})
})
test('completion completes single command name', t => {
process.env.COMP_CWORD = 1
process.env.COMP_LINE = 'npm c'
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', 'c'], (err, res) => {
if (err)
throw err
t.strictSame(output, ['completion'], 'correctly completed a command name')
t.end()
})
})
test('completion completes command names', t => {
process.env.COMP_CWORD = 1
process.env.COMP_LINE = 'npm a'
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', 'a'], (err, res) => {
if (err)
throw err
t.strictSame(output, [['access', 'adduser'].join('\n')], 'correctly completed a command name')
t.end()
})
})
test('completion of invalid command name does nothing', t => {
process.env.COMP_CWORD = 1
process.env.COMP_LINE = 'npm compute'
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', 'compute'], (err, res) => {
if (err)
throw err
t.strictSame(output, [], 'returns no results')
t.end()
})
})
test('handles async completion function', t => {
process.env.COMP_CWORD = 2
process.env.COMP_LINE = 'npm promise'
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', 'promise', ''], (err, res) => {
if (err)
throw err
t.strictSame(npmConfig, {
argv: {
remain: ['npm', 'promise'],
cooked: ['npm', 'promise'],
original: ['npm', 'promise'],
},
}, 'applies command config appropriately')
t.strictSame(output, ['resolved_completion_promise'], 'resolves async completion results')
t.end()
})
})
test('completion triggers command completions', t => {
process.env.COMP_CWORD = 2
process.env.COMP_LINE = 'npm access '
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', 'access', ''], (err, res) => {
if (err)
throw err
t.strictSame(npmConfig, {
argv: {
remain: ['npm', 'access'],
cooked: ['npm', 'access'],
original: ['npm', 'access'],
},
}, 'applies command config appropriately')
t.strictSame(output, [['public', 'restricted'].join('\n')], 'correctly completed a subcommand name')
t.end()
})
})
test('completion triggers filtered command completions', t => {
process.env.COMP_CWORD = 2
process.env.COMP_LINE = 'npm access p'
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', 'access', 'p'], (err, res) => {
if (err)
throw err
t.strictSame(npmConfig, {
argv: {
remain: ['npm', 'access'],
cooked: ['npm', 'access'],
original: ['npm', 'access'],
},
}, 'applies command config appropriately')
t.strictSame(output, ['public'], 'correctly completed a subcommand name')
t.end()
})
})
test('completions for commands that return nested arrays are joined', t => {
process.env.COMP_CWORD = 2
process.env.COMP_LINE = 'npm completion '
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', 'completion', ''], (err, res) => {
if (err)
throw err
t.strictSame(npmConfig, {
argv: {
remain: ['npm', 'completion'],
cooked: ['npm', 'completion'],
original: ['npm', 'completion'],
},
}, 'applies command config appropriately')
t.strictSame(output, ['>> ~/.bashrc'], 'joins nested arrays')
t.end()
})
})
test('completions for commands that return nothing work correctly', t => {
process.env.COMP_CWORD = 2
process.env.COMP_LINE = 'npm donothing '
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', 'donothing', ''], (err, res) => {
if (err)
throw err
t.strictSame(npmConfig, {
argv: {
remain: ['npm', 'donothing'],
cooked: ['npm', 'donothing'],
original: ['npm', 'donothing'],
},
}, 'applies command config appropriately')
t.strictSame(output, [], 'returns nothing')
t.end()
})
})
test('completions for commands that return a single item work correctly', t => {
process.env.COMP_CWORD = 2
process.env.COMP_LINE = 'npm driveaboat '
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', 'driveaboat', ''], (err, res) => {
if (err)
throw err
t.strictSame(npmConfig, {
argv: {
remain: ['npm', 'driveaboat'],
cooked: ['npm', 'driveaboat'],
original: ['npm', 'driveaboat'],
},
}, 'applies command config appropriately')
t.strictSame(output, ['\' fast\''], 'returns the correctly escaped string')
t.end()
})
})
test('command completion for commands with no completion return no results', t => {
process.env.COMP_CWORD = 2
process.env.COMP_LINE = 'npm adduser '
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
// quotes around adduser are to ensure coverage when unescaping commands
completion.exec(['npm', '\'adduser\'', ''], (err, res) => {
if (err)
throw err
t.strictSame(npmConfig, {
argv: {
remain: ['npm', 'adduser'],
cooked: ['npm', 'adduser'],
original: ['npm', 'adduser'],
},
}, 'applies command config appropriately')
t.strictSame(output, [], 'correctly completed a subcommand name')
t.end()
})
})
test('command completion errors propagate', t => {
process.env.COMP_CWORD = 2
process.env.COMP_LINE = 'npm access '
process.env.COMP_POINT = process.env.COMP_LINE.length
accessCompletionError = true
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
accessCompletionError = false
})
completion.exec(['npm', 'access', ''], (err, res) => {
t.match(err, /access completion failed/, 'catches the appropriate error')
t.strictSame(npmConfig, {
argv: {
remain: ['npm', 'access'],
cooked: ['npm', 'access'],
original: ['npm', 'access'],
},
}, 'applies command config appropriately')
t.strictSame(output, [], 'returns no results')
t.end()
})
})
test('completion can complete flags', t => {
process.env.COMP_CWORD = 2
process.env.COMP_LINE = 'npm install --'
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', 'install', '--'], (err, res) => {
if (err)
throw err
t.strictSame(npmConfig, {}, 'does not apply command config')
t.strictSame(output, [['--global', '--browser', '--registry', '--reg', '--no-global', '--no-browser'].join('\n')], 'correctly completes flag names')
t.end()
})
})
test('double dashes escape from flag completion', t => {
process.env.COMP_CWORD = 2
process.env.COMP_LINE = 'npm -- install --'
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', '--', 'install', '--'], (err, res) => {
if (err)
throw err
t.strictSame(npmConfig, {}, 'does not apply command config')
t.strictSame(output, [['access', 'adduser', 'completion', 'login'].join('\n')], 'correctly completes flag names')
t.end()
})
})
test('completion cannot complete options that take a value in mid-command', t => {
process.env.COMP_CWORD = 2
process.env.COMP_LINE = 'npm --registry install'
process.env.COMP_POINT = process.env.COMP_LINE.length
t.teardown(() => {
delete process.env.COMP_CWORD
delete process.env.COMP_LINE
delete process.env.COMP_POINT
npm.config.clear()
output.length = 0
})
completion.exec(['npm', '--registry', 'install'], (err, res) => {
if (err)
throw err
t.strictSame(npmConfig, {}, 'does not apply command config')
t.strictSame(output, [], 'does not try to complete option arguments in the middle of a command')
t.end()
})
})
|