summaryrefslogtreecommitdiff
path: root/doc/ale-java.txt
diff options
context:
space:
mode:
authorHoracio Sanson <horacio@allm.net>2020-03-19 18:00:13 +0900
committerHoracio Sanson <horacio@allm.net>2020-03-19 18:00:13 +0900
commitc2aa01199eb86c1e0e5fbdf59029554c8f491d35 (patch)
tree59e42031b5102fb876ba4d5668154eca821c8b0f /doc/ale-java.txt
parentbbe5153fcb36dec9860ced33ae8ff0b5d76ac02a (diff)
downloadale-c2aa01199eb86c1e0e5fbdf59029554c8f491d35.zip
Fix 345 - update java language server docs.
Diffstat (limited to 'doc/ale-java.txt')
-rw-r--r--doc/ale-java.txt24
1 files changed, 16 insertions, 8 deletions
diff --git a/doc/ale-java.txt b/doc/ale-java.txt
index 32f0e6eb..89a2a0cb 100644
--- a/doc/ale-java.txt
+++ b/doc/ale-java.txt
@@ -107,18 +107,26 @@ javalsp *ale-java-javalsp*
To enable Java LSP linter you need to download and build the vscode-javac
language server from https://github.com/georgewfraser/java-language-server.
-Simply download the source code and then build a distribution:
- scripts/link_mac.sh
+Before building the language server you need to install pre-requisites: npm,
+maven, and protobuf. You also need to have Java 13 and JAVA_HOME properly
+set.
-or
+After downloading the source code and installing all pre-requisites you can
+build the language server with the included build.sh script:
- scripts/link_windows.sh
+ scripts/build.sh
-This generates a dist/mac or dist/windows directory that contains the
-language server. To let ALE use this language server you need to set the
+This will create launch scripts for Linux, Mac, and Windows in the dist folder
+within the repo:
+
+ - lang_server_linux.sh
+ - lang_server_mac.sh
+ - lang_server_windows.sh
+
+To let ALE use this language server you need to set the
g:ale_java_javalsp_executable variable to the absolute path of the launcher
-executable in this directory.
+executable for your platform.
g:ale_java_javalsp_executable *g:ale_java_javalsp_executable*
*b:ale_java_javalsp_executable*
@@ -128,7 +136,7 @@ g:ale_java_javalsp_executable *g:ale_java_javalsp_executable*
This variable must be set to the absolute path of the language server launcher
executable. For example:
>
- let g:ale_java_javalsp_executable=/java-language-server/dist/mac/bin/launcher
+ let g:ale_java_javalsp_executable=/java-language-server/dist/lang_server_linux.sh
<
g:ale_java_javalsp_config *g:ale_java_javalsp_config*