summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2019-04-13 12:48:20 +0100
committerGitHub <noreply@github.com>2019-04-13 12:48:20 +0100
commitf0f0cc3c186c46f437d62e6b3e01a45d2a3aaf47 (patch)
treed164e8023e6e94229fb0c8ba4f4c63d2b0ecbaec /doc
parent784d1a9a622a0c30c26a17a835943593d036a4cd (diff)
parentf02e2ec54cb39e6fcc73bbaf553cbfb0111944d4 (diff)
downloadale-f0f0cc3c186c46f437d62e6b3e01a45d2a3aaf47.zip
Merge pull request #2121 from hsanson/1996-add-support-for-eclipse-jdt-ls
WIP Fix 1996 - Add eclipse LSP support.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-java.txt33
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale.txt1
3 files changed, 35 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.
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index ab66e0d8..b682dc31 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -200,6 +200,7 @@ Notes:
* `ispc`!!
* Java
* `checkstyle`
+ * `eclipselsp`
* `google-java-format`
* `javac`
* `javalsp`
diff --git a/doc/ale.txt b/doc/ale.txt
index 5b4497d7..96c3a102 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -1987,6 +1987,7 @@ documented in additional help files.
google-java-format....................|ale-java-google-java-format|
pmd...................................|ale-java-pmd|
javalsp...............................|ale-java-javalsp|
+ eclipselsp............................|ale-java-eclipselsp|
uncrustify............................|ale-java-uncrustify|
javascript..............................|ale-javascript-options|
eslint................................|ale-javascript-eslint|