summaryrefslogtreecommitdiff
path: root/doc/ale-elixir.txt
diff options
context:
space:
mode:
authorJon Parise <jon@indelible.org>2018-10-31 10:24:03 -0700
committerJon Parise <jon@indelible.org>2018-10-31 10:32:48 -0700
commit4bee0f1743d611ca1e6e338d4cb48417f4162f0b (patch)
tree0d06e8ada638ab2a1c31c9c5e6e29e35685e2932 /doc/ale-elixir.txt
parent4b841b55869e3ec5b02806f9b2fe962ffdca2750 (diff)
downloadale-4bee0f1743d611ca1e6e338d4cb48417f4162f0b.zip
Add configuration dictionary support to elixir-ls
This adds generic configuration dictionary support to the elixir-ls linter. This is useful for disabling its built-in Dialyzer support, for example, which can improve startup time. The configuration dictionary is a little verbose. I considered reducing the user configuration to only the nested settings dictionary (and having the linter implementation wrap it in the top-level `elixirLS` dictionary), but leaving it fully configurable simplifies the code and removes any assumptions about current or future ElixirLS behavior.
Diffstat (limited to 'doc/ale-elixir.txt')
-rw-r--r--doc/ale-elixir.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/ale-elixir.txt b/doc/ale-elixir.txt
index 769842a4..30ec3be1 100644
--- a/doc/ale-elixir.txt
+++ b/doc/ale-elixir.txt
@@ -53,5 +53,20 @@ g:ale_elixir_elixir_ls_release *g:ale_elixir_elixir_ls_release*
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: