Skip to content

Commit 425a7bf

Browse files
committed
docs: Inform about JaCoCo alternative as solution
This change adds information about using the latest JaCoCo version instead to solve the issue of code coverage as this does not pollute the resulting bytecode with Lombok annotations.
1 parent fdbca1f commit 425a7bf

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,24 @@
22
A Kotlin compiler plugin that annotates Kotlin-generated methods with `lombok.Generated` to signify to code analyzers
33
that these methods have been generated by the compiler.
44

5+
## JaCoCo solution (new)
6+
Please note that JaCoCo recently landed support for recognizing Kotlin-generated
7+
code, so we suggest using one of their snapshots builds (0.8.2-SNAPSHOT+) instead if possible.
8+
It has the advantage of not polluting your code with `lombok.Generated` annotations.
9+
10+
In Gradle, you can do that as follows:
11+
12+
```groovy
13+
repositories {
14+
// This repository is needed to get the latest snapshot of JaCoCo
15+
maven { url = "https://oss.sonatype.org/content/repositories/snapshots" }
16+
}
17+
18+
jacoco {
19+
toolVersion = '0.8.2-SNAPSHOT'
20+
}
21+
```
22+
523
## Gradle
624
To use the plugin, just apply the plugin in your `build.gradle`:
725

0 commit comments

Comments
 (0)