Package lombok into extension (#2550)

- Add the feature of using extension's lombok version by default
- If the lombok support is enable, the extension always adds the
  latest version lombok jar to start JDT LS. This can avoid the
  errors caused by old version lombok.
- The user can select the lombok version of the extension, or project
- If the user wants to use project's lombok which is lower then 1.18.2,
  we send a warning message and continue to use extension's lombok

Signed-off-by: Yuhao Xiao <[email protected]>

Author: XiaoYuhao

.gitignore

@@ -8,6 +8,7 @@ undefined
 target
 dist
 jre
+lombok
 bin/
 .settings
 .classpath

Jenkinsfile

@@ -12,6 +12,11 @@ def buildVscodeExtension(){
 	sh "npm run vscode:prepublish"
 }
 
+def downloadLombokJar(){
+	stage "Download lombok.jar"
+	sh "npx gulp download_lombok"
+}
+
 def packageSpecificExtensions() {
 	stage "Package platform specific vscode-java"
 	def platforms = ["win32-x64", "linux-x64", "linux-arm64", "darwin-x64", "darwin-arm64"]
@@ -159,6 +164,8 @@ node('rhel8'){
 		sh "npm test --silent"
 	}
 
+	downloadLombokJar()
+
 	packageExtensions()
 
 	publishExtensions()

README.md

@@ -112,7 +112,7 @@ Supported VS Code settings
 The following settings are supported:
 
 * `java.home` : **Deprecated, please use 'java.jdt.ls.java.home' instead.** Absolute path to JDK home folder used to launch the Java Language Server. Requires VS Code restart.
-* `java.jdt.ls.lombokSupport.enabled`: Whether to load lombok processors from project classpath. Defaults to `true`.
+* `java.jdt.ls.lombokSupport.enabled`: Whether to enable lombok support. Defaults to `true`.
 * `java.jdt.ls.vmargs` : Extra VM arguments used to launch the Java Language Server. Requires VS Code restart.
 * `java.errors.incompleteClasspath.severity` : Specifies the severity of the message when the classpath is incomplete for a Java file. Supported values are `ignore`, `info`, `warning`, `error`.
 * `java.trace.server` : Traces the communication between VS Code and the Java language server.

gulpfile.js

@@ -116,6 +116,18 @@ gulp.task('download_jre', async function(done) {
 	done();
 });
 
+gulp.task('download_lombok', function(done) {
+	if (fse.existsSync('./lombok')) {
+		fse.removeSync('./lombok');
+	}
+	const lombokVersion = '1.18.24';
+	// The latest lombok version can be found on the website https://projectlombok.org/downloads
+	const lombokUrl = `https://projectlombok.org/downloads/lombok-${lombokVersion}.jar`;
+	download(lombokUrl)
+		.pipe(gulp.dest('./lombok/'))
+	done();
+});
+
 gulp.task('download_server', function(done) {
 	fse.removeSync('./server');
 	download("http://download.eclipse.org/jdtls/snapshots/jdt-language-server-latest.tar.gz")

src/extension.ts

@@ -27,6 +27,7 @@ import { runtimeStatusBarProvider } from './runtimeStatusBarProvider';
 import { serverStatusBarProvider } from './serverStatusBarProvider';
 import { markdownPreviewProvider } from "./markdownPreviewProvider";
 import * as chokidar from 'chokidar';
+import { cleanupLombokCache } from "./lombokSupport";
 
 const syntaxClient: SyntaxLanguageClient = new SyntaxLanguageClient();
 const standardClient: StandardLanguageClient = new StandardLanguageClient();
@@ -359,6 +360,7 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 			const cleanWorkspaceExists = fs.existsSync(path.join(workspacePath, cleanWorkspaceFileName));
 			if (cleanWorkspaceExists) {
 				try {
+					cleanupLombokCache(context);
 					deleteDirectory(workspacePath);
 					deleteDirectory(syntaxServerWorkspacePath);
 				} catch (error) {