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

@@ -11,16 +11,21 @@ See |ale-cspell-options|
===============================================================================
lua-format *ale-lua-lua-format*
g:ale_lua_lua_format_executable *g:ale_lua_lua_format_executable*
*ale-options.lua_lua_format_executable*
*g:ale_lua_lua_format_executable*
*b:ale_lua_lua_format_executable*
lua_lua_format_executable
g:ale_lua_lua_format_executable
Type: |String|
Default: `'lua-format'`
This variable can be changed to change the path to lua-format.
g:ale_lua_lua_format_options *g:ale_lua_lua_format_options*
*ale-options.lua_lua_format_options*
*g:ale_lua_lua_format_options*
*b:ale_lua_lua_format_options*
lua_lua_format_options
g:ale_lua_lua_format_options
Type: |String|
Default: `''`
@@ -31,8 +36,11 @@ g:ale_lua_lua_format_options *g:ale_lua_lua_format_options*
lua-language-server *ale-lua-lua-language-server*
*ale-lua-language-server*
g:ale_lua_language_server_executable *g:ale_lua_language_server_executable*
*ale-options.lua_language_server_executable*
*g:ale_lua_language_server_executable*
*b:ale_lua_language_server_executable*
lua_language_server_executable
g:ale_lua_language_server_executable
Type: |String|
Default: `'lua-language-server'`
@@ -41,9 +49,11 @@ g:ale_lua_language_server_executable *g:ale_lua_language_server_executable*
If you have compiled the language server yourself in `/some/path`, the path
will be `'/some/path/bin/lua-language-server'`.
g:ale_lua_lua_language_server_config *g:ale_lua_lua_language_server_config*
*ale-options.lua_lua_language_server_config*
*g:ale_lua_lua_language_server_config*
*b:ale_lua_lua_language_server_config*
lua_lua_language_server_config
g:ale_lua_lua_language_server_config
Type: |Dictionary|
Default: `{}`
@@ -54,8 +64,11 @@ g:ale_lua_lua_language_server_config *g:ale_lua_lua_language_server_config*
===============================================================================
luac *ale-lua-luac*
g:ale_lua_luac_executable *g:ale_lua_luac_executable*
*ale-options.lua_luac_executable*
*g:ale_lua_luac_executable*
*b:ale_lua_luac_executable*
lua_luac_executable
g:ale_lua_luac_executable
Type: |String|
Default: `'luac'`
@@ -65,16 +78,21 @@ g:ale_lua_luac_executable *g:ale_lua_luac_executable*
===============================================================================
luacheck *ale-lua-luacheck*
g:ale_lua_luacheck_executable *g:ale_lua_luacheck_executable*
*ale-options.lua_luacheck_executable*
*g:ale_lua_luacheck_executable*
*b:ale_lua_luacheck_executable*
lua_luacheck_executable
g:ale_lua_luacheck_executable
Type: |String|
Default: `'luacheck'`
This variable can be changed to change the path to luacheck.
g:ale_lua_luacheck_options *g:ale_lua_luacheck_options*
*ale-options.lua_luacheck_options*
*g:ale_lua_luacheck_options*
*b:ale_lua_luacheck_options*
lua_luacheck_options
g:ale_lua_luacheck_options
Type: |String|
Default: `''`
@@ -84,16 +102,21 @@ g:ale_lua_luacheck_options *g:ale_lua_luacheck_options*
===============================================================================
luafmt *ale-lua-luafmt*
g:ale_lua_luafmt_executable *g:ale_lua_luafmt_executable*
*ale-options.lua_luafmt_executable*
*g:ale_lua_luafmt_executable*
*b:ale_lua_luafmt_executable*
lua_luafmt_executable
g:ale_lua_luafmt_executable
Type: |String|
Default: `'luafmt'`
This variable can be set to use a different executable for luafmt.
g:ale_lua_luafmt_options *g:ale_lua_luafmt_options*
*ale-options.lua_luafmt_options*
*g:ale_lua_luafmt_options*
*b:ale_lua_luafmt_options*
lua_luafmt_options
g:ale_lua_luafmt_options
Type: |String|
Default: `''`
@@ -103,16 +126,21 @@ g:ale_lua_luafmt_options *g:ale_lua_luafmt_options*
===============================================================================
selene *ale-lua-selene*
g:ale_lua_selene_executable *g:ale_lua_selene_executable*
*ale-options.lua_selene_executable*
*g:ale_lua_selene_executable*
*b:ale_lua_selene_executable*
lua_selene_executable
g:ale_lua_selene_executable
Type: |String|
Default: `'selene'`
This variable can be set to use a different executable for selene.
g:ale_lua_selene_options *g:ale_lua_selene_options*
*ale-options.lua_selene_options*
*g:ale_lua_selene_options*
*b:ale_lua_selene_options*
lua_selene_options
g:ale_lua_selene_options
Type: |String|
Default: `''`
@@ -122,16 +150,21 @@ g:ale_lua_selene_options *g:ale_lua_selene_options*
===============================================================================
stylua *ale-lua-stylua*
g:ale_lua_stylua_executable *g:ale_lua_stylua_executable*
*ale-options.lua_stylua_executable*
*g:ale_lua_stylua_executable*
*b:ale_lua_stylua_executable*
lua_stylua_executable
g:ale_lua_stylua_executable
Type: |String|
Default: `'stylua'`
This variable can be set to use a different executable for stylua.
g:ale_lua_stylua_options *g:ale_lua_stylua_options*
*ale-options.lua_stylua_options*
*g:ale_lua_stylua_options*
*b:ale_lua_stylua_options*
lua_stylua_options
g:ale_lua_stylua_options
Type: |String|
Default: `''`