Lombok with Spring Tool Suite 4

Question

I've recently installed the new Spring Tool Suite 4 in macOS High Sierra but when I tried to run Lombok's installation it wouldn't find my STS installation,

I followed this steps for manual installation (adding -javaagent to the ini file) but with no luck: https://www.edvpfau.de/sts-spring-tool-suite-4-mit-lombok/.

Any idea?

Manuel Jordan · Accepted Answer · 2021-08-09T16:12:49.210

65

I did install Lombok in Spring Tool Suite 4 just some days ago for Mac and Windows. And none problems.

One:

Execute java -jar lombok.jar

Note: normally or by default, it does not find the installer, it is the common scenario in my experience.

Two:

Press the Specify Location button. Therefore proceed to find and select the STS.ini file. It could be SpringToolSuite4.ini too.

Note: for Mac, go to the Contents directory within the .app file

Conclusion: therefore for any OS, the goal is find the unique file with the .ini extension

Normally I do this with the IDE closed.

edited Aug 09 '21 at 16:12

answered Oct 12 '18 at 13:34

Manuel Jordan

15,253
21
95
158

1

Thanks @Manuel, I also suggest to install the current Edge version of Lombok because it solves some issues with Eclipse Photon – Joaquín L. Robles Oct 12 '18 at 14:07
Agree, but I have assumed the latest version of Lombok was used. – Manuel Jordan Oct 12 '18 at 14:20
2

In Spring Tool Suite 4 the name changed from STS.ini to SpringToolSuite4.ini at least for MacOs – OJVM Jul 02 '19 at 18:19
MAKE SURE YOU ARE IN `/Applications/SpringToolSuite4.app` and NOT `/Applications/STS.app`... If you have an older version of STS, it will show that as the dir... Delete that first before installing lombok – Marcello DeSales Aug 12 '19 at 16:10
Using lombok `1.18.10` I break SpringToolSuite4 and it can no longer start. Using `1.18.4` everything works fine. My STS version is `4.4.1.RELEASE`. – ozooxo Oct 29 '19 at 13:42
Consider to report that error either in STS or Lombok github accounts – Manuel Jordan Oct 29 '19 at 14:16
1

Using lombok 1.18.10 works fine with STS 4.4.2.RELEASE in MacOs Catalina. – OJVM Nov 27 '19 at 15:49
STS4 installation is picky and sometimes machine dependent. About 1 month ago, I installed on 3 machines simultaneously. All were running the same version of windows 10. For some reason, there was no setup required for one of the machines, but for the other two I had to tweak the .ini configuration file to get it to launch. – Nate T Aug 24 '20 at 14:57
I'll just add that in my case, on a Mac, I did this with STS running. I had to restart STS in order for the installation to work. – Mike Ryan Mar 09 '23 at 14:12

score 32 · Answer 2 · answered Feb 09 '19 at 19:42

32

Although this might be late, but it can be of help for others just experiencing this. Bellow is how I solved this issue

STEP 1

Find lombok in your project maven directory -> Right click -> Run As -> Java Application

STEP 2 Click on Specify Location button to choose the path where STS is installed

STEP 3 Go to Application/Contents/Eclipse/SpringToolSuit4.ini Then click on Install -> Quick Installer

STEP 4 Restart STS you good to go

answered Feb 09 '19 at 19:42

Prodigy

2,094
24
30

1

MAKE SURE YOU ARE IN `/Applications/SpringToolSuite4.app` and NOT `/Applications/STS.app` – Marcello DeSales Aug 12 '19 at 16:10
This along with the below link worked for me [ renaming to STS.ini ]: https://stackoverflow.com/questions/56523530/lombok-installation-in-spring-tool-suite-4-for-windows – kkk Mar 04 '20 at 13:27

score 24 · Answer 3 · answered Apr 05 '19 at 17:57

24

I renamed SpringToolSuite4.exe and SpringToolSuite4.ini to STS.exe and STS.ini. Then used lombok installer's Specify Location to find them. After lombok installed, I renamed those files back to their original names.

answered Apr 05 '19 at 17:57

BigRedBettaFish

425
6
12

2

I don't know why this answer is not upvoted. This is the right answer. Thanks. – nmkyuppie Jun 28 '19 at 11:59
1

Great!!!!!!!!!!!!!!!!!!!!! I was using SpringToolSuite4 and on executing jar lombok was not able to find IDE at specified location. This answer helped me. Must be given a try and must be upvoted if anybody having same trouble. – Mohammad Anas Nov 20 '19 at 19:33
1

