forked from tj/commander.js
/
command.helpOption.test.js
133 lines (118 loc) · 4.21 KB
/
command.helpOption.test.js
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
const commander = require('../');
describe('helpOption', () => {
let writeSpy;
let writeErrorSpy;
beforeAll(() => {
// Optional. Suppress expected output to keep test output clean.
writeSpy = jest.spyOn(process.stdout, 'write').mockImplementation(() => { });
writeErrorSpy = jest.spyOn(process.stderr, 'write').mockImplementation(() => { });
});
afterEach(() => {
writeSpy.mockClear();
writeErrorSpy.mockClear();
});
afterAll(() => {
writeSpy.mockRestore();
writeErrorSpy.mockRestore();
});
test('when helpOption has custom flags then custom short flag invokes help', () => {
const program = new commander.Command();
program
.exitOverride()
.helpOption('-c,--custom-help', 'custom help output');
expect(() => {
program.parse(['-c'], { from: 'user' });
}).toThrow('(outputHelp)');
});
test('when helpOption has custom flags then custom long flag invokes help', () => {
const program = new commander.Command();
program
.exitOverride()
.helpOption('-c,--custom-help', 'custom help output');
expect(() => {
program.parse(['--custom-help'], { from: 'user' });
}).toThrow('(outputHelp)');
});
test('when helpOption has just custom short flag then custom short flag invokes help', () => {
const program = new commander.Command();
program
.exitOverride()
.helpOption('-c', 'custom help output');
expect(() => {
program.parse(['-c'], { from: 'user' });
}).toThrow('(outputHelp)');
});
test('when helpOption has just custom long flag then custom long flag invokes help', () => {
const program = new commander.Command();
program
.exitOverride()
.helpOption('--custom-help', 'custom help output');
expect(() => {
program.parse(['--custom-help'], { from: 'user' });
}).toThrow('(outputHelp)');
});
test('when helpOption has custom description then helpInformation include custom description', () => {
const program = new commander.Command();
program
.helpOption('-C,--custom-help', 'custom help output');
const helpInformation = program.helpInformation();
expect(helpInformation).toMatch(/-C,--custom-help +custom help output/);
});
test('when helpOption has just flags then helpInformation includes default description', () => {
const program = new commander.Command();
program
.helpOption('-C,--custom-help');
const helpInformation = program.helpInformation();
expect(helpInformation).toMatch(/-C,--custom-help +display help for command/);
});
test('when helpOption has just description then helpInformation includes default flags', () => {
const program = new commander.Command();
program
.helpOption(undefined, 'custom help output');
const helpInformation = program.helpInformation();
expect(helpInformation).toMatch(/-h, --help +custom help output/);
});
test('when helpOption(false) then helpInformation does not include --help', () => {
const program = new commander.Command();
program
.helpOption(false);
const helpInformation = program.helpInformation();
expect(helpInformation).not.toMatch('--help');
});
test('when helpOption(false) then --help is an unknown option', () => {
const program = new commander.Command();
program
.exitOverride()
.helpOption(false);
let caughtErr;
try {
program.parse(['--help'], { from: 'user' });
} catch (err) {
caughtErr = err;
}
expect(caughtErr.code).toBe('commander.unknownOption');
});
test('when helpOption(false) then -h is an unknown option', () => {
const program = new commander.Command();
program
.exitOverride()
.helpOption(false);
let caughtErr;
try {
program.parse(['-h'], { from: 'user' });
} catch (err) {
caughtErr = err;
}
expect(caughtErr.code).toBe('commander.unknownOption');
});
test('when helpOption(false) then unknown command error does not suggest --help', () => {
const program = new commander.Command();
program
.exitOverride()
.helpOption(false)
.command('foo');
expect(() => {
program.parse(['UNKNOWN'], { from: 'user' });
}).toThrow("error: unknown command 'UNKNOWN'");
});
});