-
Notifications
You must be signed in to change notification settings - Fork 28.2k
/
test-parse-args.mjs
994 lines (871 loc) Β· 34.6 KB
/
test-parse-args.mjs
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
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
import '../common/index.mjs';
import assert from 'node:assert';
import { test } from 'node:test';
import { parseArgs } from 'node:util';
test('when short option used as flag then stored as flag', () => {
const args = ['-f'];
const expected = { values: { __proto__: null, f: true }, positionals: [] };
const result = parseArgs({ strict: false, args });
assert.deepStrictEqual(result, expected);
});
test('when short option used as flag before positional then stored as flag and positional (and not value)', () => {
const args = ['-f', 'bar'];
const expected = { values: { __proto__: null, f: true }, positionals: [ 'bar' ] };
const result = parseArgs({ strict: false, args });
assert.deepStrictEqual(result, expected);
});
test('when short option `type: "string"` used with value then stored as value', () => {
const args = ['-f', 'bar'];
const options = { f: { type: 'string' } };
const expected = { values: { __proto__: null, f: 'bar' }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected);
});
test('when short option listed in short used as flag then long option stored as flag', () => {
const args = ['-f'];
const options = { foo: { short: 'f', type: 'boolean' } };
const expected = { values: { __proto__: null, foo: true }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected);
});
test('when short option listed in short and long listed in `type: "string"` and ' +
'used with value then long option stored as value', () => {
const args = ['-f', 'bar'];
const options = { foo: { short: 'f', type: 'string' } };
const expected = { values: { __proto__: null, foo: 'bar' }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected);
});
test('when short option `type: "string"` used without value then stored as flag', () => {
const args = ['-f'];
const options = { f: { type: 'string' } };
const expected = { values: { __proto__: null, f: true }, positionals: [] };
const result = parseArgs({ strict: false, args, options });
assert.deepStrictEqual(result, expected);
});
test('short option group behaves like multiple short options', () => {
const args = ['-rf'];
const options = { };
const expected = { values: { __proto__: null, r: true, f: true }, positionals: [] };
const result = parseArgs({ strict: false, args, options });
assert.deepStrictEqual(result, expected);
});
test('short option group does not consume subsequent positional', () => {
const args = ['-rf', 'foo'];
const options = { };
const expected = { values: { __proto__: null, r: true, f: true }, positionals: ['foo'] };
const result = parseArgs({ strict: false, args, options });
assert.deepStrictEqual(result, expected);
});
// See: Guideline 5 https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap12.html
test('if terminal of short-option group configured `type: "string"`, subsequent positional is stored', () => {
const args = ['-rvf', 'foo'];
const options = { f: { type: 'string' } };
const expected = { values: { __proto__: null, r: true, v: true, f: 'foo' }, positionals: [] };
const result = parseArgs({ strict: false, args, options });
assert.deepStrictEqual(result, expected);
});
test('handles short-option groups in conjunction with long-options', () => {
const args = ['-rf', '--foo', 'foo'];
const options = { foo: { type: 'string' } };
const expected = { values: { __proto__: null, r: true, f: true, foo: 'foo' }, positionals: [] };
const result = parseArgs({ strict: false, args, options });
assert.deepStrictEqual(result, expected);
});
test('handles short-option groups with "short" alias configured', () => {
const args = ['-rf'];
const options = { remove: { short: 'r', type: 'boolean' } };
const expected = { values: { __proto__: null, remove: true, f: true }, positionals: [] };
const result = parseArgs({ strict: false, args, options });
assert.deepStrictEqual(result, expected);
});
test('handles short-option followed by its value', () => {
const args = ['-fFILE'];
const options = { foo: { short: 'f', type: 'string' } };
const expected = { values: { __proto__: null, foo: 'FILE' }, positionals: [] };
const result = parseArgs({ strict: false, args, options });
assert.deepStrictEqual(result, expected);
});
test('Everything after a bare `--` is considered a positional argument', () => {
const args = ['--', 'barepositionals', 'mopositionals'];
const expected = { values: { __proto__: null }, positionals: ['barepositionals', 'mopositionals'] };
const result = parseArgs({ allowPositionals: true, args });
assert.deepStrictEqual(result, expected, Error('testing bare positionals'));
});
test('args are true', () => {
const args = ['--foo', '--bar'];
const expected = { values: { __proto__: null, foo: true, bar: true }, positionals: [] };
const result = parseArgs({ strict: false, args });
assert.deepStrictEqual(result, expected, Error('args are true'));
});
test('arg is true and positional is identified', () => {
const args = ['--foo=a', '--foo', 'b'];
const expected = { values: { __proto__: null, foo: true }, positionals: ['b'] };
const result = parseArgs({ strict: false, args });
assert.deepStrictEqual(result, expected, Error('arg is true and positional is identified'));
});
test('args equals are passed `type: "string"`', () => {
const args = ['--so=wat'];
const options = { so: { type: 'string' } };
const expected = { values: { __proto__: null, so: 'wat' }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected, Error('arg value is passed'));
});
test('when args include single dash then result stores dash as positional', () => {
const args = ['-'];
const expected = { values: { __proto__: null }, positionals: ['-'] };
const result = parseArgs({ allowPositionals: true, args });
assert.deepStrictEqual(result, expected);
});
test('zero config args equals are parsed as if `type: "string"`', () => {
const args = ['--so=wat'];
const options = { };
const expected = { values: { __proto__: null, so: 'wat' }, positionals: [] };
const result = parseArgs({ strict: false, args, options });
assert.deepStrictEqual(result, expected, Error('arg value is passed'));
});
test('same arg is passed twice `type: "string"` and last value is recorded', () => {
const args = ['--foo=a', '--foo', 'b'];
const options = { foo: { type: 'string' } };
const expected = { values: { __proto__: null, foo: 'b' }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected, Error('last arg value is passed'));
});
test('args equals pass string including more equals', () => {
const args = ['--so=wat=bing'];
const options = { so: { type: 'string' } };
const expected = { values: { __proto__: null, so: 'wat=bing' }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected, Error('arg value is passed'));
});
test('first arg passed for `type: "string"` and "multiple" is in array', () => {
const args = ['--foo=a'];
const options = { foo: { type: 'string', multiple: true } };
const expected = { values: { __proto__: null, foo: ['a'] }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected, Error('first multiple in array'));
});
test('args are passed `type: "string"` and "multiple"', () => {
const args = ['--foo=a', '--foo', 'b'];
const options = {
foo: {
type: 'string',
multiple: true,
},
};
const expected = { values: { __proto__: null, foo: ['a', 'b'] }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected, Error('both arg values are passed'));
});
test('when expecting `multiple:true` boolean option and option used multiple times then result includes array of ' +
'booleans matching usage', () => {
const args = ['--foo', '--foo'];
const options = {
foo: {
type: 'boolean',
multiple: true,
},
};
const expected = { values: { __proto__: null, foo: [true, true] }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected);
});
test('order of option and positional does not matter (per README)', () => {
const args1 = ['--foo=bar', 'baz'];
const args2 = ['baz', '--foo=bar'];
const options = { foo: { type: 'string' } };
const expected = { values: { __proto__: null, foo: 'bar' }, positionals: ['baz'] };
assert.deepStrictEqual(
parseArgs({ allowPositionals: true, args: args1, options }),
expected,
Error('option then positional')
);
assert.deepStrictEqual(
parseArgs({ allowPositionals: true, args: args2, options }),
expected,
Error('positional then option')
);
});
test('correct default args when use node -p', () => {
const holdArgv = process.argv;
process.argv = [process.argv0, '--foo'];
const holdExecArgv = process.execArgv;
process.execArgv = ['-p', '0'];
const result = parseArgs({ strict: false });
const expected = { values: { __proto__: null, foo: true },
positionals: [] };
assert.deepStrictEqual(result, expected);
process.argv = holdArgv;
process.execArgv = holdExecArgv;
});
test('correct default args when use node --print', () => {
const holdArgv = process.argv;
process.argv = [process.argv0, '--foo'];
const holdExecArgv = process.execArgv;
process.execArgv = ['--print', '0'];
const result = parseArgs({ strict: false });
const expected = { values: { __proto__: null, foo: true },
positionals: [] };
assert.deepStrictEqual(result, expected);
process.argv = holdArgv;
process.execArgv = holdExecArgv;
});
test('correct default args when use node -e', () => {
const holdArgv = process.argv;
process.argv = [process.argv0, '--foo'];
const holdExecArgv = process.execArgv;
process.execArgv = ['-e', '0'];
const result = parseArgs({ strict: false });
const expected = { values: { __proto__: null, foo: true },
positionals: [] };
assert.deepStrictEqual(result, expected);
process.argv = holdArgv;
process.execArgv = holdExecArgv;
});
test('correct default args when use node --eval', () => {
const holdArgv = process.argv;
process.argv = [process.argv0, '--foo'];
const holdExecArgv = process.execArgv;
process.execArgv = ['--eval', '0'];
const result = parseArgs({ strict: false });
const expected = { values: { __proto__: null, foo: true },
positionals: [] };
assert.deepStrictEqual(result, expected);
process.argv = holdArgv;
process.execArgv = holdExecArgv;
});
test('correct default args when normal arguments', () => {
const holdArgv = process.argv;
process.argv = [process.argv0, 'script.js', '--foo'];
const holdExecArgv = process.execArgv;
process.execArgv = [];
const result = parseArgs({ strict: false });
const expected = { values: { __proto__: null, foo: true },
positionals: [] };
assert.deepStrictEqual(result, expected);
process.argv = holdArgv;
process.execArgv = holdExecArgv;
});
test('excess leading dashes on options are retained', () => {
// Enforce a design decision for an edge case.
const args = ['---triple'];
const options = { };
const expected = {
values: { '__proto__': null, '-triple': true },
positionals: []
};
const result = parseArgs({ strict: false, args, options });
assert.deepStrictEqual(result, expected, Error('excess option dashes are retained'));
});
test('positional arguments are allowed by default in strict:false', () => {
const args = ['foo'];
const options = { };
const expected = {
values: { __proto__: null },
positionals: ['foo']
};
const result = parseArgs({ strict: false, args, options });
assert.deepStrictEqual(result, expected);
});
test('positional arguments may be explicitly disallowed in strict:false', () => {
const args = ['foo'];
const options = { };
assert.throws(() => { parseArgs({ strict: false, allowPositionals: false, args, options }); }, {
code: 'ERR_PARSE_ARGS_UNEXPECTED_POSITIONAL'
});
});
// Test bad inputs
test('invalid argument passed for options', () => {
const args = ['--so=wat'];
const options = 'bad value';
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_INVALID_ARG_TYPE'
});
});
test('type property missing for option then throw', () => {
const knownOptions = { foo: { } };
assert.throws(() => { parseArgs({ options: knownOptions }); }, {
code: 'ERR_INVALID_ARG_TYPE'
});
});
test('boolean passed to "type" option', () => {
const args = ['--so=wat'];
const options = { foo: { type: true } };
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_INVALID_ARG_TYPE'
});
});
test('invalid union value passed to "type" option', () => {
const args = ['--so=wat'];
const options = { foo: { type: 'str' } };
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_INVALID_ARG_TYPE'
});
});
// Test strict mode
test('unknown long option --bar', () => {
const args = ['--foo', '--bar'];
const options = { foo: { type: 'boolean' } };
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_PARSE_ARGS_UNKNOWN_OPTION'
});
});
test('unknown short option -b', () => {
const args = ['--foo', '-b'];
const options = { foo: { type: 'boolean' } };
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_PARSE_ARGS_UNKNOWN_OPTION'
});
});
test('unknown option -r in short option group -bar', () => {
const args = ['-bar'];
const options = { b: { type: 'boolean' }, a: { type: 'boolean' } };
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_PARSE_ARGS_UNKNOWN_OPTION'
});
});
test('unknown option with explicit value', () => {
const args = ['--foo', '--bar=baz'];
const options = { foo: { type: 'boolean' } };
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_PARSE_ARGS_UNKNOWN_OPTION'
});
});
test('unexpected positional', () => {
const args = ['foo'];
const options = { foo: { type: 'boolean' } };
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_PARSE_ARGS_UNEXPECTED_POSITIONAL'
});
});
test('unexpected positional after --', () => {
const args = ['--', 'foo'];
const options = { foo: { type: 'boolean' } };
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_PARSE_ARGS_UNEXPECTED_POSITIONAL'
});
});
test('-- by itself is not a positional', () => {
const args = ['--foo', '--'];
const options = { foo: { type: 'boolean' } };
const result = parseArgs({ args, options });
const expected = { values: { __proto__: null, foo: true },
positionals: [] };
assert.deepStrictEqual(result, expected);
});
test('string option used as boolean', () => {
const args = ['--foo'];
const options = { foo: { type: 'string' } };
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_PARSE_ARGS_INVALID_OPTION_VALUE'
});
});
test('boolean option used with value', () => {
const args = ['--foo=bar'];
const options = { foo: { type: 'boolean' } };
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_PARSE_ARGS_INVALID_OPTION_VALUE'
});
});
test('invalid short option length', () => {
const args = [];
const options = { foo: { short: 'fo', type: 'boolean' } };
assert.throws(() => { parseArgs({ args, options }); }, {
code: 'ERR_INVALID_ARG_VALUE'
});
});
test('null prototype: when no options then values.toString is undefined', () => {
const result = parseArgs({ args: [] });
assert.strictEqual(result.values.toString, undefined);
});
test('null prototype: when --toString then values.toString is true', () => {
const args = ['--toString'];
const options = { toString: { type: 'boolean' } };
const expectedResult = { values: { __proto__: null, toString: true }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expectedResult);
});
const candidateGreedyOptions = [
'',
'-',
'--',
'abc',
'123',
'-s',
'--foo',
];
candidateGreedyOptions.forEach((value) => {
test(`greedy: when short option with value '${value}' then eaten`, () => {
const args = ['-w', value];
const options = { with: { type: 'string', short: 'w' } };
const expectedResult = { values: { __proto__: null, with: value }, positionals: [] };
const result = parseArgs({ args, options, strict: false });
assert.deepStrictEqual(result, expectedResult);
});
test(`greedy: when long option with value '${value}' then eaten`, () => {
const args = ['--with', value];
const options = { with: { type: 'string', short: 'w' } };
const expectedResult = { values: { __proto__: null, with: value }, positionals: [] };
const result = parseArgs({ args, options, strict: false });
assert.deepStrictEqual(result, expectedResult);
});
});
test('strict: when candidate option value is plain text then does not throw', () => {
const args = ['--with', 'abc'];
const options = { with: { type: 'string' } };
const expectedResult = { values: { __proto__: null, with: 'abc' }, positionals: [] };
const result = parseArgs({ args, options, strict: true });
assert.deepStrictEqual(result, expectedResult);
});
test("strict: when candidate option value is '-' then does not throw", () => {
const args = ['--with', '-'];
const options = { with: { type: 'string' } };
const expectedResult = { values: { __proto__: null, with: '-' }, positionals: [] };
const result = parseArgs({ args, options, strict: true });
assert.deepStrictEqual(result, expectedResult);
});
test("strict: when candidate option value is '--' then throws", () => {
const args = ['--with', '--'];
const options = { with: { type: 'string' } };
assert.throws(() => {
parseArgs({ args, options });
}, {
code: 'ERR_PARSE_ARGS_INVALID_OPTION_VALUE'
});
});
test('strict: when candidate option value is short option then throws', () => {
const args = ['--with', '-a'];
const options = { with: { type: 'string' } };
assert.throws(() => {
parseArgs({ args, options });
}, {
code: 'ERR_PARSE_ARGS_INVALID_OPTION_VALUE'
});
});
test('strict: when candidate option value is short option digit then throws', () => {
const args = ['--with', '-1'];
const options = { with: { type: 'string' } };
assert.throws(() => {
parseArgs({ args, options });
}, {
code: 'ERR_PARSE_ARGS_INVALID_OPTION_VALUE'
});
});
test('strict: when candidate option value is long option then throws', () => {
const args = ['--with', '--foo'];
const options = { with: { type: 'string' } };
assert.throws(() => {
parseArgs({ args, options });
}, {
code: 'ERR_PARSE_ARGS_INVALID_OPTION_VALUE'
});
});
test('strict: when short option and suspect value then throws with short option in error message', () => {
const args = ['-w', '--foo'];
const options = { with: { type: 'string', short: 'w' } };
assert.throws(() => {
parseArgs({ args, options });
}, /for '-w'/
);
});
test('strict: when long option and suspect value then throws with long option in error message', () => {
const args = ['--with', '--foo'];
const options = { with: { type: 'string' } };
assert.throws(() => {
parseArgs({ args, options });
}, /for '--with'/
);
});
test('strict: when short option and suspect value then throws with whole expected message', () => {
const args = ['-w', '--foo'];
const options = { with: { type: 'string', short: 'w' } };
try {
parseArgs({ args, options });
} catch (err) {
console.info(err.message);
}
assert.throws(() => {
parseArgs({ args, options });
}, /To specify an option argument starting with a dash use '--with=-XYZ' or '-w-XYZ'/
);
});
test('strict: when long option and suspect value then throws with whole expected message', () => {
const args = ['--with', '--foo'];
const options = { with: { type: 'string', short: 'w' } };
assert.throws(() => {
parseArgs({ args, options });
}, /To specify an option argument starting with a dash use '--with=-XYZ'/
);
});
test('tokens: positional', () => {
const args = ['one'];
const expectedTokens = [
{ kind: 'positional', index: 0, value: 'one' },
];
const { tokens } = parseArgs({ strict: false, args, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: -- followed by option-like', () => {
const args = ['--', '--foo'];
const expectedTokens = [
{ kind: 'option-terminator', index: 0 },
{ kind: 'positional', index: 1, value: '--foo' },
];
const { tokens } = parseArgs({ strict: false, args, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:true boolean short', () => {
const args = ['-f'];
const options = {
file: { short: 'f', type: 'boolean' }
};
const expectedTokens = [
{ kind: 'option', name: 'file', rawName: '-f',
index: 0, value: undefined, inlineValue: undefined },
];
const { tokens } = parseArgs({ strict: true, args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:true boolean long', () => {
const args = ['--file'];
const options = {
file: { short: 'f', type: 'boolean' }
};
const expectedTokens = [
{ kind: 'option', name: 'file', rawName: '--file',
index: 0, value: undefined, inlineValue: undefined },
];
const { tokens } = parseArgs({ strict: true, args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:false boolean short', () => {
const args = ['-f'];
const expectedTokens = [
{ kind: 'option', name: 'f', rawName: '-f',
index: 0, value: undefined, inlineValue: undefined },
];
const { tokens } = parseArgs({ strict: false, args, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:false boolean long', () => {
const args = ['--file'];
const expectedTokens = [
{ kind: 'option', name: 'file', rawName: '--file',
index: 0, value: undefined, inlineValue: undefined },
];
const { tokens } = parseArgs({ strict: false, args, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:false boolean option group', () => {
const args = ['-ab'];
const expectedTokens = [
{ kind: 'option', name: 'a', rawName: '-a',
index: 0, value: undefined, inlineValue: undefined },
{ kind: 'option', name: 'b', rawName: '-b',
index: 0, value: undefined, inlineValue: undefined },
];
const { tokens } = parseArgs({ strict: false, args, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:false boolean option group with repeated option', () => {
// Also positional to check index correct after grouop
const args = ['-aa', 'pos'];
const expectedTokens = [
{ kind: 'option', name: 'a', rawName: '-a',
index: 0, value: undefined, inlineValue: undefined },
{ kind: 'option', name: 'a', rawName: '-a',
index: 0, value: undefined, inlineValue: undefined },
{ kind: 'positional', index: 1, value: 'pos' },
];
const { tokens } = parseArgs({ strict: false, allowPositionals: true, args, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:true string short with value after space', () => {
// Also positional to check index correct after out-of-line.
const args = ['-f', 'bar', 'ppp'];
const options = {
file: { short: 'f', type: 'string' }
};
const expectedTokens = [
{ kind: 'option', name: 'file', rawName: '-f',
index: 0, value: 'bar', inlineValue: false },
{ kind: 'positional', index: 2, value: 'ppp' },
];
const { tokens } = parseArgs({ strict: true, allowPositionals: true, args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:true string short with value inline', () => {
const args = ['-fBAR'];
const options = {
file: { short: 'f', type: 'string' }
};
const expectedTokens = [
{ kind: 'option', name: 'file', rawName: '-f',
index: 0, value: 'BAR', inlineValue: true },
];
const { tokens } = parseArgs({ strict: true, args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:false string short missing value', () => {
const args = ['-f'];
const options = {
file: { short: 'f', type: 'string' }
};
const expectedTokens = [
{ kind: 'option', name: 'file', rawName: '-f',
index: 0, value: undefined, inlineValue: undefined },
];
const { tokens } = parseArgs({ strict: false, args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:true string long with value after space', () => {
// Also positional to check index correct after out-of-line.
const args = ['--file', 'bar', 'ppp'];
const options = {
file: { short: 'f', type: 'string' }
};
const expectedTokens = [
{ kind: 'option', name: 'file', rawName: '--file',
index: 0, value: 'bar', inlineValue: false },
{ kind: 'positional', index: 2, value: 'ppp' },
];
const { tokens } = parseArgs({ strict: true, allowPositionals: true, args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:true string long with value inline', () => {
// Also positional to check index correct after out-of-line.
const args = ['--file=bar', 'pos'];
const options = {
file: { short: 'f', type: 'string' }
};
const expectedTokens = [
{ kind: 'option', name: 'file', rawName: '--file',
index: 0, value: 'bar', inlineValue: true },
{ kind: 'positional', index: 1, value: 'pos' },
];
const { tokens } = parseArgs({ strict: true, allowPositionals: true, args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:false string long with value inline', () => {
const args = ['--file=bar'];
const expectedTokens = [
{ kind: 'option', name: 'file', rawName: '--file',
index: 0, value: 'bar', inlineValue: true },
];
const { tokens } = parseArgs({ strict: false, args, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:false string long missing value', () => {
const args = ['--file'];
const options = {
file: { short: 'f', type: 'string' }
};
const expectedTokens = [
{ kind: 'option', name: 'file', rawName: '--file',
index: 0, value: undefined, inlineValue: undefined },
];
const { tokens } = parseArgs({ strict: false, args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:true complex option group with value after space', () => {
// Also positional to check index correct afterwards.
const args = ['-ab', 'c', 'pos'];
const options = {
alpha: { short: 'a', type: 'boolean' },
beta: { short: 'b', type: 'string' },
};
const expectedTokens = [
{ kind: 'option', name: 'alpha', rawName: '-a',
index: 0, value: undefined, inlineValue: undefined },
{ kind: 'option', name: 'beta', rawName: '-b',
index: 0, value: 'c', inlineValue: false },
{ kind: 'positional', index: 2, value: 'pos' },
];
const { tokens } = parseArgs({ strict: true, allowPositionals: true, args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:true complex option group with inline value', () => {
// Also positional to check index correct afterwards.
const args = ['-abc', 'pos'];
const options = {
alpha: { short: 'a', type: 'boolean' },
beta: { short: 'b', type: 'string' },
};
const expectedTokens = [
{ kind: 'option', name: 'alpha', rawName: '-a',
index: 0, value: undefined, inlineValue: undefined },
{ kind: 'option', name: 'beta', rawName: '-b',
index: 0, value: 'c', inlineValue: true },
{ kind: 'positional', index: 1, value: 'pos' },
];
const { tokens } = parseArgs({ strict: true, allowPositionals: true, args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:false with single dashes', () => {
const args = ['--file', '-', '-'];
const options = {
file: { short: 'f', type: 'string' },
};
const expectedTokens = [
{ kind: 'option', name: 'file', rawName: '--file',
index: 0, value: '-', inlineValue: false },
{ kind: 'positional', index: 2, value: '-' },
];
const { tokens } = parseArgs({ strict: false, args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens: strict:false with -- --', () => {
const args = ['--', '--'];
const expectedTokens = [
{ kind: 'option-terminator', index: 0 },
{ kind: 'positional', index: 1, value: '--' },
];
const { tokens } = parseArgs({ strict: false, args, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('default must be a boolean when option type is boolean', () => {
const args = [];
const options = { alpha: { type: 'boolean', default: 'not a boolean' } };
assert.throws(() => {
parseArgs({ args, options });
}, /"options\.alpha\.default" property must be of type boolean/
);
});
test('default must accept undefined value', () => {
const args = [];
const options = { alpha: { type: 'boolean', default: undefined } };
const result = parseArgs({ args, options });
const expected = {
values: {
__proto__: null,
},
positionals: []
};
assert.deepStrictEqual(result, expected);
});
test('default must be a boolean array when option type is boolean and multiple', () => {
const args = [];
const options = { alpha: { type: 'boolean', multiple: true, default: 'not an array' } };
assert.throws(() => {
parseArgs({ args, options });
}, /"options\.alpha\.default" property must be an instance of Array/
);
});
test('default must be a boolean array when option type is string and multiple is true', () => {
const args = [];
const options = { alpha: { type: 'boolean', multiple: true, default: [true, true, 42] } };
assert.throws(() => {
parseArgs({ args, options });
}, /"options\.alpha\.default\[2\]" property must be of type boolean/
);
});
test('default must be a string when option type is string', () => {
const args = [];
const options = { alpha: { type: 'string', default: true } };
assert.throws(() => {
parseArgs({ args, options });
}, /"options\.alpha\.default" property must be of type string/
);
});
test('default must be an array when option type is string and multiple is true', () => {
const args = [];
const options = { alpha: { type: 'string', multiple: true, default: 'not an array' } };
assert.throws(() => {
parseArgs({ args, options });
}, /"options\.alpha\.default" property must be an instance of Array/
);
});
test('default must be a string array when option type is string and multiple is true', () => {
const args = [];
const options = { alpha: { type: 'string', multiple: true, default: ['str', 42] } };
assert.throws(() => {
parseArgs({ args, options });
}, /"options\.alpha\.default\[1\]" property must be of type string/
);
});
test('default accepted input when multiple is true', () => {
const args = ['--inputStringArr', 'c', '--inputStringArr', 'd', '--inputBoolArr', '--inputBoolArr'];
const options = {
inputStringArr: { type: 'string', multiple: true, default: ['a', 'b'] },
emptyStringArr: { type: 'string', multiple: true, default: [] },
fullStringArr: { type: 'string', multiple: true, default: ['a', 'b'] },
inputBoolArr: { type: 'boolean', multiple: true, default: [false, true, false] },
emptyBoolArr: { type: 'boolean', multiple: true, default: [] },
fullBoolArr: { type: 'boolean', multiple: true, default: [false, true, false] },
};
const expected = { values: { __proto__: null,
inputStringArr: ['c', 'd'],
inputBoolArr: [true, true],
emptyStringArr: [],
fullStringArr: ['a', 'b'],
emptyBoolArr: [],
fullBoolArr: [false, true, false] },
positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected);
});
test('when default is set, the option must be added as result', () => {
const args = [];
const options = {
a: { type: 'string', default: 'HELLO' },
b: { type: 'boolean', default: false },
c: { type: 'boolean', default: true }
};
const expected = { values: { __proto__: null, a: 'HELLO', b: false, c: true }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected);
});
test('when default is set, the args value takes precedence', () => {
const args = ['--a', 'WORLD', '--b', '-c'];
const options = {
a: { type: 'string', default: 'HELLO' },
b: { type: 'boolean', default: false },
c: { type: 'boolean', default: true }
};
const expected = { values: { __proto__: null, a: 'WORLD', b: true, c: true }, positionals: [] };
const result = parseArgs({ args, options });
assert.deepStrictEqual(result, expected);
});
test('tokens should not include the default options', () => {
const args = [];
const options = {
a: { type: 'string', default: 'HELLO' },
b: { type: 'boolean', default: false },
c: { type: 'boolean', default: true }
};
const expectedTokens = [];
const { tokens } = parseArgs({ args, options, tokens: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('tokens:true should not include the default options after the args input', () => {
const args = ['--z', 'zero', 'positional-item'];
const options = {
z: { type: 'string' },
a: { type: 'string', default: 'HELLO' },
b: { type: 'boolean', default: false },
c: { type: 'boolean', default: true }
};
const expectedTokens = [
{ kind: 'option', name: 'z', rawName: '--z', index: 0, value: 'zero', inlineValue: false },
{ kind: 'positional', index: 2, value: 'positional-item' },
];
const { tokens } = parseArgs({ args, options, tokens: true, allowPositionals: true });
assert.deepStrictEqual(tokens, expectedTokens);
});
test('proto as default value must be ignored', () => {
const args = [];
const options = Object.create(null);
// eslint-disable-next-line no-proto
options.__proto__ = { type: 'string', default: 'HELLO' };
const result = parseArgs({ args, options, allowPositionals: true });
const expected = { values: { __proto__: null }, positionals: [] };
assert.deepStrictEqual(result, expected);
});
test('multiple as false should expect a String', () => {
const args = [];
const options = { alpha: { type: 'string', multiple: false, default: ['array'] } };
assert.throws(() => {
parseArgs({ args, options });
}, /"options\.alpha\.default" property must be of type string/
);
});