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
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834import test from 'tape';
import { writeFile } from 'fs/promises';
import { rmSync } from 'fs';
import { join } from 'path';
import { fileURLToPath } from 'url';
import tmp from 'tmp';
import pargs from '../index.mjs';
const filename = fileURLToPath(import.meta.url);
/** @type {(dirPath: string, removeCallback: Function) => () => void} */
function emptyFirst(dirPath, removeCallback) {
return function () {
rmSync(dirPath, { recursive: true, force: true });
try {
removeCallback();
} catch (e) {
if (!e || typeof e !== 'object' || !('code' in e) || e.code !== 'ENOENT') {
throw e;
}
}
};
}
test('pargs - help option reservation', async (t) => {
try {
// @ts-expect-error
await pargs(filename, { help: true });
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when help is in root config');
if (e instanceof TypeError) {
t.match(e.message, /help.*reserved/i, 'error message mentions help is reserved');
}
}
try {
await pargs(filename, { options: { help: { type: 'boolean' } } });
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when help is in options');
t.match(
String(e && typeof e === 'object' && 'message' in e && e.message),
/help.*reserved/i,
'error message mentions help is reserved',
);
}
});
test('pargs - subcommands validation', async (t) => {
try {
// @ts-expect-error
await pargs(filename, { subcommands: null });
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when subcommands is null');
}
try {
// @ts-expect-error
await pargs(filename, { subcommands: 'invalid' });
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when subcommands is not an object');
}
try {
await pargs(filename, { subcommands: {} });
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when subcommands is empty object');
}
});
test('pargs - allowPositionals and subcommands are mutually exclusive', async (t) => {
try {
await pargs(filename, {
allowPositionals: true,
subcommands: { foo: {} },
});
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when both allowPositionals and subcommands are defined');
}
try {
await pargs(filename, {
allowPositionals: 2,
subcommands: { foo: {} },
});
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when allowPositionals is a number and subcommands are defined');
}
});
test('pargs - minPositionals and subcommands are mutually exclusive', async (t) => {
try {
await pargs(filename, {
minPositionals: 2,
subcommands: { foo: {} },
});
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when both minPositionals and subcommands are defined');
}
try {
await pargs(filename, {
minPositionals: 2,
subcommands: { foo: {} },
});
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when minPositionals is a number and subcommands are defined');
}
});
test('pargs - enum choices validation', async (t) => {
t.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, filename] });
try {
await pargs(filename, {
options: {
level: {
type: 'enum',
// @ts-expect-error
choices: 'invalid',
},
},
});
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when choices is not an array');
}
try {
await pargs(filename, {
options: {
level: {
type: 'enum',
// @ts-expect-error
choices: [1, 2, 3],
},
},
});
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when choices contains non-strings');
}
try {
await pargs(filename, {
options: {
level: {
type: 'enum',
// @ts-expect-error
choices: ['debug', 'info', 123],
},
},
});
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'throws TypeError when choices contains mixed types');
}
});
test('pargs - boolean option mutual exclusivity', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help text'),
writeFile(entrypoint, '// test file'),
]);
t.test('--verbose and --no-verbose are mutually exclusive', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--verbose', '--no-verbose'] });
const result = await pargs(entrypoint, {
options: {
verbose: { type: 'boolean' },
},
});
st.ok(result.errors.length > 0, 'has errors when both --verbose and --no-verbose are provided');
st.ok(
result.errors.some((e) => e.includes('mutually exclusive')),
'error mentions mutual exclusivity',
);
});
t.test('--help and --no-help are mutually exclusive', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--help', '--no-help'] });
const result = await pargs(entrypoint, {
options: {
debug: { type: 'boolean' },
},
});
st.ok(result.errors.length > 0, 'has errors when both --help and --no-help are provided');
});
t.test('--no-flag works correctly', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--no-verbose'] });
const result = await pargs(entrypoint, {
options: {
verbose: { type: 'boolean', default: true },
},
});
st.equal(result.values.verbose, false, '--no-verbose sets value to false');
st.notOk('no-verbose' in result.values, 'no-verbose is removed from values');
});
});
test('pargs - unknown options detection', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help text'),
writeFile(entrypoint, '// test file'),
]);
t.test('unknown option on root', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--unknown'] });
const result = await pargs(entrypoint, {
options: {
known: { type: 'boolean' },
},
});
st.ok(result.errors.length > 0, 'has errors for unknown option');
st.ok(
result.errors.some((e) => e.includes('Unknown option')),
'error mentions unknown option',
);
});
t.test('multiple unknown options', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--foo', '--bar'] });
const result = await pargs(entrypoint, {
options: {
known: { type: 'boolean' },
},
});
st.ok(result.errors.length > 0, 'has errors for multiple unknown options');
});
});
test('pargs - subcommands functionality', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help text'),
writeFile(entrypoint, '// test file'),
]);
t.test('valid subcommand', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'build', '--verbose'] });
const result = await pargs(entrypoint, {
subcommands: {
build: {
options: {
verbose: { type: 'boolean' },
},
},
},
});
st.equal(result.command.name, 'build', 'command name is set');
st.equal(result.command.values.verbose, true, 'subcommand option is parsed');
st.equal(result.errors.length, 0, 'no errors for valid subcommand');
});
t.test('unknown subcommand', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'unknown'] });
const result = await pargs(entrypoint, {
subcommands: {
build: {},
},
});
st.ok(result.errors.length > 0, 'has errors for unknown subcommand');
st.ok(
result.errors.some((e) => e.includes('unknown command')),
'error mentions unknown command',
);
});
t.test('unknown option in subcommand', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'build', '--unknown'] });
const result = await pargs(entrypoint, {
subcommands: {
build: {
options: {
verbose: { type: 'boolean' },
},
},
},
});
st.ok(result.command.errors.length > 0, 'subcommand has errors for unknown option');
});
});
test('pargs - allowPositionals functionality', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help text'),
writeFile(entrypoint, '// test file'),
]);
t.test('allowPositionals as boolean (true)', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'file1.js', 'file2.js', 'file3.js'] });
const result = await pargs(entrypoint, {
allowPositionals: true,
});
st.equal(result.positionals.length, 3, 'parses all positionals when allowPositionals is true');
st.equal(result.errors.length, 0, 'no errors when positionals are allowed');
});
t.test('allowPositionals as number', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'file1.js', 'file2.js'] });
const result = await pargs(entrypoint, {
allowPositionals: 2,
});
st.equal(result.positionals.length, 2, 'parses positionals when within limit');
st.equal(result.errors.length, 0, 'no errors when positional count is within limit');
});
t.test('too many positionals', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'file1.js', 'file2.js', 'file3.js'] });
const result = await pargs(entrypoint, {
allowPositionals: 2,
});
st.ok(result.errors.length > 0, 'has errors when too many positionals');
st.ok(
result.errors.some((e) => e.includes('Only 2 positional')),
'error mentions positional limit',
);
});
t.test('allowPositionals in subcommand', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'build', 'file1.js'] });
const result = await pargs(entrypoint, {
subcommands: {
build: {
allowPositionals: 1,
},
},
});
st.equal(result.command.positionals.length, 1, 'subcommand parses positionals');
st.equal(result.command.errors.length, 0, 'no errors in subcommand with allowed positionals');
});
});
test('pargs - minPositionals functionality', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help text'),
writeFile(entrypoint, '// test file'),
]);
t.test('not enough positionals', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'file1.js'] });
const result = await pargs(entrypoint, {
allowPositionals: true,
minPositionals: 2,
});
st.ok(result.errors.length > 0, 'has errors when not enough positionals');
st.ok(
result.errors.some((e) => e.includes('At least 2 positional')),
'error mentions minimum positional requirement',
);
});
t.test('too many positionals', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'file1.js', 'file2.js', 'file3.js'] });
const result = await pargs(entrypoint, {
allowPositionals: 2,
minPositionals: 1,
});
st.ok(result.errors.length > 0, 'has errors when too many positionals');
st.ok(
result.errors.some((e) => e.includes('Only 2 positional')),
'error mentions maximum positional limit',
);
});
t.test('min number of positionals', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'file1.js', 'file2.js'] });
const result = await pargs(entrypoint, {
allowPositionals: true,
minPositionals: 2,
});
st.equal(result.positionals.length, 2, 'parses exactly minimum number of positionals');
st.equal(result.errors.length, 0, 'no errors when minimum positionals provided');
});
t.test('minPositionals in subcommand', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'build', 'file1.js'] });
const notEnoughResult = await pargs(entrypoint, {
subcommands: {
build: {
allowPositionals: true,
minPositionals: 2,
},
},
});
st.ok(notEnoughResult.command.errors.length > 0, 'subcommand has errors when not enough positionals');
st.ok(
notEnoughResult.command.errors.some((e) => e.includes('At least 2 positional')),
'error mentions minimum requirement in subcommand',
);
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'build', 'file1.js', 'file2.js', 'file3.js'] });
const tooManyResult = await pargs(entrypoint, {
subcommands: {
build: {
allowPositionals: 2,
minPositionals: 1,
},
},
});
st.ok(tooManyResult.command.errors.length > 0, 'subcommand has errors when too many positionals');
st.ok(
tooManyResult.command.errors.some((e) => e.includes('Only 2 positional')),
'error mentions maximum limit in subcommand',
);
});
});
test('pargs - enum validation', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help text'),
writeFile(entrypoint, '// test file'),
]);
t.test('valid enum value', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--level=debug'] });
const result = await pargs(entrypoint, {
options: {
level: {
type: 'enum',
choices: ['debug', 'info', 'warn', 'error'],
},
},
});
st.equal(result.values.level, 'debug', 'parses valid enum value');
st.equal(result.errors.length, 0, 'no errors for valid enum value');
});
t.test('invalid enum value', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--level=invalid'] });
const result = await pargs(entrypoint, {
options: {
level: {
type: 'enum',
choices: ['debug', 'info', 'warn', 'error'],
},
},
});
st.ok(result.errors.length > 0, 'has errors for invalid enum value');
st.ok(
result.errors.some((e) => e.includes('Invalid value for option "level"')),
'error mentions invalid enum value',
);
});
t.test('enum with default', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint] });
const result = await pargs(entrypoint, {
options: {
level: {
type: 'enum',
choices: ['debug', 'info', 'warn', 'error'],
default: 'info',
},
},
});
st.equal(result.values.level, 'info', 'uses default enum value');
st.equal(result.errors.length, 0, 'no errors with default enum value');
});
});
test('pargs - help functionality', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'This is help text'),
writeFile(entrypoint, '// test file'),
]);
t.test('--help flag', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--help'] });
const result = await pargs(entrypoint, {
options: {
verbose: { type: 'boolean' },
},
});
st.equal(typeof result.help, 'function', 'result has help function');
const logCapture = st.capture(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (console)), 'log');
const exitCapture = st.capture(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'exit', () => {
throw new Error('EXIT');
});
try {
await result.help();
} catch (e) {
st.ok(e instanceof Error, 'process.exit mock throws');
}
const logs = logCapture().map((call) => call.args.join(' '));
const exitCalls = exitCapture();
st.equal(exitCalls.length, 1, 'help() calls process.exit once');
st.ok(logs.some((log) => log.includes('This is help text')), 'help() outputs help text to console.log');
});
t.test('help with errors', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--unknown'] });
const result = await pargs(entrypoint, {
options: {
verbose: { type: 'boolean' },
},
});
st.ok(result.errors.length > 0, 'result has errors before calling help');
st.equal(typeof result.help, 'function', 'result has help function');
st.notOk(result.values.help, '--help flag should not be set');
const logCapture = st.capture(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (console)), 'log');
const errorCapture = st.capture(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (console)), 'error');
const exitCapture = st.capture(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'exit', () => {
throw new Error('EXIT');
});
const originalExitCode = process.exitCode;
try {
await result.help();
} catch (e) {
st.ok(e instanceof Error, 'process.exit mock throws');
}
const logs = logCapture().map((call) => call.args.join(' '));
const errors = errorCapture().map((call) => call.args.join(' '));
const exitCalls = exitCapture();
const capturedExitCode = process.exitCode;
process.exitCode = originalExitCode;
st.equal(exitCalls.length, 1, 'help() with errors calls process.exit');
st.ok(errors.length > 0, 'console.error was called');
st.ok(logs.some((log) => log.includes('This is help text')), 'help text was output to stdout');
st.ok(errors.some((err) => err.includes('Unknown option')), 'help() outputs errors to stderr');
st.ok(Number(capturedExitCode) > 0, 'process.exitCode was set to non-zero');
});
});
test('pargs - argv filtering', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help text'),
writeFile(entrypoint, '// test file'),
]);
t.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--flag', 'value'] });
const result = await pargs(entrypoint, {
options: {
flag: { type: 'string' },
},
allowPositionals: true,
});
t.equal(result.values.flag, 'value', 'parses options correctly');
t.notOk(
result.positionals.includes(process.execPath),
'execPath is not in positionals',
);
t.notOk(
result.positionals.includes(entrypoint),
'entrypoint is not in positionals',
);
});
test('pargs - boolean type validation', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help text'),
writeFile(entrypoint, '// test file'),
]);
t.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--verbose=yes'] });
const result = await pargs(entrypoint, {
options: {
verbose: { type: 'boolean' },
},
});
t.ok(result.errors.length > 0, 'has errors when boolean option has value');
t.ok(
result.errors.some((e) => e.includes('does not take an argument')),
'error mentions argument rejection',
);
});
test('pargs - help() error output path coverage', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Help text for errors'),
writeFile(entrypoint, '// test file'),
]);
t.test('help() with enum error', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--level=invalid'] });
const result = await pargs(entrypoint, {
options: {
level: {
type: 'enum',
choices: ['debug', 'info', 'warn'],
},
},
});
st.ok(result.errors.length > 0, 'has errors');
st.notOk(result.values.help, '--help flag should be false');
const logCapture = st.capture(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (console)), 'log');
const errorCapture = st.capture(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (console)), 'error');
const exitCapture = st.capture(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'exit', () => {
throw new Error('EXIT');
});
const originalExitCode = process.exitCode;
process.exitCode = undefined;
try {
await result.help();
} catch (e) {
st.ok(e instanceof Error, 'process.exit mock throws');
}
const logs = logCapture().map((call) => call.args.join(' '));
const errors = errorCapture().map((call) => call.args.join(' '));
const exitCalls = exitCapture();
const capturedExitCode = process.exitCode;
process.exitCode = originalExitCode;
st.equal(exitCalls.length, 1, 'help() was called and exited');
st.ok(logs.some((log) => log.includes('Help text for errors')), 'help text was output to stderr');
st.ok(errors.some((err) => err.includes('Invalid value for option "level"')), 'errors were output to stdout');
st.ok(Number(capturedExitCode) > 0, 'process.exitCode was set');
});
});
test('pargs - rethrows non-ParseArgsError exceptions', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help'),
writeFile(entrypoint, '// test file'),
]);
t.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'build'] });
try {
await pargs(entrypoint, {
subcommands: {
build: {
// @ts-expect-error
help: true,
},
},
});
t.fail('should have thrown');
} catch (e) {
t.ok(e instanceof TypeError, 'error is a TypeError');
t.match(
String(e && typeof e === 'object' && 'message' in e && e.message),
/help.*reserved/i,
'error message mentions help is reserved',
);
}
});
test('pargs - no options with strict false', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help'),
writeFile(entrypoint, '// test file'),
]);
t.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--anything'] });
const result = await pargs(entrypoint, {});
t.ok(result.errors.length > 0, 'has errors for unknown option with no options defined');
t.ok(
result.errors.some((e) => e.includes('Unknown option')),
'error mentions unknown option',
);
});
test('pargs - tokens option', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help'),
writeFile(entrypoint, '// test file'),
]);
t.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, '--verbose'] });
const result = await pargs(entrypoint, {
options: {
verbose: { type: 'boolean' },
},
tokens: true,
});
t.ok('tokens' in result, 'result has tokens property');
t.ok(Array.isArray(result.tokens), 'tokens is an array');
});
test('pargs - subcommand without name in argv', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Test help'),
writeFile(entrypoint, '// test file'),
]);
t.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint] });
const result = await pargs(entrypoint, {
subcommands: {
build: {},
},
});
t.ok(result.errors.length > 0, 'has errors for missing subcommand');
t.ok(
result.errors.some((e) => e.includes('unknown command')),
'error mentions unknown command',
);
});
test('pargs - subcommand with custom help function', async (t) => {
const { name: testDir, removeCallback } = tmp.dirSync();
t.teardown(emptyFirst(testDir, removeCallback));
const helpPath = join(testDir, 'help.txt');
const entrypoint = join(testDir, 'test.mjs');
await Promise.all([
writeFile(helpPath, 'Main help'),
writeFile(entrypoint, '// test file'),
]);
t.test('subcommand help function', async (st) => {
st.intercept(/** @type {Record<string, unknown>} */ (/** @type {unknown} */ (process)), 'argv', { value: [process.execPath, entrypoint, 'build', '--help'] });
const result = await pargs(entrypoint, {
subcommands: {
build: {
options: {
verbose: { type: 'boolean' },
},
},
},
});
st.ok('command' in result, 'result has command property');
st.equal(typeof result.command.help, 'function', 'command has help function');
st.ok(result.command.values.help, '--help flag is set in subcommand');
});
});