lombok-intellij-plugin

Plugin for IntelliJ IDEA to support Lombok annotations.

Provides support for lombok annotations to write great Java code with IntelliJ IDEA.

Last version (0.34) released on 17.01.2021

💥 Breaking News: Starting with IntelliJ version 2020.3 lombok plugin will be integrated and included in IntelliJ by default!. 💥

💥 Enjoy new kind of experience for lombok support inside of IntelliJ Idea!

🛠️ Previous InteliJ versions still supported by corresponding plugin version!

37th version of plugin released.

Install it automatically from IntelliJ Idea plugin repository.

Tested and supports IntelliJ versions: 2018.X, 2019.X, 2020.1 and 2020.2.1+, 2020.3 (Build In!)

Last support for IntelliJ 2017.1, 2017.2 and 2017.3 by plugin version 0.32!

Last support for IntelliJ 2016.2 and 2016.3 by plugin version 0.31!

Last support for IntelliJ 15.0.6 and 2016.1 by plugin version 0.19!

Last support for IntelliJ 14.1.7 by plugin version 0.14!

Last support for IntelliJ 11.1.5, 12.1.7, 13.1.6 by plugin version 0.11

Last support for IntelliJ 10.5.4 by plugin version 0.8.7

With this plugin your IntelliJ can recognize all of generated getters, setters and some other things from lombok project, so that you get code completion and are able to work without errors stating the methods don't exists.

Features / Supports

@Getter and @Setter
@ToString
@EqualsAndHashCode
@AllArgsConstructor, @RequiredArgsConstructor and @NoArgsConstructor
@Log, @Log4j, @Log4j2, @Slf4j, @XSlf4j, @CommonsLog, @JBossLog, @Flogger, @CustomLog
@Data
@Builder
@Singular
@Delegate
@Value
@Accessors
@With
@SneakyThrows
@val available from IntelliJ 14.1 (improved in 2016.2)
@UtilityClass available from IntelliJ 2016.2
@ExtensionMethod experimental in IntelliJ 2019.2-2020.2
lombok config files syntax highlighting
code inspections
refactoring actions (lombok and delombok)
project configuration inspection (missing/out-of-date Lombok dependency, annotation processing disabled)

Many features of the plugin (including warnings) could be disabled through per-project settings.

Installation

Plugin Installation

Using IDE built-in plugin system on Windows:
- File > Settings > Plugins > Browse repositories... > Search for "lombok" > Install Plugin
Using IDE built-in plugin system on MacOs:
- Preferences > Settings > Plugins > Browse repositories... > Search for "lombok" > Install Plugin
Manually:
- Download the latest release and install it manually using Preferences > Plugins > Install plugin from disk...

Restart IDE.

Required IntelliJ Configuration

In your project: Click Preferences -> Build, Execution, Deployment -> Compiler, Annotation Processors. Click Enable Annotation Processing

Afterwards you might need to do a complete rebuild of your project via Build -> Rebuild Project.

Lombok project dependency

Make sure you have Lombok dependency added to your project. This plugin does not automatically add it for you.

Please Note: Using newest version of the Lombok dependency is recommended, but does not guarantee that all the features introduced will be available. See Lombok changelog for more details.

If you are using Gradle/Maven/Ivy, see example below:

Gradle

In your build.gradle:

repositories {
	mavenCentral()
}

dependencies {
	compileOnly 'org.projectlombok:lombok:1.18.16'
	annotationProcessor 'org.projectlombok:lombok:1.18.16'

	testCompileOnly 'org.projectlombok:lombok:1.18.16'
	testAnnotationProcessor 'org.projectlombok:lombok:1.18.16'
}

Maven

In your pom.xml:

<dependencies>
	<dependency>
		<groupId>org.projectlombok</groupId>
		<artifactId>lombok</artifactId>
		<version>1.18.16</version>
		<scope>provided</scope>
	</dependency>
</dependencies>

Ivy

In your ivy.xml:

<dependency org="org.projectlombok" name="lombok" rev="1.18.16" conf="build" />

IntelliJ and Eclipse compiler

If you're using Eclipse compiler with lombok, try this setup:

install plugin
make sure Lombok dependency is added to the project
change compiler setting:
- ... > Compiler > Java Compiler > Use Compiler: Eclipse
- ... > Compiler > Annotation Processors > Enable annotation processing: checked (default configuration)
- ... > Compiler > Additional build process VM options: -javaagent:lombok.jar

bergerst/lombok-intellij-plugin