summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJon Parise <jon@indelible.org>2018-09-28 11:42:50 -0700
committerJon Parise <jon@indelible.org>2018-10-11 08:31:12 -0700
commit7eae7812915602ece637714e6f82d4551e9697b6 (patch)
tree66982c439b1f386dc691be877f25547cea209fa8 /doc
parent87986520d62c497fbbde94e2e6bed35f5489cfcd (diff)
downloadale-7eae7812915602ece637714e6f82d4551e9697b6.zip
Add elixir-ls language server support
ElixirLS (https://github.com/JakeBecker/elixir-ls) is an LSP server for Elixir. It's distributed as a release package that can be downloaded from https://github.com/JakeBecker/elixir-ls/releases or built locally. The easiest way to start it is via Unix- and Win32-specific helper scripts, so that's the basis of this command integration. Alternatively, we could implement the contents of those platform-specific scripts in the linter's command callback in a language-neutral way, but there isn't any benefit to doing that aside from eliminating the platform check, and that could prove to be too tight of a coupling going forward.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-elixir.txt13
-rw-r--r--doc/ale.txt3
2 files changed, 15 insertions, 1 deletions
diff --git a/doc/ale-elixir.txt b/doc/ale-elixir.txt
index ac0ec605..769842a4 100644
--- a/doc/ale-elixir.txt
+++ b/doc/ale-elixir.txt
@@ -41,4 +41,17 @@ See https://github.com/jeremyjh/dialyxir#with-explaining-stuff for more
information.
===============================================================================
+elixir-ls *ale-elixir-elixir-ls*
+
+Elixir Language Server (https://github.com/JakeBecker/elixir-ls)
+
+g:ale_elixir_elixir_ls_release *g:ale_elixir_elixir_ls_release*
+ *b:ale_elixir_elixir_ls_release*
+ Type: |String|
+ Default: `'elixir-ls'`
+
+ Location of the elixir-ls release directory. This directory must contain
+ the language server scripts (language_server.sh and language_server.bat).
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 3c561e2f..27334b9d 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -77,6 +77,7 @@ CONTENTS *ale-contents*
mix.................................|ale-elixir-mix|
mix_format..........................|ale-elixir-mix-format|
dialyxir............................|ale-elixir-dialyxir|
+ elixir-ls...........................|ale-elixir-elixir-ls|
elm...................................|ale-elm-options|
elm-format..........................|ale-elm-elm-format|
elm-make............................|ale-elm-elm-make|
@@ -397,7 +398,7 @@ Notes:
* Dafny: `dafny`!!
* Dart: `dartanalyzer`!!, `language_server`, dartfmt!!
* Dockerfile: `hadolint`
-* Elixir: `credo`, `dialyxir`, `dogma`, `mix`!!
+* Elixir: `credo`, `dialyxir`, `dogma`, `mix`!!, `elixir-ls`
* Elm: `elm-format, elm-make`
* Erb: `erb`, `erubi`, `erubis`
* Erlang: `erlc`, `SyntaxErl`