summaryrefslogtreecommitdiff
path: root/doc/ale-java.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ale-java.txt')
-rw-r--r--doc/ale-java.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/ale-java.txt b/doc/ale-java.txt
index aa226305..35967f03 100644
--- a/doc/ale-java.txt
+++ b/doc/ale-java.txt
@@ -102,6 +102,39 @@ This variable can be changed to use a different executable for java.
===============================================================================
+eclipselsp *ale-java-eclipselsp*
+
+To enable Java LSP linter you need to clone and build the eclipse.jdt.ls
+language server from https://github.com/eclipse/eclipse.jdt.ls. Simply
+clone the source code repo and then build the plugin:
+
+ ./mvnw clean verify
+
+Note: currently, the build can only run when launched with JDK 8. JDK 9 or more
+recent versions can be used to run the server though.
+
+After build completes the files required to run the language server will be
+located inside the folder |org.eclipse.jdt.ls.product/target/repository|.
+Ensure to set |g:ale_java_eclipselsp_path| to the absolute path of that folder.
+
+g:ale_java_eclipselsp_path *g:ale_java_eclipselsp_path*
+ *b:ale_java_eclipselsp_path*
+
+ Type: |String|
+ Default: `'eclipse.jdt.ls/org.eclipse.jdt.ls.product/target/repository'`
+
+ Path to the location of the eclipse.jdt.ls product repository.
+
+
+g:ale_java_eclipselsp_executable *g:ale_java_eclipse_executable*
+ *b:ale_java_eclipse_executable*
+ Type: |String|
+ Default: `'java'`
+
+ This variable can be set to change the executable path used for java.
+
+
+===============================================================================
uncrustify *ale-java-uncrustify*
See |ale-c-uncrustify| for information about the available options.