Implement Lua ALE setup & overhaul documentation

1. Add ale.setup and ale.setup.buffer for pure Lua configuration.
2. Update many global settings to use Booleans instead of numbers to
   make types easiert to work with in Lua.
3. Radically reformat documentation and fix errors to make
   documentation more usable for Neovim users.
This commit is contained in:
w0rp
2025-03-20 21:33:12 +00:00
parent 53f036fe9f
commit bcd1a12949
146 changed files with 5469 additions and 2642 deletions

View File

@@ -8,9 +8,11 @@ mix *ale-elixir-mix*
The `mix` linter is disabled by default, as it can be too expensive to run.
See `:help g:ale_linters`
g:ale_elixir_mix_options *g:ale_elixir_mix_options*
*ale-options.elixir_mix_options*
*g:ale_elixir_mix_options*
*b:ale_elixir_mix_options*
elixir_mix_options
g:ale_elixir_mix_options
Type: |String|
Default: `'mix'`
@@ -21,8 +23,11 @@ g:ale_elixir_mix_options *g:ale_elixir_mix_options*
===============================================================================
mix_format *ale-elixir-mix-format*
g:ale_elixir_mix_format_options *g:ale_elixir_mix_format_options*
*ale-options.elixir_mix_format_options*
*g:ale_elixir_mix_format_options*
*b:ale_elixir_mix_format_options*
elixir_mix_format_options
g:ale_elixir_mix_format_options
Type: |String|
Default: `''`
@@ -52,26 +57,33 @@ 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*
*ale-options.elixir_elixir_ls_release*
*g:ale_elixir_elixir_ls_release*
*b:ale_elixir_elixir_ls_release*
elixir_elixir_ls_release
g: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*
*ale-options.elixir_elixir_ls_config*
*g:ale_elixir_elixir_ls_config*
*b:ale_elixir_elixir_ls_config*
elixir_elixir_ls_config
g: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,
\ },
\ }
let g:ale_elixir_elixir_ls_config = {
\ 'elixirLS': {
\ 'dialyzerEnabled': v:false,
\ },
\}
<
Consult the ElixirLS documentation for more information about settings.
@@ -81,17 +93,22 @@ credo *ale-elixir-credo*
Credo (https://github.com/rrrene/credo)
g:ale_elixir_credo_strict *g:ale_elixir_credo_strict*
*ale-options.elixir_credo_strict*
*g:ale_elixir_credo_strict*
*b:ale_elixir_credo_strict*
elixir_credo_strict
g:ale_elixir_credo_strict
Type: |Integer|
Default: `0`
Tells credo to run in strict mode or suggest mode. Set variable to 1 to
enable --strict mode.
g:ale_elixir_credo_config_file *g:ale_elixir_credo_config_file*
*ale-options.elixir_credo_config_file*
*g:ale_elixir_credo_config_file*
*b:ale_elixir_credo_config_file*
elixir_credo_config_file
g:ale_elixir_credo_config_file
Type: |String|
Default: `''`
@@ -109,8 +126,11 @@ lexical *ale-elixir-lexical*
Lexical (https://github.com/lexical-lsp/lexical)
g:ale_elixir_lexical_release *g:ale_elixir_lexical_release*
*ale-options.elixir_lexical_release*
*g:ale_elixir_lexical_release*
*b:ale_elixir_lexical_release*
elixir_lexical_release
g:ale_elixir_lexical_release
Type: |String|
Default: `'lexical'`