/
stylish.js
418 lines (358 loc) · 13.9 KB
/
stylish.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
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
/**
* @fileoverview Tests for options.
* @author Sindre Sorhus
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const assert = require("chai").assert,
chalk = require("chalk"),
proxyquire = require("proxyquire"),
sinon = require("sinon");
/*
* Chalk protects its methods so we need to inherit from it
* for Sinon to work.
*/
const chalkStub = Object.create(chalk, {
reset: {
value(str) {
return chalk.reset(str);
},
writable: true
},
yellow: {
value(str) {
return chalk.yellow(str);
},
writable: true
},
red: {
value(str) {
return chalk.red(str);
},
writable: true
}
});
chalkStub.yellow.bold = chalk.yellow.bold;
chalkStub.red.bold = chalk.red.bold;
const formatter = proxyquire("../../../../lib/cli-engine/formatters/stylish", { chalk: chalkStub });
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
describe("formatter:stylish", () => {
const originalColorLevel = chalk.level;
beforeEach(() => {
chalk.level = 0;
sinon.spy(chalkStub, "reset");
sinon.spy(chalkStub.yellow, "bold");
sinon.spy(chalkStub.red, "bold");
});
afterEach(() => {
sinon.verifyAndRestore();
chalk.level = originalColorLevel;
});
describe("when passed no messages", () => {
const code = [{
filePath: "foo.js",
messages: [],
errorCount: 0,
warningCount: 0
}];
it("should not return message", () => {
const result = formatter(code);
assert.strictEqual(result, "");
assert.strictEqual(chalkStub.reset.callCount, 0);
assert.strictEqual(chalkStub.yellow.bold.callCount, 0);
assert.strictEqual(chalkStub.red.bold.callCount, 0);
});
});
describe("when passed a single error message", () => {
const code = [{
filePath: "foo.js",
errorCount: 1,
warningCount: 0,
fixableErrorCount: 0,
fixableWarningCount: 0,
messages: [{
message: "Unexpected foo.",
severity: 2,
line: 5,
column: 10,
ruleId: "foo"
}]
}];
it("should return a string in the correct format", () => {
const result = formatter(code);
assert.strictEqual(result, "\nfoo.js\n 5:10 error Unexpected foo foo\n\n\u2716 1 problem (1 error, 0 warnings)\n");
assert.strictEqual(chalkStub.reset.callCount, 1);
assert.strictEqual(chalkStub.yellow.bold.callCount, 0);
assert.strictEqual(chalkStub.red.bold.callCount, 1);
});
describe("when the error is fixable", () => {
beforeEach(() => {
code[0].fixableErrorCount = 1;
});
it("should return a string in the correct format", () => {
const result = formatter(code);
assert.strictEqual(result, "\nfoo.js\n 5:10 error Unexpected foo foo\n\n\u2716 1 problem (1 error, 0 warnings)\n 1 error and 0 warnings potentially fixable with the `--fix` option.\n");
assert.strictEqual(chalkStub.reset.callCount, 1);
assert.strictEqual(chalkStub.yellow.bold.callCount, 0);
assert.strictEqual(chalkStub.red.bold.callCount, 2);
});
});
});
describe("when passed a single warning message", () => {
const code = [{
filePath: "foo.js",
errorCount: 0,
warningCount: 1,
fixableErrorCount: 0,
fixableWarningCount: 0,
messages: [{
message: "Unexpected foo.",
severity: 1,
line: 5,
column: 10,
ruleId: "foo"
}]
}];
it("should return a string in the correct format", () => {
const result = formatter(code);
assert.strictEqual(result, "\nfoo.js\n 5:10 warning Unexpected foo foo\n\n\u2716 1 problem (0 errors, 1 warning)\n");
assert.strictEqual(chalkStub.reset.callCount, 1);
assert.strictEqual(chalkStub.yellow.bold.callCount, 1);
assert.strictEqual(chalkStub.red.bold.callCount, 0);
});
describe("when the error is fixable", () => {
beforeEach(() => {
code[0].fixableWarningCount = 1;
});
it("should return a string in the correct format", () => {
const result = formatter(code);
assert.strictEqual(result, "\nfoo.js\n 5:10 warning Unexpected foo foo\n\n\u2716 1 problem (0 errors, 1 warning)\n 0 errors and 1 warning potentially fixable with the `--fix` option.\n");
assert.strictEqual(chalkStub.reset.callCount, 1);
assert.strictEqual(chalkStub.yellow.bold.callCount, 2);
assert.strictEqual(chalkStub.red.bold.callCount, 0);
});
});
});
describe("when passed a message that ends with ' .'", () => {
const code = [{
filePath: "foo.js",
errorCount: 0,
warningCount: 1,
fixableErrorCount: 0,
fixableWarningCount: 0,
messages: [{
message: "Unexpected .",
severity: 1,
line: 5,
column: 10,
ruleId: "foo"
}]
}];
it("should return a string in the correct format (retaining the ' .')", () => {
const result = formatter(code);
assert.strictEqual(result, "\nfoo.js\n 5:10 warning Unexpected . foo\n\n\u2716 1 problem (0 errors, 1 warning)\n");
assert.strictEqual(chalkStub.reset.callCount, 1);
assert.strictEqual(chalkStub.yellow.bold.callCount, 1);
assert.strictEqual(chalkStub.red.bold.callCount, 0);
});
});
describe("when passed a fatal error message", () => {
const code = [{
filePath: "foo.js",
errorCount: 1,
warningCount: 0,
messages: [{
fatal: true,
message: "Unexpected foo.",
line: 5,
column: 10,
ruleId: "foo"
}]
}];
it("should return a string in the correct format", () => {
const result = formatter(code);
assert.strictEqual(result, "\nfoo.js\n 5:10 error Unexpected foo foo\n\n\u2716 1 problem (1 error, 0 warnings)\n");
assert.strictEqual(chalkStub.reset.callCount, 1);
assert.strictEqual(chalkStub.yellow.bold.callCount, 0);
assert.strictEqual(chalkStub.red.bold.callCount, 1);
});
});
describe("when passed multiple messages", () => {
const code = [{
filePath: "foo.js",
errorCount: 1,
warningCount: 1,
messages: [{
message: "Unexpected foo.",
severity: 2,
line: 5,
column: 10,
ruleId: "foo"
}, {
message: "Unexpected bar.",
severity: 1,
line: 6,
column: 11,
ruleId: "bar"
}]
}];
it("should return a string with multiple entries", () => {
const result = formatter(code);
assert.strictEqual(result, "\nfoo.js\n 5:10 error Unexpected foo foo\n 6:11 warning Unexpected bar bar\n\n\u2716 2 problems (1 error, 1 warning)\n");
assert.strictEqual(chalkStub.reset.callCount, 1);
assert.strictEqual(chalkStub.yellow.bold.callCount, 0);
assert.strictEqual(chalkStub.red.bold.callCount, 1);
});
});
describe("when passed multiple files with 1 message each", () => {
const code = [{
filePath: "foo.js",
errorCount: 1,
warningCount: 0,
messages: [{
message: "Unexpected foo.",
severity: 2,
line: 5,
column: 10,
ruleId: "foo"
}]
}, {
errorCount: 0,
warningCount: 1,
filePath: "bar.js",
messages: [{
message: "Unexpected bar.",
severity: 1,
line: 6,
column: 11,
ruleId: "bar"
}]
}];
it("should return a string with multiple entries", () => {
const result = formatter(code);
assert.strictEqual(result, "\nfoo.js\n 5:10 error Unexpected foo foo\n\nbar.js\n 6:11 warning Unexpected bar bar\n\n\u2716 2 problems (1 error, 1 warning)\n");
assert.strictEqual(chalkStub.reset.callCount, 1);
assert.strictEqual(chalkStub.yellow.bold.callCount, 0);
assert.strictEqual(chalkStub.red.bold.callCount, 1);
});
it("should add errorCount", () => {
code.forEach(c => {
c.errorCount = 1;
c.warningCount = 0;
});
const result = formatter(code);
assert.strictEqual(result, "\nfoo.js\n 5:10 error Unexpected foo foo\n\nbar.js\n 6:11 warning Unexpected bar bar\n\n\u2716 2 problems (2 errors, 0 warnings)\n");
assert.strictEqual(chalkStub.reset.callCount, 1);
assert.strictEqual(chalkStub.yellow.bold.callCount, 0);
assert.strictEqual(chalkStub.red.bold.callCount, 1);
});
it("should add warningCount", () => {
code.forEach(c => {
c.errorCount = 0;
c.warningCount = 1;
});
const result = formatter(code);
assert.strictEqual(result, "\nfoo.js\n 5:10 error Unexpected foo foo\n\nbar.js\n 6:11 warning Unexpected bar bar\n\n\u2716 2 problems (0 errors, 2 warnings)\n");
assert.strictEqual(chalkStub.reset.callCount, 1);
assert.strictEqual(chalkStub.yellow.bold.callCount, 0);
assert.strictEqual(chalkStub.red.bold.callCount, 1);
});
});
describe("when passed one file not found message", () => {
const code = [{
filePath: "foo.js",
errorCount: 1,
warningCount: 0,
messages: [{
fatal: true,
message: "Couldn't find foo.js."
}]
}];
it("should return a string without line and column", () => {
const result = formatter(code);
assert.strictEqual(result, "\nfoo.js\n 0:0 error Couldn't find foo.js\n\n\u2716 1 problem (1 error, 0 warnings)\n");
assert.strictEqual(chalkStub.reset.callCount, 1);
assert.strictEqual(chalkStub.yellow.bold.callCount, 0);
assert.strictEqual(chalkStub.red.bold.callCount, 1);
});
});
describe("fixable problems", () => {
it("should not output fixable problems message when no errors or warnings are fixable", () => {
const code = [{
filePath: "foo.js",
errorCount: 1,
warningCount: 0,
fixableErrorCount: 0,
fixableWarningCount: 0,
messages: [{
message: "Unexpected foo.",
severity: 2,
line: 5,
column: 10,
ruleId: "foo"
}]
}];
const result = formatter(code);
assert.notInclude(result, "potentially fixable");
});
it("should output the fixable problems message when errors are fixable", () => {
const code = [{
filePath: "foo.js",
errorCount: 1,
warningCount: 0,
fixableErrorCount: 1,
fixableWarningCount: 0,
messages: [{
message: "Unexpected foo.",
severity: 2,
line: 5,
column: 10,
ruleId: "foo"
}]
}];
const result = formatter(code);
assert.include(result, " 1 error and 0 warnings potentially fixable with the `--fix` option.\n");
});
it("should output fixable problems message when warnings are fixable", () => {
const code = [{
filePath: "foo.js",
errorCount: 0,
warningCount: 3,
fixableErrorCount: 0,
fixableWarningCount: 2,
messages: [{
message: "Unexpected foo."
}]
}];
const result = formatter(code);
assert.include(result, " 0 errors and 2 warnings potentially fixable with the `--fix` option.\n");
});
it("should output the total number of fixable errors and warnings", () => {
const code = [{
filePath: "foo.js",
errorCount: 5,
warningCount: 3,
fixableErrorCount: 5,
fixableWarningCount: 2,
messages: [{
message: "Unexpected foo."
}]
}, {
filePath: "bar.js",
errorCount: 4,
warningCount: 2,
fixableErrorCount: 4,
fixableWarningCount: 1,
messages: [{
message: "Unexpected bar."
}]
}];
const result = formatter(code);
assert.include(result, " 9 errors and 3 warnings potentially fixable with the `--fix` option.\n");
});
});
});