Even this works without renaming back to the original names :) – TikTik May 04 '20 at 09:50
latest update: Installer able to pick up the name SpringToolSuite4.exe. No longer need to rename it to STS – Shivani Shanishchara Jul 30 '20 at 11:26
Strange!!! but working !tried so many times with different answers, but this one helped me..without renaming to SpringToolSuite4.(use STS) – Arunkumar Pushparaj Dec 15 '21 at 12:42
HA! Can't believe this actually worked, thanks so much! – mread1208 Nov 10 '22 at 18:51

Mohit Bansal · Answer 4 · 2019-11-13T00:11:43.077

11

I faced same issue with for Spring tool suite 4

Solution

Close running STS.
Open terminal
Go to ~/.m2/repository/org/projectlombok/lombok/version
Run java -jar lombok-version.jar Pop window will come.
If it does not pick up the STS itself. Then chose specify location Choose SpringToolSuite4.ini at ⁨Applications⁩ ▸ ⁨SpringToolSuite4⁩ ▸ ⁨Contents⁩ ▸ ⁨Eclipse⁩ .
Click install
After this Starts Spring tool suite and clean project.

edited Nov 13 '19 at 00:11

answered Oct 21 '19 at 22:46

Mohit Bansal

348
3
8

1

Project -> clean was my last missing piece. Thanks! – Ken Goodridge Dec 06 '19 at 21:35
After cleaning project it started working. – Manish gour Jul 07 '22 at 14:33

Van_Cleff · Answer 5 · 2019-02-28T19:12:54.843

10

Just to add to M. Jordan's and prodigy's answer, please be sure to give execute permission to lombok.jar

(After you follow the above-mentioned step) Open terminal and change directory to the content of SpringToolSuite.app

cd /Applications/SpringToolSuite4.app/Contents/Eclipse

Then check whether execute permission is available to lombok.jar

ls -al

If you see -rw-r--r-- it means you need to give execute permission

chmod +x lombok.jar

alternatively you could also do

chmod +x /Applications/SpringToolSuite4.app/Contents/Eclipse/lombok.jar

Then restart STS

edited Feb 28 '19 at 19:12

answered Feb 28 '19 at 19:07

Van_Cleff

842
6
14

1

Thank you. I hadn't been able to use Lombok for ages and your solution helped me solve it. – Kshitij Bajracharya Jan 10 '20 at 07:28

score 6 · Answer 6 · answered Mar 14 '19 at 10:23

I'll show you how to completely install lombok into Spring Tool Suite 4 or latest version. First go to your project pom.xml file and add this dependency on dependencies section.

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

Go to your project root folder on your IDE and click the right button on it. Select like below:

And make sure, checked Force Update of Snapshots/Releases. Click Ok to download and update dependencies.

After finishing all task. Go to project Maven Dependencies and find lombok.jar file (>Maven Dependencies >lombok.jar). Right click on lombok jar. Go to Run As Java Application.

It will open lombok installer window and click ok. Then click Specify Location button.

Select the location where your STS bundle was installed. If it is selected properly then it will checked STS.exe, like below:

Then click install/update button. Finally lombok will be installed successfully.

Hopefully it helps you. Thanks.

score 4 · Answer 7 · edited Mar 13 '19 at 06:32

None of the steps worked for me as the file dialog box won't even let me select the directory containing the SpringToolSuite4.ini

So I did the following:

Get lombok-<version>.jar from either your ~/.m2/repository/org/projectlombok/lombok/<latest-version>/ If not available you can get it from mvn repository: https://mvnrepository.com/artifact/org.projectlombok/lombok/1.18.6
copy the lombok-<version>.jar to /Applications/SpringToolSuite4.app/Contents/Eclipse as lombok.jar
```
cp /path/to/lombok.jar /Applications/SpringToolSuite4.app/Contents/Eclipse/
```
Edit the file: /Applications/SpringToolSuite4.app/Contents/Eclipse/SpringToolSuite4.ini inside the directory to add this last line:
```
-javaagent:/Applications/SpringToolSuite4.app/Contents/Eclipse/lombok.jar
```
Open your project in eclipse. Right click on Maven -> update project. Follow similar step if you're using another build tool (like Gradle)

correct. It helped and worked for me as I was also not able to select the .ini file in the mac. Would be glad to know why is that so? — Neeraj Singh, Mar 21 '19 at 01:05

score 4 · Answer 8 · answered Jul 18 '19 at 16:07

4

In my case, Lombok 1.16 could not locate STS 4 installation even after pointing to it manually. Worked only after I tried with updated Lombok version - Lombok 1.18.

answered Jul 18 '19 at 16:07

user07

319
2
8

score 2 · Answer 9 · answered Jun 26 '20 at 12:46

2

Turn off STS
Install lombok following other common guidances with jar.
Turn on STS

answered Jun 26 '20 at 12:46

문상록

21
1

