/
max-lines-per-function.js
480 lines (431 loc) · 14.4 KB
/
max-lines-per-function.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
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
/**
* @fileoverview Tests for max-lines-per-function rule.
* @author Pete Ward <peteward44@gmail.com>
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const rule = require("../../../lib/rules/max-lines-per-function");
const { RuleTester } = require("../../../lib/rule-tester");
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
const ruleTester = new RuleTester({ parserOptions: { ecmaVersion: 6 } });
ruleTester.run("max-lines-per-function", rule, {
valid: [
// Test code in global scope doesn't count
{
code: "var x = 5;\nvar x = 2;\n",
options: [1]
},
// Test single line standalone function
{
code: "function name() {}",
options: [1]
},
// Test standalone function with lines of code
{
code: "function name() {\nvar x = 5;\nvar x = 2;\n}",
options: [4]
},
// Test inline arrow function
{
code: "const bar = () => 2",
options: [1]
},
// Test arrow function
{
code: "const bar = () => {\nconst x = 2 + 1;\nreturn x;\n}",
options: [4]
},
// skipBlankLines: false with simple standalone function
{
code: "function name() {\nvar x = 5;\n\t\n \n\nvar x = 2;\n}",
options: [{ max: 7, skipComments: false, skipBlankLines: false }]
},
// skipBlankLines: true with simple standalone function
{
code: "function name() {\nvar x = 5;\n\t\n \n\nvar x = 2;\n}",
options: [{ max: 4, skipComments: false, skipBlankLines: true }]
},
// skipComments: true with an individual single line comment
{
code: "function name() {\nvar x = 5;\nvar x = 2; // end of line comment\n}",
options: [{ max: 4, skipComments: true, skipBlankLines: false }]
},
// skipComments: true with an individual single line comment
{
code: "function name() {\nvar x = 5;\n// a comment on it's own line\nvar x = 2; // end of line comment\n}",
options: [{ max: 4, skipComments: true, skipBlankLines: false }]
},
// skipComments: true with single line comments
{
code: "function name() {\nvar x = 5;\n// a comment on it's own line\n// and another line comment\nvar x = 2; // end of line comment\n}",
options: [{ max: 4, skipComments: true, skipBlankLines: false }]
},
// skipComments: true test with multiple different comment types
{
code: "function name() {\nvar x = 5;\n/* a \n multi \n line \n comment \n*/\n\nvar x = 2; // end of line comment\n}",
options: [{ max: 5, skipComments: true, skipBlankLines: false }]
},
// skipComments: true with multiple different comment types, including trailing and leading whitespace
{
code: "function name() {\nvar x = 5;\n\t/* a comment with leading whitespace */\n/* a comment with trailing whitespace */\t\t\n\t/* a comment with trailing and leading whitespace */\t\t\n/* a \n multi \n line \n comment \n*/\t\t\n\nvar x = 2; // end of line comment\n}",
options: [{ max: 5, skipComments: true, skipBlankLines: false }]
},
// Multiple params on separate lines test
{
code: `function foo(
aaa = 1,
bbb = 2,
ccc = 3
) {
return aaa + bbb + ccc
}`,
options: [{ max: 7, skipComments: true, skipBlankLines: false }]
},
// IIFE validity test
{
code: `(
function
()
{
}
)
()`,
options: [{ max: 4, skipComments: true, skipBlankLines: false, IIFEs: true }]
},
// Nested function validity test
{
code: `function parent() {
var x = 0;
function nested() {
var y = 0;
x = 2;
}
if ( x === y ) {
x++;
}
}`,
options: [{ max: 10, skipComments: true, skipBlankLines: false }]
},
// Class method validity test
{
code: `class foo {
method() {
let y = 10;
let x = 20;
return y + x;
}
}`,
options: [{ max: 5, skipComments: true, skipBlankLines: false }]
},
// IIFEs should be recognised if IIFEs: true
{
code: `(function(){
let x = 0;
let y = 0;
let z = x + y;
let foo = {};
return bar;
}());`,
options: [{ max: 7, skipComments: true, skipBlankLines: false, IIFEs: true }]
},
// IIFEs should not be recognised if IIFEs: false
{
code: `(function(){
let x = 0;
let y = 0;
let z = x + y;
let foo = {};
return bar;
}());`,
options: [{ max: 2, skipComments: true, skipBlankLines: false, IIFEs: false }]
},
// Arrow IIFEs should be recognised if IIFEs: true
{
code: `(() => {
let x = 0;
let y = 0;
let z = x + y;
let foo = {};
return bar;
})();`,
options: [{ max: 7, skipComments: true, skipBlankLines: false, IIFEs: true }]
},
// Arrow IIFEs should not be recognised if IIFEs: false
{
code: `(() => {
let x = 0;
let y = 0;
let z = x + y;
let foo = {};
return bar;
})();`,
options: [{ max: 2, skipComments: true, skipBlankLines: false, IIFEs: false }]
}
],
invalid: [
// Test simple standalone function is recognised
{
code: "function name() {\n}",
options: [1],
errors: [
{ messageId: "exceed", data: { name: "Function 'name'", linesExceed: 1, maxLines: 1 } }
]
},
// Test anonymous function assigned to variable is recognised
{
code: "var func = function() {\n}",
options: [1],
errors: [
{ messageId: "exceed", data: { name: "Function", linesExceed: 1, maxLines: 1 } }
]
},
// Test arrow functions are recognised
{
code: "const bar = () => {\nconst x = 2 + 1;\nreturn x;\n}",
options: [3],
errors: [
{ messageId: "exceed", data: { name: "Arrow function", linesExceed: 1, maxLines: 3 } }
]
},
// Test inline arrow functions are recognised
{
code: "const bar = () =>\n 2",
options: [1],
errors: [
{ messageId: "exceed", data: { name: "Arrow function", linesExceed: 1, maxLines: 1 } }
]
},
// Test that option defaults work as expected
{
code: `() => {${"foo\n".repeat(60)}}`,
options: [{}],
errors: [
{ messageId: "exceed", data: { name: "Arrow function", linesExceed: 11, maxLines: 50 } }
]
},
// Test skipBlankLines: false
{
code: "function name() {\nvar x = 5;\n\t\n \n\nvar x = 2;\n}",
options: [{ max: 6, skipComments: false, skipBlankLines: false }],
errors: [
{ messageId: "exceed", data: { name: "Function 'name'", linesExceed: 1, maxLines: 6 } }
]
},
// Test skipBlankLines: false with CRLF line endings
{
code: "function name() {\r\nvar x = 5;\r\n\t\r\n \r\n\r\nvar x = 2;\r\n}",
options: [{ max: 6, skipComments: true, skipBlankLines: false }],
errors: [
{ messageId: "exceed", data: { name: "Function 'name'", linesExceed: 1, maxLines: 6 } }
]
},
// Test skipBlankLines: true
{
code: "function name() {\nvar x = 5;\n\t\n \n\nvar x = 2;\n}",
options: [{ max: 2, skipComments: true, skipBlankLines: true }],
errors: [
{ messageId: "exceed", data: { name: "Function 'name'", linesExceed: 2, maxLines: 2 } }
]
},
// Test skipBlankLines: true with CRLF line endings
{
code: "function name() {\r\nvar x = 5;\r\n\t\r\n \r\n\r\nvar x = 2;\r\n}",
options: [{ max: 2, skipComments: true, skipBlankLines: true }],
errors: [
{ messageId: "exceed", data: { name: "Function 'name'", linesExceed: 2, maxLines: 2 } }
]
},
// Test skipComments: true and skipBlankLines: false for multiple types of comment
{
code: "function name() { // end of line comment\nvar x = 5; /* mid line comment */\n\t// single line comment taking up whole line\n\t\n \n\nvar x = 2;\n}",
options: [{ max: 6, skipComments: true, skipBlankLines: false }],
errors: [
{ messageId: "exceed", data: { name: "Function 'name'", linesExceed: 1, maxLines: 6 } }
]
},
// Test skipComments: true and skipBlankLines: true for multiple types of comment
{
code: "function name() { // end of line comment\nvar x = 5; /* mid line comment */\n\t// single line comment taking up whole line\n\t\n \n\nvar x = 2;\n}",
options: [{ max: 1, skipComments: true, skipBlankLines: true }],
errors: [
{ messageId: "exceed", data: { name: "Function 'name'", linesExceed: 3, maxLines: 1 } }
]
},
// Test skipComments: false and skipBlankLines: true for multiple types of comment
{
code: "function name() { // end of line comment\nvar x = 5; /* mid line comment */\n\t// single line comment taking up whole line\n\t\n \n\nvar x = 2;\n}",
options: [{ max: 1, skipComments: false, skipBlankLines: true }],
errors: [
{ messageId: "exceed", data: { name: "Function 'name'", linesExceed: 4, maxLines: 1 } }
]
},
// Test simple standalone function with params on separate lines
{
code: `function foo(
aaa = 1,
bbb = 2,
ccc = 3
) {
return aaa + bbb + ccc
}`,
options: [{ max: 2, skipComments: true, skipBlankLines: false }],
errors: [
{ messageId: "exceed", data: { name: "Function 'foo'", linesExceed: 5, maxLines: 2 } }
]
},
// Test IIFE "function" keyword is included in the count
{
code: `(
function
()
{
}
)
()`,
options: [{ max: 2, skipComments: true, skipBlankLines: false, IIFEs: true }],
errors: [
{ messageId: "exceed", data: { name: "Function", linesExceed: 2, maxLines: 2 } }
]
},
// Test nested functions are included in it's parent's function count.
{
code: `function parent() {
var x = 0;
function nested() {
var y = 0;
x = 2;
}
if ( x === y ) {
x++;
}
}`,
options: [{ max: 9, skipComments: true, skipBlankLines: false }],
errors: [
{ messageId: "exceed", data: { name: "Function 'parent'", linesExceed: 1, maxLines: 9 } }
]
},
// Test nested functions are included in it's parent's function count.
{
code: `function parent() {
var x = 0;
function nested() {
var y = 0;
x = 2;
}
if ( x === y ) {
x++;
}
}`,
options: [{ max: 2, skipComments: true, skipBlankLines: false }],
errors: [
{ messageId: "exceed", data: { name: "Function 'parent'", linesExceed: 8, maxLines: 2 } },
{ messageId: "exceed", data: { name: "Function 'nested'", linesExceed: 2, maxLines: 2 } }
]
},
// Test regular methods are recognised
{
code: `class foo {
method() {
let y = 10;
let x = 20;
return y + x;
}
}`,
options: [{ max: 2, skipComments: true, skipBlankLines: false }],
errors: [
{ messageId: "exceed", data: { name: "Method 'method'", linesExceed: 3, maxLines: 2 } }
]
},
// Test static methods are recognised
{
code: `class A {
static
foo
(a) {
return a
}
}`,
options: [{ max: 2, skipComments: true, skipBlankLines: false }],
errors: [
{ messageId: "exceed", data: { name: "Static method 'foo'", linesExceed: 3, maxLines: 2 } }
]
},
// Test getters are recognised as properties
{
code: `var obj = {
get
foo
() {
return 1
}
}`,
options: [{ max: 2, skipComments: true, skipBlankLines: false }],
errors: [
{ messageId: "exceed", data: { name: "Getter 'foo'", linesExceed: 3, maxLines: 2 } }
]
},
// Test setters are recognised as properties
{
code: `var obj = {
set
foo
( val ) {
this._foo = val;
}
}`,
options: [{ max: 2, skipComments: true, skipBlankLines: false }],
errors: [
{ messageId: "exceed", data: { name: "Setter 'foo'", linesExceed: 3, maxLines: 2 } }
]
},
// Test computed property names
{
code: `class A {
static
[
foo +
bar
]
(a) {
return a
}
}`,
options: [{ max: 2, skipComments: true, skipBlankLines: false }],
errors: [
{ messageId: "exceed", data: { name: "Static method", linesExceed: 6, maxLines: 2 } }
]
},
// Test the IIFEs option includes IIFEs
{
code: `(function(){
let x = 0;
let y = 0;
let z = x + y;
let foo = {};
return bar;
}());`,
options: [{ max: 2, skipComments: true, skipBlankLines: false, IIFEs: true }],
errors: [
{ messageId: "exceed", data: { name: "Function", linesExceed: 5, maxLines: 2 } }
]
},
// Test the IIFEs option includes arrow IIFEs
{
code: `(() => {
let x = 0;
let y = 0;
let z = x + y;
let foo = {};
return bar;
})();`,
options: [{ max: 2, skipComments: true, skipBlankLines: false, IIFEs: true }],
errors: [
{ messageId: "exceed", data: { name: "Arrow function", linesExceed: 5, maxLines: 2 } }
]
}
]
});