forked from yargs/yargs
/
validation.cjs
1226 lines (1135 loc) · 34.4 KB
/
validation.cjs
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
995
996
997
998
999
1000
'use strict';
/* global describe, it, beforeEach */
/* eslint-disable no-unused-vars */
const checkUsage = require('./helpers/utils.cjs').checkOutput;
const expect = require('chai').expect;
const english = require('../locales/en.json');
let yargs = require('../index.cjs');
require('chai').should();
describe('validation tests', () => {
beforeEach(() => {
yargs.getInternalMethods().reset();
});
describe('implies', () => {
const implicationsFailedPattern = new RegExp(
english['Implications failed:']
);
it("fails if '_' populated, and implied argument not set", done => {
yargs(['cat'])
.implies({
1: 'foo', // 1 arg in _ means --foo is required
})
.fail(msg => {
msg.should.match(implicationsFailedPattern);
return done();
})
.parse();
});
it("fails if key implies values in '_', but '_' is not populated", done => {
yargs(['--foo'])
.boolean('foo')
.implies({
foo: 1, // --foo means 1 arg in _ is required
})
.fail(msg => {
msg.should.match(implicationsFailedPattern);
return done();
})
.parse();
});
it('fails if either implied argument is not set and displays only failed', done => {
yargs(['-f', '-b'])
.implies('f', ['b', 'c'])
.fail(msg1 => {
yargs(['-f', '-c'])
.implies('f', ['b', 'c'])
.fail(msg2 => {
msg1.should.match(/f -> c/);
msg1.should.not.match(/f -> b/);
msg2.should.match(/f -> b/);
msg2.should.not.match(/f -> c/);
return done();
})
.parse();
})
.parse();
});
it("fails if --no-foo's implied argument is not set", done => {
yargs([])
.implies({
'--no-bar': 'foo', // when --bar is not given, --foo is required
})
.fail(msg => {
msg.should.match(implicationsFailedPattern);
return done();
})
.parse();
});
it('fails if a key is set, along with a key that it implies should not be set', done => {
yargs(['--bar', '--foo'])
.implies({
bar: '--no-foo', // --bar means --foo cannot be given
})
.fail(msg => {
msg.should.match(implicationsFailedPattern);
return done();
})
.parse();
});
it('fails if implied key (with "no" in the name) is not set', () => {
let failCalled = false;
yargs('--bar')
.implies({
bar: 'noFoo', // --bar means --noFoo (or --no-foo with boolean-negation disabled) is required
// note that this has nothing to do with --foo
})
.fail(msg => {
failCalled = true;
msg.should.match(implicationsFailedPattern);
})
.parse();
failCalled.should.equal(true);
});
it("doesn't fail if implied key exists with value 0", () => {
yargs('--foo --bar 0')
.implies('foo', 'bar')
.fail(() => {
expect.fail();
})
.parse();
});
it("doesn't fail if implied key exists with value false", () => {
yargs('--foo --bar false')
.implies('foo', 'bar')
.fail(() => {
expect.fail();
})
.parse();
});
it('doesn\'t fail if implied key (with "no" in the name) is set', () => {
const argv = yargs('--bar --noFoo')
.implies({
bar: 'noFoo', // --bar means --noFoo (or --no-foo with boolean-negation disabled) is required
// note that this has nothing to do with --foo
})
.fail(() => {
expect.fail();
})
.parse();
expect(argv.bar).to.equal(true);
expect(argv.noFoo).to.equal(true);
expect(argv.foo).to.equal(undefined);
});
it('fails if implied key (with "no" in the name) is given when it should not', () => {
let failCalled = false;
yargs('--bar --noFoo')
.implies({
bar: '--no-noFoo', // --bar means --noFoo (or --no-foo with boolean-negation disabled) cannot be given
// note that this has nothing to do with --foo
})
.fail(msg => {
failCalled = true;
msg.should.match(implicationsFailedPattern);
})
.parse();
failCalled.should.equal(true);
});
it('doesn\'t fail if implied key (with "no" in the name) that should not be given is not set', () => {
const argv = yargs('--bar')
.implies({
bar: '--no-noFoo', // --bar means --noFoo (or --no-foo with boolean-negation disabled) cannot be given
// note that this has nothing to do with --foo
})
.fail(() => {
expect.fail();
})
.parse();
expect(argv.bar).to.equal(true);
expect(argv.noFoo).to.equal(undefined);
expect(argv.foo).to.equal(undefined);
});
it('allows key to be specified with option shorthand', done => {
yargs('--bar')
.option('bar', {
implies: 'foo',
})
.fail(msg => {
msg.should.match(implicationsFailedPattern);
return done();
})
.parse();
});
});
describe('conflicts', () => {
it('fails if both arguments are supplied', done => {
yargs(['-f', '-b'])
.conflicts('f', 'b')
.fail(msg => {
msg.should.equal('Arguments f and b are mutually exclusive');
return done();
})
.parse();
});
it('fails if argument is supplied along with either conflicting argument', done => {
yargs(['-f', '-b'])
.conflicts('f', ['b', 'c'])
.fail(msg1 => {
yargs(['-f', '-c'])
.conflicts('f', ['b', 'c'])
.fail(msg2 => {
msg1.should.equal('Arguments f and b are mutually exclusive');
msg2.should.equal('Arguments f and c are mutually exclusive');
return done();
})
.parse();
})
.parse();
});
it('should not fail if no conflicting arguments are provided', () => {
yargs(['-b', '-c'])
.conflicts('f', ['b', 'c'])
.fail(msg => {
expect.fail();
})
.parse();
});
it('should not fail if argument with conflict is provided, but not the argument it conflicts with', () => {
yargs(['command', '-f', '-c'])
.command('command')
.option('f', {
describe: 'a foo',
})
.option('b', {
describe: 'a bar',
})
.conflicts('f', 'b')
.fail(msg => {
expect.fail();
})
.parse();
});
it('should not fail if conflicting argument is provided, without argument with conflict', () => {
yargs(['command', '-b', '-c'])
.command('command')
.option('f', {
describe: 'a foo',
})
.option('b', {
describe: 'a bar',
})
.conflicts('f', 'b')
.fail(msg => {
expect.fail();
})
.parse();
});
it('allows an object to be provided defining conflicting option pairs', done => {
yargs(['-t', '-s'])
.conflicts({
c: 'a',
s: 't',
})
.fail(msg => {
msg.should.equal('Arguments s and t are mutually exclusive');
return done();
})
.parse();
});
it('takes into account aliases when applying conflicts logic', done => {
yargs(['-t', '-c'])
.conflicts({
c: 'a',
s: 't',
})
.alias('c', 's')
.fail(msg => {
msg.should.equal('Arguments s and t are mutually exclusive');
return done();
})
.parse();
});
it('allows key to be specified with option shorthand', done => {
yargs(['-f', '-b'])
.option('f', {
conflicts: 'b',
})
.fail(msg => {
msg.should.equal('Arguments f and b are mutually exclusive');
return done();
})
.parse();
});
it('should fail if alias of conflicting argument is provided', done => {
yargs(['-f', '--batman=99'])
.conflicts('f', 'b')
.alias('b', 'batman')
.fail(msg => {
msg.should.equal('Arguments f and b are mutually exclusive');
return done();
})
.parse();
});
it('should fail if alias of argument with conflict is provided', done => {
yargs(['--foo', '-b'])
.conflicts('f', 'b')
.alias('foo', 'f')
.fail(msg => {
msg.should.equal('Arguments f and b are mutually exclusive');
return done();
})
.parse();
});
function loadLocale(locale) {
delete require.cache[require.resolve('../')];
yargs = require('../');
process.env.LC_ALL = locale;
}
it('should use appropriate translation', done => {
loadLocale('pirate');
try {
yargs(['-f', '-b'])
.conflicts('f', 'b')
.fail(msg => {
msg.should.equal(
'Yon scurvy dogs f and b be as bad as rum and a prudish wench'
);
return done();
})
.parse();
} finally {
loadLocale('en_US.UTF-8');
}
});
});
describe('demand', () => {
it('fails with standard error message if msg is not defined', done => {
yargs([])
.demand(1)
.fail(msg => {
msg.should.equal(
'Not enough non-option arguments: got 0, need at least 1'
);
return done();
})
.parse();
expect.fail('no parsing failure');
});
// addresses: https://github.com/yargs/yargs/issues/1861
it('fails in strict mode when no commands defined but command is passed', done => {
yargs
.strict()
.fail(msg => {
msg.should.equal('Unknown argument: foo');
done();
})
.parse('foo');
expect.fail('no parsing failure');
});
it('fails because of undefined command and not because of argument after --', done => {
yargs
.strict()
.fail(msg => {
msg.should.equal('Unknown argument: foo');
done();
})
.parse('foo -- hello');
expect.fail('no parsing failure');
});
it('fails in strict mode with invalid command', done => {
yargs(['koala'])
.command('wombat', 'wombat burrows')
.command('kangaroo', 'kangaroo handlers')
.demand(1)
.strict()
.fail(msg => {
msg.should.equal('Unknown argument: koala');
return done();
})
.parse();
expect.fail('no parsing failure');
});
it('fails in strict mode with extra positionals', done => {
yargs(['kangaroo', 'jumping', 'fast'])
.command('kangaroo <status>', 'kangaroo handlers')
.strict()
.fail(msg => {
msg.should.equal('Unknown argument: fast');
return done();
})
.parse();
expect.fail('no parsing failure');
});
it('fails in strict mode with extra positionals for default command', done => {
yargs(['jumping', 'fast'])
.command('$0 <status>', 'kangaroo handlers')
.strict()
.fail(msg => {
msg.should.equal('Unknown argument: fast');
return done();
})
.parse();
expect.fail('no parsing failure');
});
it('does not fail in strict mode when no commands configured', () => {
const argv = yargs('koala')
.demand(1)
.strict()
.fail(msg => {
expect.fail();
})
.parse();
argv._[0].should.equal('koala');
});
// addresses: https://github.com/yargs/yargs/issues/791
it('should recognize context variables in strict mode', done => {
yargs()
.command('foo <y>')
.strict()
.parse('foo 99', {x: 33}, (err, argv, output) => {
expect(err).to.equal(null);
expect(output).to.equal('');
argv.y.should.equal(99);
argv.x.should.equal(33);
argv._.should.include('foo');
return done();
});
});
// addresses: https://github.com/yargs/yargs/issues/791
it('should recognize context variables in strict mode, when running sub-commands', done => {
yargs()
.command('request', 'request command', yargs => {
yargs.command('get', 'sub-command').option('y', {
describe: 'y inner option',
});
})
.strict()
.parse('request get --y=22', {x: 33}, (err, argv, output) => {
expect(err).to.equal(null);
expect(output).to.equal('');
argv.y.should.equal(22);
argv.x.should.equal(33);
argv._.should.include('request');
argv._.should.include('get');
return done();
});
});
it('fails when a required argument is missing', done => {
yargs('-w 10 marsupial')
.demand(1, ['w', 'b'])
.fail(msg => {
msg.should.equal('Missing required argument: b');
return done();
})
.parse();
});
it('fails when required arguments are present, but a command is missing', done => {
yargs('-w 10 -m wombat')
.demand(1, ['w', 'm'])
.fail(msg => {
msg.should.equal(
'Not enough non-option arguments: got 0, need at least 1'
);
return done();
})
.parse();
});
it('fails without a message if msg is null', done => {
yargs([])
.demand(1, null)
.fail(msg => {
expect(msg).to.equal(null);
return done();
})
.parse();
});
// address regression in: https://github.com/yargs/yargs/pull/740
it('custom failure message should be printed for both min and max constraints', done => {
yargs(['foo'])
.demand(0, 0, 'hey! give me a custom exit message')
.fail(msg => {
expect(msg).to.equal('hey! give me a custom exit message');
return done();
})
.parse();
});
it('interprets min relative to command', () => {
let failureMsg;
yargs('lint')
.command('lint', 'Lint a file', yargs => {
yargs.demand(1).fail(msg => {
failureMsg = msg;
});
})
.parse();
expect(failureMsg).to.equal(
'Not enough non-option arguments: got 0, need at least 1'
);
});
it('interprets max relative to command', () => {
let failureMsg;
yargs('lint one.js two.js')
.command('lint', 'Lint a file', yargs => {
yargs.demand(0, 1).fail(msg => {
failureMsg = msg;
});
})
.parse();
expect(failureMsg).to.equal(
'Too many non-option arguments: got 2, maximum of 1'
);
});
});
describe('requiresArg', () => {
it('fails when a required argument value of type number is missing', done => {
yargs()
.option('w', {type: 'number', requiresArg: true})
.parse('-w', (err, argv, output) => {
expect(err).to.not.equal(undefined);
expect(err).to.have.property(
'message',
'Not enough arguments following: w'
);
return done();
});
});
it('fails when a required argument value of type string is missing', done => {
yargs()
.option('w', {type: 'string', requiresArg: true})
.parse('-w', (err, argv, output) => {
expect(err).to.not.equal(undefined);
expect(err).to.have.property(
'message',
'Not enough arguments following: w'
);
return done();
});
});
it('fails when a required argument value of type boolean is missing', done => {
yargs()
.option('w', {type: 'boolean', requiresArg: true})
.parse('-w', (err, argv, output) => {
expect(err).to.not.equal(undefined);
expect(err).to.have.property(
'message',
'Not enough arguments following: w'
);
return done();
});
});
it('fails when a required argument value of type array is missing', done => {
yargs()
.option('w', {type: 'array', requiresArg: true})
.parse('-w', (err, argv, output) => {
expect(err).to.not.equal(undefined);
expect(err).to.have.property(
'message',
'Not enough arguments following: w'
);
return done();
});
});
// see: https://github.com/yargs/yargs/issues/1041
it('does not fail if argument with required value is not provided', done => {
yargs()
.option('w', {type: 'number', requiresArg: true})
.command('woo')
.parse('', (err, argv, output) => {
expect(err).to.equal(null);
return done();
});
});
it('does not fail if argument with required value is not provided to subcommand', done => {
yargs()
.option('w', {type: 'number', requiresArg: true})
.command('woo')
.parse('woo', (err, argv, output) => {
expect(err).to.equal(null);
return done();
});
});
});
describe('choices', () => {
it('fails with one invalid value', done => {
yargs(['--state', 'denial'])
.choices('state', ['happy', 'sad', 'hungry'])
.fail(msg => {
msg
.split('\n')
.should.deep.equal([
'Invalid values:',
' Argument: state, Given: "denial", Choices: "happy", "sad", "hungry"',
]);
return done();
})
.parse();
});
it('fails with one valid and one invalid value', done => {
yargs(['--characters', 'susie', '--characters', 'linus'])
.choices('characters', ['calvin', 'hobbes', 'susie', 'moe'])
.fail(msg => {
msg
.split('\n')
.should.deep.equal([
'Invalid values:',
' Argument: characters, Given: "linus", Choices: "calvin", "hobbes", "susie", "moe"',
]);
return done();
})
.parse();
});
it('fails with multiple invalid values for same argument', done => {
yargs(['--category', 'comedy', '--category', 'drama'])
.choices('category', ['animal', 'vegetable', 'mineral'])
.fail(msg => {
msg
.split('\n')
.should.deep.equal([
'Invalid values:',
' Argument: category, Given: "comedy", "drama", Choices: "animal", "vegetable", "mineral"',
]);
return done();
})
.parse();
});
it('fails with case-insensitive value', done => {
yargs(['--env', 'DEV'])
.choices('env', ['dev', 'prd'])
.fail(msg => {
msg
.split('\n')
.should.deep.equal([
'Invalid values:',
' Argument: env, Given: "DEV", Choices: "dev", "prd"',
]);
return done();
})
.parse();
});
it('fails with multiple invalid arguments', done => {
yargs(['--system', 'osx', '--arch', '64'])
.choices('system', ['linux', 'mac', 'windows'])
.choices('arch', ['x86', 'x64', 'arm'])
.fail(msg => {
msg
.split('\n')
.should.deep.equal([
'Invalid values:',
' Argument: system, Given: "osx", Choices: "linux", "mac", "windows"',
' Argument: arch, Given: 64, Choices: "x86", "x64", "arm"',
]);
return done();
})
.parse();
});
// addresses: https://github.com/yargs/yargs/issues/849
it('succeeds when demandOption is true and valid choice is provided', done => {
yargs('one -a 10 marsupial')
.command(
'one',
'level one',
yargs => {
yargs.options({
a: {
demandOption: true,
choices: [10, 20],
},
});
},
argv => {
argv._[0].should.equal('one');
argv.a.should.equal(10);
return done();
}
)
.fail(msg => {
expect.fail();
})
.parse();
});
// addresses: https://github.com/yargs/yargs/issues/849
it('fails when demandOption is true and choice is not provided', done => {
yargs('one -a 10 marsupial')
.command(
'one',
'level one',
yargs => {
yargs
.options({
c: {
choices: ['1', '2'],
},
})
.demandOption('c');
},
argv => {
expect.fail();
}
)
.fail(msg => {
msg.should.equal('Missing required argument: c');
return done();
})
.parse();
});
// addresses: https://github.com/yargs/yargs/issues/849
it('succeeds when demandOption is false and no choice is provided', () => {
yargs('one')
.command(
'one',
'level one',
yargs => {
yargs.options({
a: {
demandOption: false,
choices: [10, 20],
},
});
},
argv => {
argv._[0].should.equal('one');
}
)
.fail(msg => {
expect.fail();
})
.parse();
});
// addresses: https://github.com/yargs/yargs/issues/849
it('succeeds when demandOption is not provided and no choice is provided', () => {
yargs('one')
.command(
'one',
'level one',
yargs => {
yargs.options({
a: {
choices: [10, 20],
},
});
},
argv => {
argv._[0].should.equal('one');
}
)
.fail(msg => {
expect.fail();
})
.parse();
});
});
describe('config', () => {
it('should raise an appropriate error if JSON file is not found', done => {
yargs(['--settings', 'fake.json', '--foo', 'bar'])
.alias('z', 'zoom')
.config('settings')
.fail(msg => {
msg.should.eql('Invalid JSON config file: fake.json');
return done();
})
.parse();
});
// see: https://github.com/yargs/yargs/issues/172
it('should not raise an exception if config file is set as default argument value', () => {
let fail = false;
yargs([])
.option('config', {
default: 'foo.json',
})
.config('config')
.fail(() => {
fail = true;
})
.parse();
fail.should.equal(false);
});
it('should be displayed in the help message', () => {
const r = checkUsage(() =>
yargs(['--help'])
.config('settings')
.help('help')
.version(false)
.wrap(null)
.parse()
);
r.should.have.property('logs').with.length(1);
r.logs
.join('\n')
.split(/\n+/)
.should.deep.equal([
'Options:',
' --settings Path to JSON config file',
' --help Show help [boolean]',
]);
});
it('should be displayed in the help message with its default name', () => {
const checkUsage = require('./helpers/utils.cjs').checkOutput;
const r = checkUsage(() =>
yargs(['--help'])
.config()
.help('help')
.version(false)
.wrap(null)
.parse()
);
r.should.have.property('logs').with.length(1);
r.logs
.join('\n')
.split(/\n+/)
.should.deep.equal([
'Options:',
' --config Path to JSON config file',
' --help Show help [boolean]',
]);
});
it('should allow help message to be overridden', () => {
const checkUsage = require('./helpers/utils.cjs').checkOutput;
const r = checkUsage(() =>
yargs(['--help'])
.config('settings', 'pork chop sandwiches')
.help('help')
.version(false)
.wrap(null)
.parse()
);
r.should.have.property('logs').with.length(1);
r.logs
.join('\n')
.split(/\n+/)
.should.deep.equal([
'Options:',
' --settings pork chop sandwiches',
' --help Show help [boolean]',
]);
});
it('outputs an error returned by the parsing function', () => {
const checkUsage = require('./helpers/utils.cjs').checkOutput;
const r = checkUsage(() =>
yargs(['--settings=./package.json'])
.config('settings', 'path to config file', configPath =>
Error('someone set us up the bomb')
)
.help('help')
.wrap(null)
.parse()
);
r.errors
.join('\n')
.split(/\n+/)
.should.deep.equal([
'Options:',
' --version Show version number [boolean]',
' --settings path to config file',
' --help Show help [boolean]',
'someone set us up the bomb',
]);
});
it('outputs an error if thrown by the parsing function', () => {
const checkUsage = require('./helpers/utils.cjs').checkOutput;
const r = checkUsage(() =>
yargs(['--settings=./package.json'])
.config('settings', 'path to config file', configPath => {
throw Error('someone set us up the bomb');
})
.wrap(null)
.parse()
);
r.errors
.join('\n')
.split(/\n+/)
.should.deep.equal([
'Options:',
' --help Show help [boolean]',
' --version Show version number [boolean]',
' --settings path to config file',
'someone set us up the bomb',
]);
});
});
describe('defaults', () => {
// See https://github.com/chevex/yargs/issues/31
it('should not fail when demanded options with defaults are missing', () => {
yargs()
.fail(msg => {
throw new Error(msg);
})
.option('some-option', {
describe: 'some option',
demand: true,
default: 88,
})
.strict()
.parse([]);
});
});
describe('strict mode', () => {
it('does not fail when command with subcommands called', () => {
yargs('one')
.command(
'one',
'level one',
yargs =>
yargs
.command('twoA', 'level two A')
.command('twoB', 'level two B')
.strict()
.fail(msg => {
expect.fail();
}),
argv => {
argv._[0].should.equal('one');
}
)
.parse();
});
it('does not fail for hidden options', () => {
const args = yargs('--foo')
.strict()
.option('foo', {boolean: true, describe: false})
.fail(msg => {
expect.fail();
})
.parse();
args.foo.should.equal(true);
});
it('does not fail for hidden options but does for unknown arguments', () => {
const args = yargs('--foo hey')
.strict()
.option('foo', {boolean: true, describe: false})
.fail(msg => {
msg.should.equal('Unknown argument: hey');
})
.parse();
});
it('does not fail if an alias is provided, rather than option itself', () => {
const args = yargs('--cat')
.strict()
.option('foo', {boolean: true, describe: false})
.alias('foo', 'bar')
.alias('bar', 'cat')
.fail(msg => {
expect.fail();
})
.parse();
args.cat.should.equal(true);
args.foo.should.equal(true);
args.bar.should.equal(true);
});
it('does not fail when unrecognized option is passed after --', () => {
const args = yargs('ahoy ben -- --arrr')
.strict()
.command('ahoy <matey>', 'piratical courtesy')
.option('arrr', {boolean: true, describe: false})
.fail(msg => {
expect.fail(msg);
})
.parse();
args.matey.should.equal('ben');