score 1 · Answer 10 · answered Oct 14 '20 at 09:59

I spent like 3 or 4 hours looking for a solution to the Lombok problem with springo book and eclipse, the solution I found on the internet was the following, I leave the link: (https://projectlombok.org/all- versions) where is the entire Lombok version and I chose the latest lombok version then updated the IDE and MVN and everything worked.

abhinavsinghvirsen · Answer 11 · 2021-04-05T18:14:39.360

1

For Latest Mac OS Big Sur

Just place lombok jar In Application folder then Follow the steps

folder path /Applications/SpringToolSuite4.app/Contents/Eclipse once you complete all the steps restart your IDE

1.

2

3.

4.

5.

6.

edited Apr 05 '21 at 18:14

answered Apr 05 '21 at 17:57

abhinavsinghvirsen

1,853
16
25

1

Are you certain this will hold up @abhinavxeon? In my experience any changes to any file inside the Springsource app will sooner rather than later trigger some kind of OS protection that will prohibit further launches until you reinstall. At least this is true when running the aarch64 version. – MiB Nov 26 '21 at 03:23
it using it ! its worked for me – abhinavsinghvirsen Jan 24 '22 at 04:45

score 0 · Answer 12 · answered Jun 06 '19 at 09:50

the easiest way you can do is that by running the following command on command prompt

java -jar (jar location/lombok.1.8.1.jar) install (the path where you installed Spring tool suite(STS))

for example:

java -jar C:\Users\karthick\.m2\repository\org\projectlombok\lombok\1.18.8\lombok-1.18.8.jar install D:\STS_Tool\spring-tool-suite-4-4.1.2.RELEASE-e4.10.0-win32.win32.x86_64\sts-4.1.2.RELEASE

after that, you have to restart the tool.

score 0 · Answer 13 · answered May 17 '20 at 07:20

0

on macOS Catalina all I had to do was to use lombok 1.18 and all worked fine.

answered May 17 '20 at 07:20

Nishikant

305
4
17

score 0 · Answer 14 · answered Nov 21 '20 at 16:34

0

I did it in a different way. just did the below.

Copy the lombok.jar to the root directory of STS
Added "-javaagent:lombok-1.16.18.jar" to the SpringToolSuite4.ini

It worked for me.

answered Nov 21 '20 at 16:34

user3258303

11
1

score 0 · Answer 15 · answered Apr 01 '21 at 15:36

0

I had the same issue with STS-4.6 and lombok-1.18.18 on Windows10. I added lombok dependency to pom.xml, built the project, ran lombok jar in .m2 repository and restarted STS. Building the project did not work. Finally, Project -> Build All worked.

answered Apr 01 '21 at 15:36

Rashmi

229
2
9

score 0 · Answer 16 · answered May 09 '21 at 07:58

0

after install lombok project into your eclipse-- Go to the eclipse sts4 folder--

get the permission to the lombok.jar

$chmod +x lombok.jar

then open the eclipse.

answered May 09 '21 at 07:58

Prem Prakash Sahani

9
3

While this probably won't hurt I checked the permissions on "lombok.jar" in a working lombok install inside Eclipse, rather than the Springsource build, and they are ``-rw-r--r--``. – MiB Nov 26 '21 at 03:28

score 0 · Answer 17 · answered Nov 19 '21 at 07:26

Step to add lombok project in your eclipse--

download lombok jar and place one folder.

edit the SpringToolSuite4.ini file which is exist in the eclipse folder.

add three lines in last of file-- --add-modules=ALL-SYSTEM -javaagent:/spring-tool-suite-4-4.10.0.RELEASE-e4.19.0-linux.gtk.x86_64/sts-4.10.0.RELEASE/plugins/org.projectlombok.agent_1.18.20/lombok.jar

restart the eclipse.

score 0 · Answer 18 · answered Feb 02 '22 at 08:12

0

best option is through install new software option built in ecliplse help>install new software> and add this site https://projectlombok.org/p2 you are good to go

answered Feb 02 '22 at 08:12

jagadeesh vemula

1

score 0 · Answer 19 · answered Jan 22 '23 at 19:35

Although this might be late, but it can be of help for others just experiencing this. Bellow is how I solved this issue

STEP 1

Find lombok in your project maven directory -> Right click -> Run As -> Java Application enter image description here

STEP 2 Click on Specify Location button to choose the path where STS is installed

enter image description here Install -> Install/Update Installer

STEP 3 Go to Application/Contents/Eclipse/SpringToolSuit4.ini Then click on Install/update

STEP 4 Restart STS you good to go

Restart your IDE and Run Project->Update Maven Project and then all your errors will be gone

Lombok with Spring Tool Suite 4

19 Answers19

Linked