summaryrefslogtreecommitdiff
path: root/doc/ale-elixir.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ale-elixir.txt')
-rw-r--r--doc/ale-elixir.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/ale-elixir.txt b/doc/ale-elixir.txt
index ac0ec605..45c6de1d 100644
--- a/doc/ale-elixir.txt
+++ b/doc/ale-elixir.txt
@@ -5,6 +5,11 @@ ALE Elixir Integration *ale-elixir-options*
===============================================================================
mix *ale-elixir-mix*
+
+The `mix` linter is disabled by default, as it can bee too expensive to run.
+See `:help g:ale_linters`
+
+
g:ale_elixir_mix_options *g:ale_elixir_mix_options*
*b:ale_elixir_mix_options*
Type: |String|
@@ -41,4 +46,32 @@ 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).
+
+g:ale_elixir_elixir_ls_config *g:ale_elixir_elixir_ls_config*
+ *b:ale_elixir_elixir_ls_config*
+ Type: |Dictionary|
+ Default: `{}`
+
+ Dictionary containing configuration settings that will be passed to the
+ language server. For example, to disable Dialyzer: >
+ {
+ \ 'elixirLS': {
+ \ 'dialyzerEnabled': v:false,
+ \ },
+ \ }
+<
+ Consult the ElixirLS documentation for more information about settings.
+
+===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: