Lombok compiler plugin
The Kotlin Lombok compiler plugin allows the generation and use of Java's Lombok declarations by Kotlin code in the same mixed Java/Kotlin module. If you call such declarations from another module, then you don't need to use this plugin for the compilation of that module.
The Lombok compiler plugin cannot replace Lombok, but it helps Lombok work in mixed Java/Kotlin modules. Thus, you still need to configure Lombok as usual when using this plugin. Learn more about how to make the plugin seeing Lombok's config.
The plugin supports the following annotations:
We're continuing to work on this plugin. To find out the detailed current state, visit the Lombok compiler plugin's README.
Currently, we don't have plans to support the
@Builder annotation. However, we can consider this if you vote for
@Builder in YouTrack.
kotlin-plugin-lombok Gradle plugin in the
Using the Lombok configuration file
If you use a Lombok configuration file
lombok.config, provide a path to it to the plugin. The path should be relative to the module's directory. Add the following code to your
To use the Lombok compiler plugin, add the plugin
lombok to the
compilerPlugins section and the dependency
kotlin-maven-lombok to the
dependencies section. If you use a Lombok configuration file
lombok.config, provide a path to it to the plugin in the
pluginOptions. Add the following lines to the
Using with kapt
By default, the kapt compiler plugin runs all annotation processors and disables annotation processing by javac. To run Lombok along with kapt, set up kapt to keep javac's annotation processors working.
If you use Gradle, add the option to the
In Maven, use the following settings to launch Lombok with Java's compiler:
The Lombok compiler plugin works correctly with kapt if annotation processors don't depend on the code generated by Lombok.
Look through the test project examples of kapt and the Lombok compiler plugin in use: