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:52:13 +00:00
parent 53f036fe9f
commit bcd1a12949
146 changed files with 5469 additions and 2642 deletions
+25 -11
View File
@@ -17,16 +17,21 @@ See |ale-javascript-prettier| for information about the available options.
===============================================================================
vls *ale-vue-vls*
g:ale_vue_vls_executable *g:ale_vue_vls_executable*
*ale-options.vue_vls_executable*
*g:ale_vue_vls_executable*
*b:ale_vue_vls_executable*
vue_vls_executable
g:ale_vue_vls_executable
Type: |String|
Default: `'vls'`
See |ale-integrations-local-executables|
g:ale_vue_vls_use_global *g:ale_vue_vls_use_global*
*ale-options.vue_vls_use_global*
*g:ale_vue_vls_use_global*
*b:ale_vue_vls_use_global*
vue_vls_use_global
g:ale_vue_vls_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -39,29 +44,38 @@ volar *ale-vue-volar*
It is required to have typescript installed in your project as your dev
dependency: `npm i -D typescript`
g:ale_vue_volar_executable *g:ale_vue_volar_executable*
*ale-options.vue_volar_executable*
*g:ale_vue_volar_executable*
*b:ale_vue_volar_executable*
vue_volar_executable
g:ale_vue_volar_executable
Type: |String|
Default: `'vue-language-server'`
See |ale-integrations-local-executables|
g:ale_vue_volar_use_global *g:ale_vue_volar_use_global*
*ale-options.vue_volar_use_global*
*g:ale_vue_volar_use_global*
*b:ale_vue_volar_use_global*
vue_volar_use_global
g:ale_vue_volar_use_global
Type: |Number|
Default: `1`
See |ale-integrations-local-executables|
g:vue_volar_init_options *g:ale_vue_volar_init_options*
*ale-options.vue_volar_init_options*
*g:ale_vue_volar_init_options*
*b:ale_vue_volar_init_options*
vue_volar_init_options
g:ale_vue_volar_init_options
Type: |Dictionary|
Default: `{ 'typescript': 'tsdk': '' }`
Default: `{'typescript': 'tsdk': ''}`
Default is too long to show here, take a look at it over
`ale_linters/vue/volar.vim`
This option can be configured to set the initialization options for volar.
ALE will automatically replace `tsdk` with local detected path to the
typescript library.
===============================================================================