4bee0f1743
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.
72 lines
2.7 KiB
Text
72 lines
2.7 KiB
Text
===============================================================================
|
|
ALE Elixir Integration *ale-elixir-options*
|
|
|
|
|
|
===============================================================================
|
|
mix *ale-elixir-mix*
|
|
|
|
g:ale_elixir_mix_options *g:ale_elixir_mix_options*
|
|
*b:ale_elixir_mix_options*
|
|
Type: |String|
|
|
Default: `'mix'`
|
|
|
|
|
|
This variable can be changed to specify the mix executable.
|
|
|
|
===============================================================================
|
|
mix_format *ale-elixir-mix-format*
|
|
|
|
g:ale_elixir_mix_format_options *g:ale_elixir_mix_format_options*
|
|
*b:ale_elixir_mix_format_options*
|
|
Type: |String|
|
|
Default: `''`
|
|
|
|
|
|
This variable can be changed to specify the mix options passed to the
|
|
mix_format fixer
|
|
|
|
===============================================================================
|
|
dialyxir *ale-elixir-dialyxir*
|
|
|
|
Dialyzer, a DIscrepancy AnaLYZer for ERlang programs.
|
|
http://erlang.org/doc/man/dialyzer.html
|
|
|
|
It can be used with elixir through dialyxir
|
|
https://github.com/jeremyjh/dialyxir
|
|
|
|
Options for dialyzer are not configurable by ale, but they are instead
|
|
configured on your project's `mix.exs`.
|
|
|
|
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:
|