/
NoSemicolonsRuleTest.kt
476 lines (444 loc) · 14.7 KB
/
NoSemicolonsRuleTest.kt
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
package com.pinterest.ktlint.ruleset.standard
import com.pinterest.ktlint.test.KtLintAssertThat.Companion.assertThatRule
import com.pinterest.ktlint.test.LintViolation
import org.junit.jupiter.api.Disabled
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
class NoSemicolonsRuleTest {
private val noSemicolonsRuleAssertThat = assertThatRule { NoSemicolonsRule() }
@Test
fun `Given a package statement followed by a comma then return a lint error`() {
val code =
"""
package a.b.c;
""".trimIndent()
val formattedCode =
"""
package a.b.c
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolation(1, 14, "Unnecessary semicolon")
.isFormattedAs(formattedCode)
}
@Test
fun `Given multiple statements on a single line then do no return a lint error`() {
val code =
"""
val foo = "foo"; val bar = "bar"
fun name() { a(); return b }
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given a semi colon at the start of a line and not followed by code or comment on the same line then do report a lint error`() {
val code =
"""
fun foo() {
;
bar()
;
bar()
;
}
""".trimIndent()
val formattedCode =
"""
fun foo() {
bar()
bar()
}
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolations(
LintViolation(2, 5, "Unnecessary semicolon"),
LintViolation(4, 5, "Unnecessary semicolon"),
LintViolation(8, 5, "Unnecessary semicolon"),
).isFormattedAs(formattedCode)
}
@Disabled("To be implemented")
@Test
fun `Given a semi colon at the start of a line and followed by code or comment on the same line then do report a lint error`() {
val code =
"""
;val fooBar = "fooBar"
;// some comment
""".trimIndent()
val formattedCode =
"""
val fooBar = "fooBar"
// some comment
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolation(1, 1, "Unnecessary semicolon")
.isFormattedAs(formattedCode)
}
@Disabled("To be implemented")
@Test
fun `Given a semi colon at the start of a block then do report a lint error`() {
val code =
"""
fun name() { ; a() }
""".trimIndent()
val formattedCode =
"""
fun name() { a() }
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolation(1, 13, "Unnecessary semicolon")
.isFormattedAs(formattedCode)
}
@Disabled("To be implemented")
@Test
fun `Given a semi colon at end of a block then do report a lint error`() {
val code =
"""
fun name() { a(); }
""".trimIndent()
val formattedCode =
"""
fun name() { a() }
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolation(1, 16, "Unnecessary semicolon")
.isFormattedAs(formattedCode)
}
@Test
fun `Given a call to function with an optional lambda as last parameter which is omitted, followed by function call on a lambda receiver requires a semicolon in between`() {
val code =
"""
fun fooBar1() {
// Removing this semicolon on next line results in compile errors!
foo("some-foo");
{
// Do something
}.bar()
}
fun fooBar2() {
// Removing this semicolon on next line results in compile errors!
foo("some-foo"); { /* Do something */ }.bar()
}
// This code is here just to demonstrate why the semicolon after the call to foo is important when the
// optional lambda is omitted
fun foo(input: String, block: ((String) -> Unit)? = null) {
if (block != null) {
block(input)
} else {
input
}
}
// This code is here just to demonstrate why the semicolon after the call to foo is important when the
// optional lambda is omitted
fun <R> (() -> R).bar() {
// Do something
}
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given multiple statements on a single line and semicolon not followed by space then do return a lint error`() {
val code =
"""
fun name() { a();return b }
""".trimIndent()
val formattedCode =
"""
fun name() { a(); return b }
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolation(1, 18, "Missing spacing after \";\"")
.isFormattedAs(formattedCode)
}
@Test
fun `Given a function declaration followed by a comma then return a lint error`() {
val code =
"""
fun main() {};
""".trimIndent()
val formattedCode =
"""
fun main() {}
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolation(1, 14, "Unnecessary semicolon")
.isFormattedAs(formattedCode)
}
@Test
fun `Issue 281 - Given a companion object without block and followed by semicolon then do not return a lint error`() {
val code =
"""
class A1 {
companion object;
}
class A2 {
companion object ;
}
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Issue 281 - Given a companion object followed by a block and semicolon then do return a lint error`() {
val code =
"""
class A {
companion object {
const val emptyString = ""
};
}
""".trimIndent()
val formattedCode =
"""
class A {
companion object {
const val emptyString = ""
}
}
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolation(4, 6, "Unnecessary semicolon")
.isFormattedAs(formattedCode)
}
@Test
fun `Given a KDoc with an identifier followed by a semicolon then do not return a lint error`() {
val code =
"""
/**
* [x];
*/
fun foo() {
}
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given a lambda call followed by an annotated block then do not return a lint error`() {
val code =
"""
annotation class Ann
val f: () -> String = run {
listOf(1).map {
it + it
};
// Removing the semicolon on the line above results in a compile error!
@Ann
{ "" }
}
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given a lambda call followed by a block then do not return a lint error`() {
val code =
"""
val f: () -> String = run {
listOf(1).map {
it + it
};
// Removing the semicolon on the line above results in a compile error!
{ "" }
}
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given a lambda call followed by a block preceded with a KDoc then do not return a lint error`() {
val code =
"""
val f: () -> String = run {
listOf(1).map {
it + it
};
/**
* kdoc
*/
{ "" }
}
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
@Nested
inner class `Given an enumeration` {
@Test
fun `Given an enumeration and the list of values is followed by a declaration then do not return a lint error`() {
val code =
"""
enum class E1 {
ONE, TWO;
fun fn() {}
}
enum class E2 {
ONE, TWO;
val foo = "foo"
}
enum class E3 {
ONE, TWO;
private companion object {
val foo = "foo"
}
}
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Issue 1733 - Given an enumeration with primary constructor and the list of values is followed by a code element then do not return a lint error`() {
val code =
"""
enum class E1(bar: String) {
ONE("one"),
TWO("two");
fun fn() {}
}
enum class E2(bar: String) {
ONE("one"),
TWO("two");
val foo = "foo"
}
enum class E3(bar: String) {
ONE("one"),
TWO("two");
private companion object {
val foo = "foo"
}
}
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given an enumeration and the list of values is closed with an EOL comment followed by a semicolon on the next line then do not return a lint error`() {
val code =
"""
enum class Test {
ONE
// comment
;
}
enum class Foo(bar: String) {
ONE("one")
// comment
;
}
""".trimIndent()
val formattedCode =
"""
enum class Test {
ONE
// comment
}
enum class Foo(bar: String) {
ONE("one")
// comment
}
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolations(
LintViolation(4, 5, "Unnecessary semicolon"),
LintViolation(9, 5, "Unnecessary semicolon"),
).isFormattedAs(formattedCode)
}
@Test
fun `Given an enumeration and the list of values is closed with a semicolon not followed by statements then do return a lint error`() {
val code =
"""
enum class E1 {
A,
B;
}
enum class E2 {
A,
B // comment
;
}
enum class E3 {
;
}
enum class E4 {
// comment
;
}
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolations(
LintViolation(3, 6, "Unnecessary semicolon"),
LintViolation(8, 5, "Unnecessary semicolon"),
LintViolation(11, 5, "Unnecessary semicolon"),
LintViolation(15, 5, "Unnecessary semicolon"),
)
}
@Test
fun `Given an enumeration with a primary constructor and the list of values is closed with a semicolon not followed by statements then do return a lint error`() {
val code =
"""
enum class Foo1(bar: String) {
A(1),
B(2);
}
enum class Foo2(bar: String) {
A(1),
B(2) // comment
;
}
enum class Foo3(bar: String) {
;
}
enum class Foo4(bar: String) {
// comment
;
}
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolations(
LintViolation(3, 9, "Unnecessary semicolon"),
LintViolation(8, 5, "Unnecessary semicolon"),
LintViolation(11, 5, "Unnecessary semicolon"),
LintViolation(15, 5, "Unnecessary semicolon"),
)
}
}
@Test
fun `Given a for loop with an empty body then do not report a lint error`() {
val code =
"""
fun test(list: List<Int>) {
for (i in list);
}
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given a while loop with an empty body then do not report a lint error`() {
val code =
"""
fun test() {
while (true);
}
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given a do-while loop with an empty body then do report a lint error`() {
val code =
"""
fun test() {
do while (true);
}
""".trimIndent()
val formattedCode =
"""
fun test() {
do while (true)
}
""".trimIndent()
noSemicolonsRuleAssertThat(code)
.hasLintViolation(2, 20, "Unnecessary semicolon")
.isFormattedAs(formattedCode)
}
@Test
fun `Given an if-statement with an empty body then do not report a lint error`() {
val code =
"""
fun testIf() {
if (true);
}
""".trimIndent()
noSemicolonsRuleAssertThat(code).hasNoLintViolations()
}
}