forked from protofire/solhint
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathalign-rules.js
442 lines (345 loc) · 17.3 KB
/
align-rules.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
const assert = require('assert');
const { assertErrorMessage, assertNoErrors, assertErrorCount } = require('./common/asserts');
const { noIndent } = require('./common/configs');
const linter = require('./../lib/index');
const { funcWith, contractWith, multiLine } = require('./common/contract-builder');
const _ = require('lodash');
describe('Linter', function () {
describe('Align Rules', function () {
it('should raise error when contract do not surrounds with two blank lines', function () {
const code = `
contract A {}
contract B {}
`;
const report = linter.processStr(code, noIndent());
assert.equal(report.errorCount, 2);
assertErrorMessage(report, 0, 'two blank');
});
it('should not raise error when contract do not surrounds with two blank lines', function () {
const code = `
contract A {}
contract B {}
contract C {}
`;
const report = linter.processStr(code, noIndent());
assertNoErrors(report);
});
it('should raise error about mixed tabs and spaces', function () {
const code = ' \t import "lib.sol";';
const report = linter.processStr(code, noIndent());
assert.equal(report.errorCount, 1);
assertErrorMessage(report, 0, 'Mixed tabs and spaces');
});
it('should raise error when line indent is incorrect', function () {
const code = '\t\timport "lib.sol";';
const report = linter.processStr(code, {rules: { indent:['error', 'tabs'] } });
assert.equal(report.errorCount, 1);
assertErrorMessage(report, 0, 'indent');
});
it('should raise error when line indent is incorrect', function () {
const code = '\t\timport "lib.sol";';
const report = linter.processStr(code, {rules: { indent:['error', 'tabs'] } });
assert.equal(report.errorCount, 1);
assertErrorMessage(report, 0, 'indent');
});
it('should raise error when line indent is incorrect', function () {
const code = multiLine(
' contract A { ',
' uint private a; ',
' } '
);
const report = linter.processStr(code);
assert.equal(report.errorCount, 3);
assertErrorMessage(report, 0, '0');
assertErrorMessage(report, 1, '4');
assertErrorMessage(report, 2, '0');
});
it('should raise error when line indent is incorrect for function', function () {
const code = multiLine(
' contract A { ',
' uint private a; ',
' function A() private { ',
' } ',
' } '
);
const report = linter.processStr(code, {rules:
{'separate-by-one-line-in-contract': false, 'no-empty-blocks': false}
});
assert.equal(report.errorCount, 5);
assertErrorMessage(report, 0, 'Expected indentation of 0');
assertErrorMessage(report, 1, 'Expected indentation of 4');
assertErrorMessage(report, 2, 'Expected indentation of 4');
assertErrorMessage(report, 3, 'Expected indentation of 4');
assertErrorMessage(report, 4, 'Expected indentation of 0');
});
it('should raise error when line indent is incorrect for function with for loop', function () {
const code = multiLine(' ', // 1
' contract A { ', // 2
' uint private a; ', // 3
' function A() private { ', // 4
' for (uint a; a < b; a += 1) ', // 5
' break; ', // 6
' } ', // 7
' } ' // 8
);
const report = linter.processStr(code, {rules: {'separate-by-one-line-in-contract': false}});
assert.equal(report.errorCount, 6);
assertErrorMessage(report, 0, 'Expected indentation of 0');
assertErrorMessage(report, 1, 'Expected indentation of 4');
assertErrorMessage(report, 2, 'Expected indentation of 4');
assertErrorMessage(report, 3, 'Expected indentation of 8');
assertErrorMessage(report, 4, 'Expected indentation of 4');
assertErrorMessage(report, 5, 'Expected indentation of 0 spaces');
});
it('should raise error when line indent is incorrect for function with for while loop', function () {
const code = multiLine(' ', // 1
' contract A { ', // 2
' uint private a; ', // 3
' function A() private { ', // 4
' while (a < b) ', // 5
' return; ', // 6
' } ', // 7
' } ' // 8
);
const report = linter.processStr(code, {rules: {'separate-by-one-line-in-contract': false}});
assert.equal(report.errorCount, 7);
assertErrorMessage(report, 0, 'Expected indentation of 0 spaces');
assertErrorMessage(report, 1, 'Expected indentation of 4');
assertErrorMessage(report, 2, 'Expected indentation of 4');
assertErrorMessage(report, 3, 'Expected indentation of 8');
assertErrorMessage(report, 4, 'Expected indentation of 12');
assertErrorMessage(report, 5, 'Expected indentation of 4');
assertErrorMessage(report, 6, 'Expected indentation of 0');
});
it('should raise error when line indent is incorrect for function with for if statement', function () {
const code = multiLine(' ', // 1
' contract A { ', // 2
' uint private a; ', // 3
' function A() private { ', // 4
' if (a < b) { ', // 5
' a += 1; ', // 6
' b -= 1; ', // 7
' continue; ', // 8
' } ', // 9
' } ', // 10
' } ' // 11
);
const report = linter.processStr(code, {rules: {'separate-by-one-line-in-contract': false}});
assert.equal(report.errorCount, 7);
assertErrorMessage(report, 0, 'Expected indentation of 0 spaces');
assertErrorMessage(report, 1, 'Expected indentation of 4');
assertErrorMessage(report, 2, 'Expected indentation of 4');
assertErrorMessage(report, 3, 'Expected indentation of 8');
assertErrorMessage(report, 4, 'Expected indentation of 12');
assertErrorMessage(report, 5, 'Expected indentation of 4');
assertErrorMessage(report, 6, 'Expected indentation of 0');
});
it('should not raise error when line indent is correct for function with for if-else statement', function () {
const code = multiLine(' ', // 1
'contract A { ', // 2
' function A() private { ', // 3
' if (a < b) { ', // 4
' a += 1; ', // 5
' } else { ', // 6
' b -= 1; ', // 7
' } ', // 8
' } ', // 9
'} ' // 10
);
const report = linter.processStr(code, {rules: {'separate-by-one-line-in-contract': false}});
assertNoErrors(report);
});
it('should raise error when line indent is not correct for function with for assembly statement', function () {
const code = multiLine(' ', // 1
'contract A { ', // 2
' function A() private { ', // 3
' assembly { ', // 4
' {} ', // 5
' } ', // 6
' } ', // 7
'} ' // 8
);
const report = linter.processStr(code, {rules:
{'separate-by-one-line-in-contract': false, 'no-empty-blocks': false, 'no-inline-assembly': false}
});
assert.equal(report.errorCount, 1);
assertErrorMessage(report, 0, 'Indentation is incorrect');
});
it('should not raise error when line indent is correct for function with for if-else statement', function () {
const code = multiLine(' ', // 1
'contract A { ', // 2
' function A() private { ', // 3
' if ( ', // 4
' a < b ', // 5
' ) { ', // 6
' a += 1; ', // 7
' } else { ', // 8
' b -= 1; ', // 9
' } ', // 10
' } ', // 11
'} ' // 12
);
const report = linter.processStr(code, {rules: {'separate-by-one-line-in-contract': false}});
assertNoErrors(report);
});
it('should not raise error for custom configured indent rules', function () {
const code = multiLine('',
'contract A { ',
'\tuint private a = 0; ',
'\tfunction A() { ',
'\t\t\tuint a = 5; ',
'\t} ',
'} '
);
const report = linter.processStr(code, {
rules: {
indent: ['warn', 'tabs'],
'func-visibility': false,
'separate-by-one-line-in-contract': false,
'no-unused-vars': false
}
});
assert.equal(report.warningCount, 1);
assertErrorMessage(report, 0, 'Expected indentation of 2 tabs');
});
it('should raise error when bracket incorrect aligned', function () {
const code = funcWith(`
for (uint i = 0; i < a; i += 1)
{
continue;
}
`);
const report = linter.processStr(code, noIndent());
assert.equal(report.errorCount, 1);
assertErrorMessage(report, 0, 'Open bracket');
});
it('should not raise error when function bracket correct aligned', function () {
const code = contractWith(`
function a (
uint a
)
public
{
continue;
}
`);
const report = linter.processStr(code, noIndent());
assertNoErrors(report);
});
it('should raise error when function bracket incorrect aligned', function () {
const code = contractWith(`
function a (uint a) public{
continue;
}
`);
const config = _.defaultsDeep({rules: {'no-unused-vars': false}}, noIndent());
const report = linter.processStr(code, config);
assertErrorCount(report, 1);
assertErrorMessage(report, 'bracket');
});
it('should raise error when array declaration has spaces', function () {
const code = contractWith('uint [] [] private a;');
const report = linter.processStr(code, noIndent());
assert.equal(report.errorCount, 2);
assertErrorMessage(report, 0, 'Array declaration');
assertErrorMessage(report, 1, 'Array declaration');
});
it('should not raise error for array declaration', function () {
const code = contractWith('uint[][] private a;');
const report = linter.processStr(code, noIndent());
assertNoErrors(report);
});
it('should raise error when items inside contract do not separated by new line', function () {
const code = contractWith(`
function a() public {
}
function b() public {}
`);
const report = linter.processStr(code, noIndent());
assert.equal(report.errorCount, 1);
assertErrorMessage(report, 0, 'must be separated by one line');
});
it('should not raise error when items inside contract separated by new line', function () {
const code = contractWith(`
function a() public {
}
// any comment
function b() public {}
`);
const report = linter.processStr(code, noIndent());
assertNoErrors(report);
});
it('should not raise error when items inside contract separated by new line with comments', function () {
const code = contractWith(`
function a() public {
}
/**
* Function b
*/
function b() public {}
`);
const report = linter.processStr(code, noIndent());
assertNoErrors(report);
});
it('should raise error when line length exceed 120', function () {
const code = ' '.repeat(121);
const report = linter.processStr(code, noIndent());
assert.equal(report.errorCount, 1);
assertErrorMessage(report, 0, 'Line length must be no more than');
});
it('should not raise error when line length exceed 120 and custom config provided', function () {
const code = ' '.repeat(130);
const report = linter.processStr(code, {
rules: { indent: false, 'max-line-length': ['error', 130] }
});
assertNoErrors(report);
});
const INCORRECT_COMMA_ALIGN = [
funcWith('var (a,b) = test1.test2(); a + b;'),
funcWith('test(1,2, b);'),
funcWith('test(1,/* test */ 2, b);'),
contractWith('function b(uint a,uintc) public {}'),
funcWith('test(1, 2 , b);')
];
INCORRECT_COMMA_ALIGN.forEach(curExpr =>
it('should raise error when comma incorrect aligned', function () {
const report = linter.processStr(curExpr, noIndent());
assertErrorCount(report, 1);
assertErrorMessage(report, 'must be separated');
}));
const CORRECT_COMMA_ALIGN = [
funcWith('var (a, b,) = test1.test2(); a + b;'),
funcWith('test(1, 2, b);'),
contractWith('function b(uint a, uintc) public {}'),
contractWith('enum A {Test1, Test2}')
];
CORRECT_COMMA_ALIGN.forEach(curExpr =>
it('should raise error when comma incorrect aligned', function () {
const report = linter.processStr(curExpr, noIndent());
assertNoErrors(report);
}));
const INCORRECT_SEMICOLON_ALIGN = [
funcWith('var (a, b) = test1.test2() ; a + b;'),
funcWith('test(1, 2, b) ;'),
funcWith('test(1, 2, b)/* test */;'),
funcWith('for ( ;;) {}'),
funcWith('for (i = 0; ;) {}'),
funcWith('for ( ; a < b;) {}')
];
INCORRECT_SEMICOLON_ALIGN.forEach(curExpr =>
it('should raise error when semicolon incorrect aligned', function () {
const report = linter.processStr(curExpr, noIndent());
assertErrorCount(report, 1);
assertErrorMessage(report, 'Semicolon must not have spaces before');
}));
const CORRECT_SEMICOLON_ALIGN = [
funcWith('var (a, b,) = test1.test2(); a + b;'),
funcWith('test(1, 2, b);')
];
CORRECT_SEMICOLON_ALIGN.forEach(curExpr =>
it('should raise error when semicolon incorrect aligned', function () {
const report = linter.processStr(curExpr, noIndent());
assertNoErrors(report);
}));
});
});