Adding Lombok plugin to IntelliJ project

Question

I'm trying to add Lombok to my Spring Boot project in IntelliJ IDEA. So far, I've

added the plugin under Settings - Plugins (version 0.13.16)
added compile('org.projectlombok:lombok') to my Gradle dependencies
enabled annotation processing

It still doesn't recognize either the Lombok import or the annotations.

What am I missing?

Solved:

I had to run an update on my Gradle file.

Can you elaborate on your solution? – Swagga Ting Oct 01 '18 at 21:28 — Swagga Ting, Oct 01 '18 at 21:28

A0__oN · Answer 1 · 2016-12-15T14:31:09.263

75

You need to Enable Annotation Processing on IntelliJ IDEA

> Settings > Build, Execution, Deployment > Compiler > Annotation Processors

edited Dec 15 '16 at 14:31

answered Dec 15 '16 at 14:10

A0__oN

8,740
6
40
61

3

Thanks. A bit weird that you have to enable this option after installing the Lombok plugin, though. They should have at least pointed to this option in their instructions. – Ammaro Mar 15 '18 at 01:29
I don't have it enabled and Lombok is recognized (after installing the plugin and restarting). Maybe this is not necessary anymore? – Ferran Maylinch May 28 '18 at 15:00
1

Adding the Lombok plugin is necessary for runtime usage. Activating the annotation processing is necessary for compile time usage to get rid of the compiler warnings in the editor window. – bl4ckb0l7 Apr 17 '19 at 14:28

score 42 · Answer 2 · answered Feb 02 '18 at 07:11

42

To add the Lombok IntelliJ plugin to add lombok support IntelliJ:

Go to File > Settings > Plugins
Click on Browse repositories...
Search for Lombok Plugin
Click on Install plugin
Restart IntelliJ IDEA

answered Feb 02 '18 at 07:11

Vikash

643
7
13

1

This is correct approach followed by @Henrik's steps and enabling "Annotation processing" under `Build, Execution and deployment` section in `Settings`. – instinct Nov 30 '18 at 09:08

score 15 · Answer 3 · edited Aug 21 '19 at 18:10

15

Be sure to activate the plugin for the project in the Intellij settings.

Click Settings Other Settings Lombok Plugin.
Ensure Enable Lombock plugin... is checked.

edited Aug 21 '19 at 18:10

Dave Jarvis

30,436
41
178
315

answered Dec 15 '16 at 09:51

Henrik Kirk

604
1
6
18

And restart after plugin installation didn't work? – Henrik Kirk Dec 15 '16 at 10:06
No, oddly enough. – Anders Pedersen Dec 15 '16 at 10:07
after enabling the lombok error messages i get ' Lombok Dependency is missing ~ Project "dsRngChecker" does not seem to have lombok dependency added. ' tried various versions of compileOnly("org.projectlombok:lombok:0.13.16") – Anders Pedersen Dec 15 '16 at 10:14
1

You have added lombok like the describe here: https://projectlombok.org/mavenrepo/? _compileOnly "org.projectlombok:lombok:1.16.12"_ – Henrik Kirk Dec 15 '16 at 10:17

score 8 · Answer 4 · edited Aug 21 '19 at 18:08

8

To install the plugin manually, try:

Download Lombok zip file (ensure Lombok matches the IDE version).
Select Preferences Plugins Install Plugins from Disk.

edited Aug 21 '19 at 18:08

Dave Jarvis

30,436
41
178
315

answered Jul 03 '19 at 22:47

Naveen

907
2
15
25

score 5 · Answer 5 · answered Apr 23 '19 at 17:59

There is a lot of really helpful info posted here, but there is one thing that all the posts seem to have wrong. I could not find any 'Settings' option under 'Files', and I hunted around for 10 minutes looking through all the menus until I found the settings under 'IntelliJ IDE' -> 'Preferences'.

I don't know if I am using a differing OS version or IntelliJ version from other posters, or if it is because I am a stupid Windows user that doesn't know that settings == preferences on a mac (Did I miss the memo?), but I hope this helps you if you aren't finding the paths that other posts are suggesting.

...and that's why I love people posting screenshots; the world's between win and mac and its wordings annoyances are a step clearer then ;-) I also think that these troubles sometimes consumes too much time. Did anyone mention the differences between versions of a software ;-) — Dirk Schumacher, May 01 '21 at 19:55

score 5 · Answer 6 · answered May 21 '19 at 09:47

I would like to add that in my case (My OS is Linux Mint and using IntelliJ IDEA). My compiler complaining about these annotations I was using: @Data @RequiredArgsConstructor, even though I had installed and activated the Lombok plugin.Install Lombok in IntelliJ Idea. I am using Maven. So I had to add this dependency in my configuration file (pom.xml file):

dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>

score 4 · Answer 7 · edited Aug 21 '19 at 18:03

4

If after installing the lombok intellij plugin and enabling annotation processing, if your getter and setters are still not recognised in intellij, do check if the plugin version is compatible with the intellij version you use.

It is listed under the Downloads section:

edited Aug 21 '19 at 18:03

Dave Jarvis

30,436
41
178
315

answered Aug 01 '18 at 16:34

Mohammed Rafeeq

2,586
25
26

score 2 · Answer 8 · answered Oct 01 '18 at 21:52

For me it didn't work after doing all of the steps suggested in the question and in the top answer. Initially the import didn't work, and then when I restarted IntelliJ, I got these messages from the Gradle Plugin:

Gradle DSL method not found: 'annotationProcessor()'
Possible causes:<ul><li>The project 'wq-handler-service' may be using a version of the Android Gradle plug-in that does not contain the method (e.g. 'testCompile' was added in 1.1.0).
Upgrade plugin to version 2.3.2 and sync project</li><li>The project 'wq-handler-service' may be using a version of Gradle that does not contain the method.
Open Gradle wrapper file</li><li>The build file may be missing a Gradle plugin.
Apply Gradle plugin</li>

This was weird because I don't develop for Android, just using IntelliJ for Mac OS.

To be fair, my build.gradle file had these lines in the dependencies section, which I copied from a colleague:

compileOnly group: 'org.projectlombok', name: 'lombok', version: '1.16.20'
annotationProcessor group: 'org.projectlombok', name: 'lombok', version: '1.16.20'

After checking versions, the only thing that completely solved my problem was adding the below to the plugins section of build.gradle, which I found on this page:

id 'net.ltgt.apt' version '0.15'

Looks like it's a

Gradle plugin making it easier/safer to use Java annotation processors

(ltgt plugin page)

score 1 · Answer 9 · answered Jul 19 '18 at 13:48

I just found how.

I delete the first occurrence of lombok @Slf4j or log where the compiler complains, and wait for the warning(the red bubble) of IDEA, suggesting "add the lombok.extern.Slf4j.jar to classpath". Since then all goes well. It seems IDEA likes to complain about lombok.

score 1 · Answer 10 · answered May 06 '19 at 08:50

1

I had the same problem after updating IntelliJ IDE, the fix was: delete existed plugin lombok and install it again (the newest version),

answered May 06 '19 at 08:50

Egor

2,122
2
21
23

Adding Lombok plugin to IntelliJ project

10 Answers10

Linked