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 2280d41b30
commit 400857d758
146 changed files with 5469 additions and 2642 deletions
+1 -1
View File
@@ -63,7 +63,7 @@ function! ale_linters#python#flake8#GetCwd(buffer) abort
endif endif
if (l:change_directory is# 'project' && empty(l:cwd)) if (l:change_directory is# 'project' && empty(l:cwd))
\|| l:change_directory is# 1 \|| l:change_directory
\|| l:change_directory is# 'file' \|| l:change_directory is# 'file'
let l:cwd = '%s:h' let l:cwd = '%s:h'
endif endif
+1 -1
View File
@@ -63,7 +63,7 @@ function! ale_linters#python#flakehell#GetCwd(buffer) abort
endif endif
if (l:change_directory is# 'project' && empty(l:cwd)) if (l:change_directory is# 'project' && empty(l:cwd))
\|| l:change_directory is# 1 \|| l:change_directory
\|| l:change_directory is# 'file' \|| l:change_directory is# 'file'
let l:cwd = '%s:h' let l:cwd = '%s:h'
endif endif
+1 -1
View File
@@ -82,7 +82,7 @@ function! ale_linters#python#pylint#Handle(buffer, lines) abort
continue continue
endif endif
if ale#Var(a:buffer, 'python_pylint_use_msg_id') is# 1 if ale#Var(a:buffer, 'python_pylint_use_msg_id')
let l:code_out = l:code let l:code_out = l:code
else else
let l:code_out = l:match[4] let l:code_out = l:match[4]
+8 -10
View File
@@ -16,7 +16,7 @@ onoremap <silent> <Plug>(ale_show_completion_menu) <Nop>
let g:ale_completion_delay = get(g:, 'ale_completion_delay', 100) let g:ale_completion_delay = get(g:, 'ale_completion_delay', 100)
let g:ale_completion_excluded_words = get(g:, 'ale_completion_excluded_words', []) let g:ale_completion_excluded_words = get(g:, 'ale_completion_excluded_words', [])
let g:ale_completion_max_suggestions = get(g:, 'ale_completion_max_suggestions', 50) let g:ale_completion_max_suggestions = get(g:, 'ale_completion_max_suggestions', 50)
let g:ale_completion_autoimport = get(g:, 'ale_completion_autoimport', 1) let g:ale_completion_autoimport = get(g:, 'ale_completion_autoimport', v:true)
let g:ale_completion_tsserver_remove_warnings = get(g:, 'ale_completion_tsserver_remove_warnings', 0) let g:ale_completion_tsserver_remove_warnings = get(g:, 'ale_completion_tsserver_remove_warnings', 0)
let s:timer_id = -1 let s:timer_id = -1
@@ -394,6 +394,7 @@ function! ale#completion#Show(result) abort
if g:ale_enabled if g:ale_enabled
\&& ( \&& (
\ l:text_changed is# '1' \ l:text_changed is# '1'
\ || g:ale_lint_on_text_changed is v:true
\ || l:text_changed is# 'always' \ || l:text_changed is# 'always'
\ || l:text_changed is# 'normal' \ || l:text_changed is# 'normal'
\ || l:text_changed is# 'insert' \ || l:text_changed is# 'insert'
@@ -510,7 +511,7 @@ function! ale#completion#ParseTSServerCompletionEntryDetails(response) abort
\ 'icase': 1, \ 'icase': 1,
\ 'menu': join(l:displayParts, ''), \ 'menu': join(l:displayParts, ''),
\ 'dup': get(l:info, 'additional_edits_only', 0) \ 'dup': get(l:info, 'additional_edits_only', 0)
\ || g:ale_completion_autoimport, \ || (g:ale_completion_autoimport + 0),
\ 'info': join(l:documentationParts, ''), \ 'info': join(l:documentationParts, ''),
\} \}
" This flag is used to tell if this completion came from ALE or not. " This flag is used to tell if this completion came from ALE or not.
@@ -625,7 +626,7 @@ function! ale#completion#ParseLSPCompletions(response) abort
\ 'icase': 1, \ 'icase': 1,
\ 'menu': l:detail, \ 'menu': l:detail,
\ 'dup': get(l:info, 'additional_edits_only', 0) \ 'dup': get(l:info, 'additional_edits_only', 0)
\ || g:ale_completion_autoimport, \ || (g:ale_completion_autoimport + 0),
\ 'info': (type(l:doc) is v:t_string ? l:doc : ''), \ 'info': (type(l:doc) is v:t_string ? l:doc : ''),
\} \}
" This flag is used to tell if this completion came from ALE or not. " This flag is used to tell if this completion came from ALE or not.
@@ -779,18 +780,15 @@ function! s:OnReady(linter, lsp_details) abort
call ale#lsp#RegisterCallback(l:id, l:Callback) call ale#lsp#RegisterCallback(l:id, l:Callback)
if a:linter.lsp is# 'tsserver' if a:linter.lsp is# 'tsserver'
if get(g:, 'ale_completion_tsserver_autoimport') is 1
" no-custom-checks
echom '`g:ale_completion_tsserver_autoimport` is deprecated. Use `g:ale_completion_autoimport` instead.'
endif
let l:message = ale#lsp#tsserver_message#Completions( let l:message = ale#lsp#tsserver_message#Completions(
\ l:buffer, \ l:buffer,
\ b:ale_completion_info.line, \ b:ale_completion_info.line,
\ b:ale_completion_info.column, \ b:ale_completion_info.column,
\ b:ale_completion_info.prefix, \ b:ale_completion_info.prefix,
\ get(b:ale_completion_info, 'additional_edits_only', 0) \ (
\ || g:ale_completion_autoimport, \ get(b:ale_completion_info, 'additional_edits_only', 0)
\ || g:ale_completion_autoimport
\ ) ? v:true : v:false,
\) \)
else else
" Send a message saying the buffer has changed first, otherwise " Send a message saying the buffer has changed first, otherwise
+1 -1
View File
@@ -4,7 +4,7 @@
let s:go_to_definition_map = {} let s:go_to_definition_map = {}
" Enable automatic updates of the tagstack " Enable automatic updates of the tagstack
let g:ale_update_tagstack = get(g:, 'ale_update_tagstack', 1) let g:ale_update_tagstack = get(g:, 'ale_update_tagstack', v:true)
let g:ale_default_navigation = get(g:, 'ale_default_navigation', 'buffer') let g:ale_default_navigation = get(g:, 'ale_default_navigation', 'buffer')
" Used to get the definition map in tests. " Used to get the definition map in tests.
+1 -1
View File
@@ -68,7 +68,7 @@ function! ale#engine#IsExecutable(buffer, executable) abort
" Cache the executable check if we found it, or if the option to cache " Cache the executable check if we found it, or if the option to cache
" failing checks is on. " failing checks is on.
if l:result || get(g:, 'ale_cache_executable_check_failures', 0) if l:result || get(g:, 'ale_cache_executable_check_failures')
let s:executable_cache_map[a:executable] = l:result let s:executable_cache_map[a:executable] = l:result
endif endif
+3 -1
View File
@@ -173,7 +173,9 @@ function! ale#events#Init() abort
autocmd BufWritePost * call ale#events#SaveEvent(str2nr(expand('<abuf>'))) autocmd BufWritePost * call ale#events#SaveEvent(str2nr(expand('<abuf>')))
if g:ale_enabled if g:ale_enabled
if l:text_changed is? 'always' || l:text_changed is# '1' if l:text_changed is? 'always'
\|| l:text_changed is# '1'
\|| g:ale_lint_on_text_changed is v:true
autocmd TextChanged,TextChangedI * call ale#Queue(ale#Var(str2nr(expand('<abuf>')), 'lint_delay')) autocmd TextChanged,TextChangedI * call ale#Queue(ale#Var(str2nr(expand('<abuf>')), 'lint_delay'))
elseif l:text_changed is? 'normal' elseif l:text_changed is? 'normal'
autocmd TextChanged * call ale#Queue(ale#Var(str2nr(expand('<abuf>')), 'lint_delay')) autocmd TextChanged * call ale#Queue(ale#Var(str2nr(expand('<abuf>')), 'lint_delay'))
+2 -2
View File
@@ -2,11 +2,11 @@
" Description: Manages the loclist and quickfix lists " Description: Manages the loclist and quickfix lists
" This flag dictates if ale open the configured loclist " This flag dictates if ale open the configured loclist
let g:ale_open_list = get(g:, 'ale_open_list', 0) let g:ale_open_list = get(g:, 'ale_open_list', v:false)
" This flag dictates if ale keeps open loclist even if there is no error in loclist " This flag dictates if ale keeps open loclist even if there is no error in loclist
let g:ale_keep_list_window_open = get(g:, 'ale_keep_list_window_open', 0) let g:ale_keep_list_window_open = get(g:, 'ale_keep_list_window_open', 0)
" This flag dictates that quickfix windows should be opened vertically " This flag dictates that quickfix windows should be opened vertically
let g:ale_list_vertical = get(g:, 'ale_list_vertical', 0) let g:ale_list_vertical = get(g:, 'ale_list_vertical', v:false)
" The window size to set for the quickfix and loclist windows " The window size to set for the quickfix and loclist windows
let g:ale_list_window_size = get(g:, 'ale_list_window_size', 10) let g:ale_list_window_size = get(g:, 'ale_list_window_size', 10)
" A string format for the loclist messages. " A string format for the loclist messages.
+1 -1
View File
@@ -219,7 +219,7 @@ function! ale#lsp_linter#HandleLSPResponse(conn_id, response) abort
call s:HandleTSServerDiagnostics(a:response, 'syntax') call s:HandleTSServerDiagnostics(a:response, 'syntax')
elseif get(a:response, 'type', '') is# 'event' elseif get(a:response, 'type', '') is# 'event'
\&& get(a:response, 'event', '') is# 'suggestionDiag' \&& get(a:response, 'event', '') is# 'suggestionDiag'
\&& get(g:, 'ale_lsp_suggestions', '1') == 1 \&& get(g:, 'ale_lsp_suggestions')
call s:HandleTSServerDiagnostics(a:response, 'suggestion') call s:HandleTSServerDiagnostics(a:response, 'suggestion')
endif endif
endfunction endfunction
+2 -2
View File
@@ -17,8 +17,8 @@ function! ale#rename#ClearLSPData() abort
let s:rename_map = {} let s:rename_map = {}
endfunction endfunction
let g:ale_rename_tsserver_find_in_comments = get(g:, 'ale_rename_tsserver_find_in_comments') let g:ale_rename_tsserver_find_in_comments = get(g:, 'ale_rename_tsserver_find_in_comments', v:false)
let g:ale_rename_tsserver_find_in_strings = get(g:, 'ale_rename_tsserver_find_in_strings') let g:ale_rename_tsserver_find_in_strings = get(g:, 'ale_rename_tsserver_find_in_strings', v:false)
function! s:message(message) abort function! s:message(message) abort
call ale#util#Execute('echom ' . string(a:message)) call ale#util#Execute('echom ' . string(a:message))
+3 -3
View File
@@ -7,7 +7,7 @@ scriptencoding utf8
let g:ale_max_signs = get(g:, 'ale_max_signs', -1) let g:ale_max_signs = get(g:, 'ale_max_signs', -1)
" This flag can be set to 1 to enable changing the sign column colors when " This flag can be set to 1 to enable changing the sign column colors when
" there are errors. " there are errors.
let g:ale_change_sign_column_color = get(g:, 'ale_change_sign_column_color', 0) let g:ale_change_sign_column_color = get(g:, 'ale_change_sign_column_color', v:false)
" These variables dictate what signs are used to indicate errors and warnings. " These variables dictate what signs are used to indicate errors and warnings.
let g:ale_sign_error = get(g:, 'ale_sign_error', 'E') let g:ale_sign_error = get(g:, 'ale_sign_error', 'E')
let g:ale_sign_style_error = get(g:, 'ale_sign_style_error', g:ale_sign_error) let g:ale_sign_style_error = get(g:, 'ale_sign_style_error', g:ale_sign_error)
@@ -20,8 +20,8 @@ let g:ale_sign_priority = get(g:, 'ale_sign_priority', 30)
" The dummy sign will use the ID exactly equal to the offset. " The dummy sign will use the ID exactly equal to the offset.
let g:ale_sign_offset = get(g:, 'ale_sign_offset', 1000000) let g:ale_sign_offset = get(g:, 'ale_sign_offset', 1000000)
" This flag can be set to 1 to keep sign gutter always open " This flag can be set to 1 to keep sign gutter always open
let g:ale_sign_column_always = get(g:, 'ale_sign_column_always', 0) let g:ale_sign_column_always = get(g:, 'ale_sign_column_always', v:false)
let g:ale_sign_highlight_linenrs = get(g:, 'ale_sign_highlight_linenrs', 0) let g:ale_sign_highlight_linenrs = get(g:, 'ale_sign_highlight_linenrs', v:false)
let s:supports_sign_groups = has('nvim-0.4.2') || has('patch-8.1.614') let s:supports_sign_groups = has('nvim-0.4.2') || has('patch-8.1.614')
+1 -1
View File
@@ -32,7 +32,7 @@ let g:ale_virtualtext_delay = get(g:, 'ale_virtualtext_delay', 10)
let g:ale_virtualtext_column = get(g:, 'ale_virtualtext_column', 0) let g:ale_virtualtext_column = get(g:, 'ale_virtualtext_column', 0)
let g:ale_virtualtext_maxcolumn = get(g:, 'ale_virtualtext_maxcolumn', 0) let g:ale_virtualtext_maxcolumn = get(g:, 'ale_virtualtext_maxcolumn', 0)
" If 1, only show the first problem with virtualtext. " If 1, only show the first problem with virtualtext.
let g:ale_virtualtext_single = get(g:, 'ale_virtualtext_single', 1) let g:ale_virtualtext_single = get(g:, 'ale_virtualtext_single', v:true)
let s:cursor_timer = get(s:, 'cursor_timer', -1) let s:cursor_timer = get(s:, 'cursor_timer', -1)
let s:last_pos = get(s:, 'last_pos', [0, 0, 0]) let s:last_pos = get(s:, 'last_pos', [0, 0, 0])
+30 -14
View File
@@ -7,19 +7,25 @@ cspell *ale-ada-cspell*
See |ale-cspell-options| See |ale-cspell-options|
=============================================================================== ===============================================================================
gcc *ale-ada-gcc* gcc *ale-ada-gcc*
g:ale_ada_gcc_executable *g:ale_ada_gcc_executable* *ale-options.ada_gcc_executable*
*g:ale_ada_gcc_executable*
*b:ale_ada_gcc_executable* *b:ale_ada_gcc_executable*
ada_gcc_executable
g:ale_ada_gcc_executable
Type: |String| Type: |String|
Default: `'gcc'` Default: `'gcc'`
This variable can be changed to use a different executable for gcc. This variable can be changed to use a different executable for gcc.
*ale-options.ada_gcc_options*
g:ale_ada_gcc_options *g:ale_ada_gcc_options* *g:ale_ada_gcc_options*
*b:ale_ada_gcc_options* *b:ale_ada_gcc_options*
ada_gcc_options
g:ale_ada_gcc_options
Type: |String| Type: |String|
Default: `'-gnatwa -gnatq'` Default: `'-gnatwa -gnatq'`
@@ -29,8 +35,11 @@ g:ale_ada_gcc_options *g:ale_ada_gcc_options*
=============================================================================== ===============================================================================
gnatpp *ale-ada-gnatpp* gnatpp *ale-ada-gnatpp*
g:ale_ada_gnatpp_options *g:ale_ada_gnatpp_options* *ale-options.ada_gnatpp_options*
*g:ale_ada_gnatpp_options*
*b:ale_ada_gnatpp_options* *b:ale_ada_gnatpp_options*
ada_gnatpp_options
g:ale_ada_gnatpp_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -40,31 +49,38 @@ g:ale_ada_gnatpp_options *g:ale_ada_gnatpp_options*
=============================================================================== ===============================================================================
ada-language-server *ale-ada-language-server* ada-language-server *ale-ada-language-server*
g:ale_ada_adals_executable *g:ale_ada_adals_executable* *ale-options.ada_adals_executable*
*g:ale_ada_adals_executable*
*b:ale_ada_adals_executable* *b:ale_ada_adals_executable*
ada_adals_executable
g:ale_ada_adals_executable
Type: |String| Type: |String|
Default: `'ada_language_server'` Default: `'ada_language_server'`
This variable can be changed to use a different executable for Ada Language This variable can be changed to use a different executable for Ada Language
Server. Server.
*ale-options.ada_adals_project*
g:ale_ada_adals_project *g:ale_ada_adals_project* *g:ale_ada_adals_project*
*b:ale_ada_adals_project* *b:ale_ada_adals_project*
ada_adals_project
g:ale_ada_adals_project
Type: |String| Type: |String|
Default: `'default.gpr'` Default: `'default.gpr'`
This variable can be changed to use a different GPR file for This variable can be changed to use a different GPR file for Ada Language
Ada Language Server. Server.
*ale-options.ada_adals_encoding*
g:ale_ada_adals_encoding *g:ale_ada_adals_encoding* *g:ale_ada_adals_encoding*
*b:ale_ada_adals_encoding* *b:ale_ada_adals_encoding*
ada_adals_encoding
g:ale_ada_adals_encoding
Type: |String| Type: |String|
Default: `'utf-8'` Default: `'utf-8'`
This variable can be changed to use a different file encoding for This variable can be changed to use a different file encoding for Ada
Ada Language Server. Language Server.
=============================================================================== ===============================================================================
+21 -12
View File
@@ -1,34 +1,43 @@
=============================================================================== ===============================================================================
ALE Ansible Integration *ale-ansible-options* ALE Ansible Integration *ale-ansible-options*
=============================================================================== ===============================================================================
ansible-language-server *ale-ansible-language-server* ansible-language-server *ale-ansible-language-server*
g:ale_ansible_language_server_executable *g:ale_ansible_language_server* *ale-options.ansible_language_server_executable*
*b:ale_ansible_language_server* *g:ale_ansible_language_server_executable*
*b:ale_ansible_language_server_executable*
ansible_language_server_executable
g:ale_ansible_language_server_executable
Type: |String| Type: |String|
Default: 'ansible-language-server' Default: `'ansible-language-server'`
Variable can be used to modify the executable used for ansible language server. Variable can be used to modify the executable used for Ansible language
server.
g:ale_ansible_language_server_config *g:ale_ansible_language_server_config*
*b:ale_ansible_language_server_config*
*ale-options.ansible_language_server_config*
*g:ale_ansible_language_server_config*
*b:ale_ansible_language_server_config*
ansible_language_server_config
g:ale_ansible_language_server_config
Type: |Dictionary| Type: |Dictionary|
Default: '{}' Default: `'{}'`
Configuration parameters sent to the language server on start. Refer to the Configuration parameters sent to the language server on start. Refer to the
ansible language server configuration documentation for list of available ansible language server configuration documentation for list of available
options: https://als.readthedocs.io/en/latest/settings/ options: https://als.readthedocs.io/en/latest/settings/
=============================================================================== ===============================================================================
ansible-lint *ale-ansible-ansible-lint* ansible-lint *ale-ansible-ansible-lint*
g:ale_ansible_ansible_lint_executable *g:ale_ansible_ansible_lint_executable* *ale-options.ansible_ansible_lint_executable*
*g:ale_ansible_ansible_lint_executable*
*b:ale_ansible_ansible_lint_executable* *b:ale_ansible_ansible_lint_executable*
ansible_ansible_lint_executable
g:ale_ansible_ansible_lint_executable
Type: |String| Type: |String|
Default: `'ansible-lint'` Default: `'ansible-lint'`
+23 -13
View File
@@ -5,27 +5,33 @@ ALE APKBUILD Integration *ale-apkbuild-options*
=============================================================================== ===============================================================================
apkbuild-fixer *ale-apkbuild-apkbuild-fixer* apkbuild-fixer *ale-apkbuild-apkbuild-fixer*
g:apkbuild_apkbuild_fixer_options *g:apkbuild_apkbuild_fixer_options* *ale-options.apkbuild_apkbuild_fixer_options*
*b:apkbuild_apkbuild_fixer_options* *g:ale_apkbuild_apkbuild_fixer_options*
*b:ale_apkbuild_apkbuild_fixer_options*
apkbuild_apkbuild_fixer_options
g:ale_apkbuild_apkbuild_fixer_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to the apkbuild_fixer This variable can be set to pass additional options to the apkbuild_fixer
fixer. fixer.
*ale-options.apkbuild_apkbuild_fixer_executable*
g:apkbuild_apkbuild_fixer_executable *g:apkbuild_apkbuild_fixer_executable* *g:ale_apkbuild_apkbuild_fixer_executable*
*b:apkbuild_apkbuild_fixer_executable* *b:ale_apkbuild_apkbuild_fixer_executable*
apkbuild_apkbuild_fixer_executable
g:ale_apkbuild_apkbuild_fixer_executable
Type: |String| Type: |String|
Default: `'apkbuild-fixer'` Default: `'apkbuild-fixer'`
This variable can be modified to change the executable path for This variable can be modified to change the executable path for
`apkbuild-fixer`. `apkbuild-fixer`.
*ale-options.apkbuild_apkbuild_fixer_lint_executable*
g:apkbuild_apkbuild_fixer_lint_executable *g:ale_apkbuild_apkbuild_fixer_lint_executable*
*g:apkbuild_apkbuild_fixer_lint_executable* *b:ale_apkbuild_apkbuild_fixer_lint_executable*
*b:apkbuild_apkbuild_fixer_lint_executable* apkbuild_apkbuild_fixer_lint_executable
g:ale_apkbuild_apkbuild_fixer_lint_executable
Type: |String| Type: |String|
Default: `'apkbuild-fixer'` Default: `'apkbuild-fixer'`
@@ -36,26 +42,30 @@ g:apkbuild_apkbuild_fixer_lint_executable
=============================================================================== ===============================================================================
apkbuild-lint *ale-apkbuild-apkbuild-lint* apkbuild-lint *ale-apkbuild-apkbuild-lint*
g:ale_apkbuild_apkbuild_lint_executable *ale-options.apkbuild_apkbuild_lint_executable*
*g:ale_apkbuild_apkbuild_lint_executable* *g:ale_apkbuild_apkbuild_lint_executable*
*b:ale_apkbuild_apkbuild_lint_executable* *b:ale_apkbuild_apkbuild_lint_executable*
apkbuild_apkbuild_lint_executable
g:ale_apkbuild_apkbuild_lint_executable
Type: |String| Type: |String|
Default: `'apkbuild-lint'` Default: `'apkbuild-lint'`
This variable can be set to change the path to apkbuild-lint This variable can be set to change the path to apkbuild-lint
=============================================================================== ===============================================================================
secfixes-check *ale-apkbuild-secfixes-check* secfixes-check *ale-apkbuild-secfixes-check*
g:ale_apkbuild_secfixes_check_executable *ale-options.apkbuild_secfixes_check_executable*
*g:ale_apkbuild_secfixes_check_executable* *g:ale_apkbuild_secfixes_check_executable*
*b:ale_apkbuild_secfixes_check_executable* *b:ale_apkbuild_secfixes_check_executable*
apkbuild_secfixes_check_executable
g:ale_apkbuild_secfixes_check_executable
Type: |String| Type: |String|
Default: `'secfixes-check'` Default: `'secfixes-check'`
This variable can be set to change the path to secfixes-check This variable can be set to change the path to secfixes-check
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+17 -7
View File
@@ -5,16 +5,21 @@ ALE ASM Integration *ale-asm-options*
=============================================================================== ===============================================================================
gcc *ale-asm-gcc* gcc *ale-asm-gcc*
g:ale_asm_gcc_executable *g:ale_asm_gcc_executable* *ale-options.asm_gcc_executable*
*g:ale_asm_gcc_executable*
*b:ale_asm_gcc_executable* *b:ale_asm_gcc_executable*
asm_gcc_executable
g:ale_asm_gcc_executable
Type: |String| Type: |String|
Default: `'gcc'` Default: `'gcc'`
This variable can be changed to use a different executable for gcc. This variable can be changed to use a different executable for gcc.
*ale-options.asm_gcc_options*
g:ale_asm_gcc_options *g:ale_asm_gcc_options* *g:ale_asm_gcc_options*
*b:ale_asm_gcc_options* *b:ale_asm_gcc_options*
asm_gcc_options
g:ale_asm_gcc_options
Type: |String| Type: |String|
Default: `'-Wall'` Default: `'-Wall'`
@@ -24,16 +29,21 @@ g:ale_asm_gcc_options *g:ale_asm_gcc_options*
=============================================================================== ===============================================================================
llvm_mc *ale-asm-llvm_mc* llvm_mc *ale-asm-llvm_mc*
g:ale_asm_clang_executable *g:ale_asm_llvm_mc_executable* *ale-options.asm_llvm_mc_executable*
*g:ale_asm_llvm_mc_executable*
*b:ale_asm_llvm_mc_executable* *b:ale_asm_llvm_mc_executable*
asm_llvm_mc_executable
g:ale_asm_llvm_mc_executable
Type: |String| Type: |String|
Default: `'llvm-mc'` Default: `'llvm-mc'`
This variable can be changed to use a different executable for llvm-mc. This variable can be changed to use a different executable for llvm-mc.
*ale-options.asm_llvm_mc_options*
g:ale_asm_clang_options *g:ale_asm_llvm_mc_options* *g:ale_asm_llvm_mc_options*
*b:ale_asm_llvm_mc_options* *b:ale_asm_llvm_mc_options*
asm_llvm_mc_options
g:ale_asm_llvm_mc_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+8 -4
View File
@@ -5,17 +5,21 @@ ALE AVRA Integration *ale-avra-options*
=============================================================================== ===============================================================================
avra *ale-avra-avra* avra *ale-avra-avra*
g:ale_avra_avra_executable *g:ale_avra_avra_executable* *ale-options.avra_avra_executable*
*g:ale_avra_avra_executable*
*b:ale_avra_avra_executable* *b:ale_avra_avra_executable*
avra_avra_executable
g:ale_avra_avra_executable
Type: |String| Type: |String|
Default `'avra'` Default `'avra'`
This variable can be changed to use different executable for AVRA. This variable can be changed to use different executable for AVRA.
*ale-options.avra_avra_options*
g:ale_avra_avra_options *g:ale_avra_avra_options* *g:ale_avra_avra_options*
*b:ale_avra_avra_options* *b:ale_avra_avra_options*
avra_avra_options
g:ale_avra_avra_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+11 -5
View File
@@ -5,21 +5,27 @@ ALE Awk Integration *ale-awk-options*
=============================================================================== ===============================================================================
gawk *ale-awk-gawk* gawk *ale-awk-gawk*
g:ale_awk_gawk_executable *g:ale_awk_gawk_executable* *ale-options.awk_gawk_executable*
*g:ale_awk_gawk_executable*
*b:ale_awk_gawk_executable* *b:ale_awk_gawk_executable*
awk_gawk_executable
g:ale_awk_gawk_executable
Type: |String| Type: |String|
Default: `'gawk'` Default: `'gawk'`
This variable sets executable used for gawk. This variable sets executable used for gawk.
*ale-options.awk_gawk_options*
g:ale_awk_gawk_options *g:ale_awk_gawk_options* *g:ale_awk_gawk_options*
*b:ale_awk_gawk_options* *b:ale_awk_gawk_options*
awk_gawk_options
g:ale_awk_gawk_options
Type: |String| Type: |String|
Default: `''` Default: `''`
With this variable we are able to pass extra arguments for gawk With this variable we are able to pass extra arguments for gawk for
for invocation. invocation.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+16 -5
View File
@@ -4,25 +4,36 @@ ALE Bazel Integration *ale-bazel-options*
=============================================================================== ===============================================================================
buildifier *ale-bazel-buildifier* buildifier *ale-bazel-buildifier*
g:ale_bazel_buildifier_executable *g:ale_bazel_buildifier_executable* *ale-options.bazel_buildifier_executable*
*g:ale_bazel_buildifier_executable*
*b:ale_bazel_buildifier_executable* *b:ale_bazel_buildifier_executable*
bazel_buildifier_executable
g:ale_bazel_buildifier_executable
Type: |String| Type: |String|
Default: `'buildifier'` Default: `'buildifier'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.bazel_buildifier_options*
g:ale_bazel_buildifier_options *g:ale_bazel_buildifier_options* *g:ale_bazel_buildifier_options*
*b:ale_bazel_buildifier_options* *b:ale_bazel_buildifier_options*
bazel_buildifier_options
g:ale_bazel_buildifier_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass extra options to buildifier. This variable can be set to pass extra options to buildifier.
*ale-options.bazel_buildifier_use_global*
g:ale_bazel_buildifier_use_global *g:ale_bazel_buildifier_use_global* *g:ale_bazel_buildifier_use_global*
*b:ale_bazel_buildifier_use_global* *b:ale_bazel_buildifier_use_global*
bazel_buildifier_use_global
g:ale_bazel_buildifier_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+11 -4
View File
@@ -5,15 +5,22 @@ ALE BibTeX Integration *ale-bib-options*
=============================================================================== ===============================================================================
bibclean *ale-bib-bibclean* bibclean *ale-bib-bibclean*
g:ale_bib_bibclean_executable *g:ale_bib_bibclean_executable* *ale-options.bib_bibclean_executable*
*g:ale_bib_bibclean_executable*
*b:ale_bib_bibclean_executable*
bib_bibclean_executable
g:ale_bib_bibclean_executable
Type: |String| Type: |String|
Default: `'bibclean'` Default: `'bibclean'`
g:ale_bib_bibclean_options *g:ale_bib_bibclean_options* *ale-options.bib_bibclean_options*
*g:ale_bib_bibclean_options*
*b:ale_bib_bibclean_options*
bib_bibclean_options
g:ale_bib_bibclean_options
Type: |String| Type: |String|
Default: `'-align-equals'` Default: `'-align-equals'`
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+24 -13
View File
@@ -1,20 +1,25 @@
=============================================================================== ===============================================================================
ALE Bicep Integration *ale-bicep-options* ALE Bicep Integration *ale-bicep-options*
=============================================================================== ===============================================================================
bicep *ale-bicep-bicep* bicep *ale-bicep-bicep*
g:ale_bicep_bicep_executable *g:ale_bicep_bicep_executable* *ale-options.bicep_bicep_executable*
*b:ale_bicep_bicep_executable* *g:ale_bicep_bicep_executable*
*b:ale_bicep_bicep_executable*
bicep_bicep_executable
g:ale_bicep_bicep_executable
Type: |String| Type: |String|
Default: `'bicep'` Default: `'bicep'`
This variable can be set to change the path to bicep. This variable can be set to change the path to bicep.
*ale-options.bicep_bicep_options*
g:ale_bicep_bicep_options *g:ale_bicep_bicep_options* *g:ale_bicep_bicep_options*
*b:ale_bicep_bicep_options* *b:ale_bicep_bicep_options*
bicep_bicep_options
g:ale_bicep_bicep_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -22,22 +27,28 @@ g:ale_bicep_bicep_options *g:ale_bicep_bicep_options*
=============================================================================== ===============================================================================
az_bicep *ale-bicep-az_bicep* az_bicep *ale-bicep-az_bicep*
g:ale_bicep_az_bicep_executable *g:ale_bicep_az_bicep_executable* *ale-options.bicep_az_bicep_executable*
*b:ale_bicep_az_bicep_executable* *g:ale_bicep_az_bicep_executable*
*b:ale_bicep_az_bicep_executable*
bicep_az_bicep_executable
g:ale_bicep_az_bicep_executable
Type: |String| Type: |String|
Default: `'az'` Default: `'az'`
This variable can be set to change the path to az_bicep. This variable can be set to change the path to az_bicep.
*ale-options.bicep_az_bicep_options*
g:ale_bicep_az_bicep_options *g:ale_bicep_az_bicep_options* *g:ale_bicep_az_bicep_options*
*b:ale_bicep_az_bicep_options* *b:ale_bicep_az_bicep_options*
bicep_az_bicep_options
g:ale_bicep_az_bicep_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to az_bicep. This variable can be set to pass additional options to az_bicep.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+14 -5
View File
@@ -5,22 +5,31 @@ ALE BitBake Integration *ale-bitbake-options*
=============================================================================== ===============================================================================
oelint-adv *ale-bitbake-oelint_adv* oelint-adv *ale-bitbake-oelint_adv*
g:ale_bitbake_oelint_adv_executable *g:ale_bitbake_oelint_adv_executable* *ale-options.bitbake_oelint_adv_executable*
*g:ale_bitbake_oelint_adv_executable*
*b:ale_bitbake_oelint_adv_executable*
bitbake_oelint_adv_executable
g:ale_bitbake_oelint_adv_executable
Type: |String| Type: |String|
Default: `'oelint-adv'` Default: `'oelint-adv'`
This variable can be changed to use a different executable for oelint-adv. This variable can be changed to use a different executable for oelint-adv.
g:ale_bitbake_oelint_adv_options *g:ale_bitbake_oelint_adv_options* *ale-options.bitbake_oelint_adv_options*
*g:ale_bitbake_oelint_adv_options*
*b:ale_bitbake_oelint_adv_options*
bitbake_oelint_adv_options
g:ale_bitbake_oelint_adv_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to oelint-adv. This variable can be set to pass additional options to oelint-adv.
g:ale_bitbake_oelint_adv_config *g:ale_bitbake_oelint_adv_config* *ale-options.bitbake_oelint_adv_config*
*g:ale_bitbake_oelint_adv_config*
*b:ale_bitbake_oelint_adv_config*
g:ale_bitbake_oelint_adv_config
Type: |String| Type: |String|
Default: `'.oelint.cfg'` Default: `'.oelint.cfg'`
+165 -78
View File
@@ -7,9 +7,11 @@ runs either `clang`, or `gcc`. See |ale-c-cc|.
=============================================================================== ===============================================================================
Global Options Global Options
*ale-options.c_always_make*
g:ale_c_always_make *g:ale_c_always_make* *g:ale_c_always_make*
*b:ale_c_always_make* *b:ale_c_always_make*
c_always_make
g:ale_c_always_make
Type: |Number| Type: |Number|
Default: `has('unix') && !has('macunix')` Default: `has('unix') && !has('macunix')`
@@ -18,10 +20,11 @@ g:ale_c_always_make *g:ale_c_always_make*
support this option, so you probably want to turn this option off when using support this option, so you probably want to turn this option off when using
a BSD variant. a BSD variant.
*ale-options.c_build_dir_names*
g:ale_c_build_dir_names *g:ale_c_build_dir_names* *g:ale_c_build_dir_names*
*b:ale_c_build_dir_names* *b:ale_c_build_dir_names*
c_build_dir_names
g:ale_c_build_dir_names
Type: |List| Type: |List|
Default: `['build', 'bin']` Default: `['build', 'bin']`
@@ -32,10 +35,11 @@ g:ale_c_build_dir_names *g:ale_c_build_dir_names*
database. This feature is useful for the clang tools wrapped around database. This feature is useful for the clang tools wrapped around
LibTooling (namely here, clang-tidy) LibTooling (namely here, clang-tidy)
*ale-options.c_build_dir*
g:ale_c_build_dir *g:ale_c_build_dir* *g:ale_c_build_dir*
*b:ale_c_build_dir* *b:ale_c_build_dir*
c_build_dir
g:ale_c_build_dir
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -47,9 +51,11 @@ g:ale_c_build_dir *g:ale_c_build_dir*
This directory will be searched instead of |g:ale_c_build_dir_names|. This directory will be searched instead of |g:ale_c_build_dir_names|.
*ale-options.c_parse_compile_commands*
g:ale_c_parse_compile_commands *g:ale_c_parse_compile_commands* *g:ale_c_parse_compile_commands*
*b:ale_c_parse_compile_commands* *b:ale_c_parse_compile_commands*
c_parse_compile_commands
g:ale_c_parse_compile_commands
Type: |Number| Type: |Number|
Default: `1` Default: `1`
@@ -59,9 +65,11 @@ g:ale_c_parse_compile_commands *g:ale_c_parse_compile_commands*
`compile_commands.json` files in the directories for `compile_commands.json` files in the directories for
|g:ale_c_build_dir_names|. |g:ale_c_build_dir_names|.
*ale-options.c_parse_makefile*
g:ale_c_parse_makefile *g:ale_c_parse_makefile* *g:ale_c_parse_makefile*
*b:ale_c_parse_makefile* *b:ale_c_parse_makefile*
c_parse_makefile
g:ale_c_parse_makefile
Type: |Number| Type: |Number|
Default: `0` Default: `0`
@@ -91,16 +99,21 @@ g:ale_c_parse_makefile *g:ale_c_parse_makefile*
=============================================================================== ===============================================================================
astyle *ale-c-astyle* astyle *ale-c-astyle*
g:ale_c_astyle_executable *g:ale_c_astyle_executable* *ale-options.c_astyle_executable*
*g:ale_c_astyle_executable*
*b:ale_c_astyle_executable* *b:ale_c_astyle_executable*
c_astyle_executable
g:ale_c_astyle_executable
Type: |String| Type: |String|
Default: `'astyle'` Default: `'astyle'`
This variable can be changed to use a different executable for astyle. This variable can be changed to use a different executable for astyle.
*ale-options.c_astyle_project_options*
g:ale_c_astyle_project_options *g:ale_c_astyle_project_options* *g:ale_c_astyle_project_options*
*b:ale_c_astyle_project_options* *b:ale_c_astyle_project_options*
c_astyle_project_options
g:ale_c_astyle_project_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -117,8 +130,11 @@ cc *ale-c-cc*
*ale-c-gcc* *ale-c-gcc*
*ale-c-clang* *ale-c-clang*
g:ale_c_cc_executable *g:ale_c_cc_executable* *ale-options.c_cc_executable*
*g:ale_c_cc_executable*
*b:ale_c_cc_executable* *b:ale_c_cc_executable*
c_cc_executable
g:ale_c_cc_executable
Type: |String| Type: |String|
Default: `'<auto>'` Default: `'<auto>'`
@@ -127,17 +143,21 @@ g:ale_c_cc_executable *g:ale_c_cc_executable*
ALE will try to use `clang` if Clang is available, otherwise ALE will ALE will try to use `clang` if Clang is available, otherwise ALE will
default to checking C code with `gcc`. default to checking C code with `gcc`.
*ale-options.c_cc_options*
g:ale_c_cc_options *g:ale_c_cc_options* *g:ale_c_cc_options*
*b:ale_c_cc_options* *b:ale_c_cc_options*
c_cc_options
g:ale_c_cc_options
Type: |String| Type: |String|
Default: `'-std=c11 -Wall'` Default: `'-std=c11 -Wall'`
This variable can be changed to modify flags given to the C compiler. This variable can be changed to modify flags given to the C compiler.
*ale-options.c_cc_use_header_lang_flag*
g:ale_c_cc_use_header_lang_flag *g:ale_c_cc_use_header_lang_flag* *g:ale_c_cc_use_header_lang_flag*
*b:ale_c_cc_use_header_lang_flag* *b:ale_c_cc_use_header_lang_flag*
c_cc_use_header_lang_flag
g:ale_c_cc_use_header_lang_flag
Type: |Number| Type: |Number|
Default: `-1` Default: `-1`
@@ -158,9 +178,11 @@ g:ale_c_cc_use_header_lang_flag *g:ale_c_cc_use_header_lang_flag*
which is what ALE does. This why, by default, ALE only uses `'-x c-header'` which is what ALE does. This why, by default, ALE only uses `'-x c-header'`
with Clang. with Clang.
*ale-options.c_cc_header_exts*
g:ale_c_cc_header_exts *g:ale_c_cc_header_exts* *g:ale_c_cc_header_exts*
*b:ale_c_cc_header_exts* *b:ale_c_cc_header_exts*
c_cc_header_exts
g:ale_c_cc_header_exts
Type: |List| Type: |List|
Default: `['h']` Default: `['h']`
@@ -174,29 +196,35 @@ g:ale_c_cc_header_exts *g:ale_c_cc_header_exts*
=============================================================================== ===============================================================================
ccls *ale-c-ccls* ccls *ale-c-ccls*
g:ale_c_ccls_executable *g:ale_c_ccls_executable* *ale-options.c_ccls_executable*
*g:ale_c_ccls_executable*
*b:ale_c_ccls_executable* *b:ale_c_ccls_executable*
c_ccls_executable
g:ale_c_ccls_executable
Type: |String| Type: |String|
Default: `'ccls'` Default: `'ccls'`
This variable can be changed to use a different executable for ccls. This variable can be changed to use a different executable for ccls.
*ale-options.c_ccls_init_options*
g:ale_c_ccls_init_options *g:ale_c_ccls_init_options* *g:ale_c_ccls_init_options*
*b:ale_c_ccls_init_options* *b:ale_c_ccls_init_options*
c_ccls_init_options
g:ale_c_ccls_init_options
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
This variable can be changed to customize ccls initialization options. This variable can be changed to customize ccls initialization options.
Example: > For example: >
{
\ 'cacheDirectory': '/tmp/ccls', let g:ale_c_ccls_init_options = {
\ 'cacheFormat': 'binary', \ 'cacheDirectory': '/tmp/ccls',
\ 'diagnostics': { \ 'cacheFormat': 'binary',
\ 'onOpen': 0, \ 'diagnostics': {
\ 'opChange': 1000, \ 'onOpen': 0,
\ }, \ 'opChange': 1000,
\ } \ },
\}
< <
For all available options and explanations, visit For all available options and explanations, visit
https://github.com/MaskRay/ccls/wiki/Customization#initialization-options. https://github.com/MaskRay/ccls/wiki/Customization#initialization-options.
@@ -213,16 +241,23 @@ Therefore, `clang-check` linter reads the options |g:ale_c_build_dir| and
overrides |g:ale_c_build_dir_names|. overrides |g:ale_c_build_dir_names|.
g:ale_c_clangcheck_executable *g:ale_c_clangcheck_executable* -------------------------------------------------------------------------------
Options
*ale-options.c_clangcheck_executable*
*g:ale_c_clangcheck_executable*
*b:ale_c_clangcheck_executable* *b:ale_c_clangcheck_executable*
c_clangcheck_executable
g:ale_c_clangcheck_executable
Type: |String| Type: |String|
Default: `'clang-check'` Default: `'clang-check'`
This variable can be changed to use a different executable for clangcheck. This variable can be changed to use a different executable for clangcheck.
*ale-options.c_clangcheck_options*
g:ale_c_clangcheck_options *g:ale_c_clangcheck_options* *g:ale_c_clangcheck_options*
*b:ale_c_clangcheck_options* *b:ale_c_clangcheck_options*
c_clangcheck_options
g:ale_c_clangcheck_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -236,16 +271,21 @@ g:ale_c_clangcheck_options *g:ale_c_clangcheck_options*
=============================================================================== ===============================================================================
clangd *ale-c-clangd* clangd *ale-c-clangd*
g:ale_c_clangd_executable *g:ale_c_clangd_executable* *ale-options.c_clangd_executable*
*g:ale_c_clangd_executable*
*b:ale_c_clangd_executable* *b:ale_c_clangd_executable*
c_clangd_executable
g:ale_c_clangd_executable
Type: |String| Type: |String|
Default: `'clangd'` Default: `'clangd'`
This variable can be changed to use a different executable for clangd. This variable can be changed to use a different executable for clangd.
*ale-options.c_clangd_options*
g:ale_c_clangd_options *g:ale_c_clangd_options* *g:ale_c_clangd_options*
*b:ale_c_clangd_options* *b:ale_c_clangd_options*
c_clangd_options
g:ale_c_clangd_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -255,24 +295,31 @@ g:ale_c_clangd_options *g:ale_c_clangd_options*
=============================================================================== ===============================================================================
clang-format *ale-c-clangformat* clang-format *ale-c-clangformat*
g:ale_c_clangformat_executable *g:ale_c_clangformat_executable* *ale-options.c_clangformat_executable*
*g:ale_c_clangformat_executable*
*b:ale_c_clangformat_executable* *b:ale_c_clangformat_executable*
c_clangformat_executable
g:ale_c_clangformat_executable
Type: |String| Type: |String|
Default: `'clang-format'` Default: `'clang-format'`
This variable can be changed to use a different executable for clang-format. This variable can be changed to use a different executable for clang-format.
*ale-options.c_clangformat_options*
g:ale_c_clangformat_options *g:ale_c_clangformat_options* *g:ale_c_clangformat_options*
*b:ale_c_clangformat_options* *b:ale_c_clangformat_options*
c_clangformat_options
g:ale_c_clangformat_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to modify flags given to clang-format. This variable can be changed to modify flags given to clang-format.
*ale-options.c_clangformat_style_option*
g:ale_c_clangformat_style_option *g:ale_c_clangformat_style_option* *g:ale_c_clangformat_style_option*
*b:ale_c_clangformat_style_option* *b:ale_c_clangformat_style_option*
c_clangformat_style_option
g:ale_c_clangformat_style_option
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -281,19 +328,21 @@ g:ale_c_clangformat_style_option *g:ale_c_clangformat_style_option*
flag of clang-format. flag of clang-format.
Example: > Example: >
{ let g:ale_c_clangformat_style_option = {
\ BasedOnStyle: Microsoft, \ 'BasedOnStyle': 'Microsoft',
\ ColumnLimit: 80, \ 'ColumnLimit': 80,
\ AllowShortBlocksOnASingleLine: Always, \ 'AllowShortBlocksOnASingleLine': 'Always',
\ AllowShortFunctionsOnASingleLine: Inline, \ 'AllowShortFunctionsOnASingleLine': 'Inline',
\ } \}
< <
If you set this variable, ensure you don't modify -style in If you set this variable, ensure you don't modify -style in
|g:ale_c_clangformat_options|, as this will cause clang-format to error. |g:ale_c_clangformat_options|, as this will cause clang-format to error.
*ale-options.c_clangformat_use_local_file*
g:ale_c_clangformat_use_local_file *g:ale_c_clangformat_use_local_file* *g:ale_c_clangformat_use_local_file*
*b:ale_c_clangformat_use_local_file* *b:ale_c_clangformat_use_local_file*
c_clangformat_use_local_file
g:ale_c_clangformat_use_local_file
Type: |Number| Type: |Number|
Default: `0` Default: `0`
@@ -320,8 +369,13 @@ Therefore, `clang-tidy` linter reads the options |g:ale_c_build_dir| and
overrides |g:ale_c_build_dir_names|. overrides |g:ale_c_build_dir_names|.
g:ale_c_clangtidy_checks *g:ale_c_clangtidy_checks* -------------------------------------------------------------------------------
Options
*ale-options.c_clangtidy_checks*
*g:ale_c_clangtidy_checks*
*b:ale_c_clangtidy_checks* *b:ale_c_clangtidy_checks*
c_clangtidy_checks
g:ale_c_clangtidy_checks
Type: |List| Type: |List|
Default: `[]` Default: `[]`
@@ -335,17 +389,21 @@ g:ale_c_clangtidy_checks *g:ale_c_clangtidy_checks*
clang documentation for an up-to-date list of compatible checks: clang documentation for an up-to-date list of compatible checks:
http://clang.llvm.org/extra/clang-tidy/checks/list.html http://clang.llvm.org/extra/clang-tidy/checks/list.html
*ale-options.c_clangtidy_executable*
g:ale_c_clangtidy_executable *g:ale_c_clangtidy_executable* *g:ale_c_clangtidy_executable*
*b:ale_c_clangtidy_executable* *b:ale_c_clangtidy_executable*
c_clangtidy_executable
g:ale_c_clangtidy_executable
Type: |String| Type: |String|
Default: `'clang-tidy'` Default: `'clang-tidy'`
This variable can be changed to use a different executable for clangtidy. This variable can be changed to use a different executable for clangtidy.
*ale-options.c_clangtidy_options*
g:ale_c_clangtidy_options *g:ale_c_clangtidy_options* *g:ale_c_clangtidy_options*
*b:ale_c_clangtidy_options* *b:ale_c_clangtidy_options*
c_clangtidy_options
g:ale_c_clangtidy_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -361,17 +419,21 @@ g:ale_c_clangtidy_options *g:ale_c_clangtidy_options*
entirely manually, and no `compile_commands.json` file is in one entirely manually, and no `compile_commands.json` file is in one
of the |g:ale_c_build_dir_names| directories of the project tree. of the |g:ale_c_build_dir_names| directories of the project tree.
*ale-options.c_clangtidy_extra_options*
g:ale_c_clangtidy_extra_options *g:ale_c_clangtidy_extra_options* *g:ale_c_clangtidy_extra_options*
*b:ale_c_clangtidy_extra_options* *b:ale_c_clangtidy_extra_options*
c_clangtidy_extra_options
g:ale_c_clangtidy_extra_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to modify flags given to clang-tidy. This variable can be changed to modify flags given to clang-tidy.
*ale-options.c_clangtidy_fix_errors*
g:ale_c_clangtidy_fix_errors *g:ale_c_clangtidy_fix_errors* *g:ale_c_clangtidy_fix_errors*
*b:ale_c_clangtidy_fix_errors* *b:ale_c_clangtidy_fix_errors*
c_clangtidy_fix_errors
g:ale_c_clangtidy_fix_errors
Type: |Number| Type: |Number|
Default: `1` Default: `1`
@@ -382,16 +444,21 @@ g:ale_c_clangtidy_fix_errors *g:ale_c_clangtidy_fix_errors*
=============================================================================== ===============================================================================
cppcheck *ale-c-cppcheck* cppcheck *ale-c-cppcheck*
g:ale_c_cppcheck_executable *g:ale_c_cppcheck_executable* *ale-options.c_cppcheck_executable*
*g:ale_c_cppcheck_executable*
*b:ale_c_cppcheck_executable* *b:ale_c_cppcheck_executable*
c_cppcheck_executable
g:ale_c_cppcheck_executable
Type: |String| Type: |String|
Default: `'cppcheck'` Default: `'cppcheck'`
This variable can be changed to use a different executable for cppcheck. This variable can be changed to use a different executable for cppcheck.
*ale-options.c_cppcheck_options*
g:ale_c_cppcheck_options *g:ale_c_cppcheck_options* *g:ale_c_cppcheck_options*
*b:ale_c_cppcheck_options* *b:ale_c_cppcheck_options*
c_cppcheck_options
g:ale_c_cppcheck_options
Type: |String| Type: |String|
Default: `'--enable=style'` Default: `'--enable=style'`
@@ -401,21 +468,26 @@ g:ale_c_cppcheck_options *g:ale_c_cppcheck_options*
=============================================================================== ===============================================================================
cquery *ale-c-cquery* cquery *ale-c-cquery*
g:ale_c_cquery_executable *g:ale_c_cquery_executable* *ale-options.c_cquery_executable*
*g:ale_c_cquery_executable*
*b:ale_c_cquery_executable* *b:ale_c_cquery_executable*
c_cquery_executable
g:ale_c_cquery_executable
Type: |String| Type: |String|
Default: `'cquery'` Default: `'cquery'`
This variable can be changed to use a different executable for cquery. This variable can be changed to use a different executable for cquery.
*ale-options.c_cquery_cache_directory*
g:ale_c_cquery_cache_directory *g:ale_c_cquery_cache_directory* *g:ale_c_cquery_cache_directory*
*b:ale_c_cquery_cache_directory* *b:ale_c_cquery_cache_directory*
c_cquery_cache_directory
g:ale_c_cquery_cache_directory
Type: |String| Type: |String|
Default: `'~/.cache/cquery'` Default: `'~/.cache/cquery'`
This variable can be changed to decide which directory cquery uses for its This variable can be changed to decide which directory cquery uses for its
cache. cache.
=============================================================================== ===============================================================================
@@ -427,31 +499,41 @@ See |ale-cspell-options|
=============================================================================== ===============================================================================
flawfinder *ale-c-flawfinder* flawfinder *ale-c-flawfinder*
g:ale_c_flawfinder_executable *g:ale_c_flawfinder_executable* *ale-options.c_flawfinder_executable*
*g:ale_c_flawfinder_executable*
*b:ale_c_flawfinder_executable* *b:ale_c_flawfinder_executable*
c_flawfinder_executable
g:ale_c_flawfinder_executable
Type: |String| Type: |String|
Default: `'flawfinder'` Default: `'flawfinder'`
This variable can be changed to use a different executable for flawfinder. This variable can be changed to use a different executable for flawfinder.
*ale-options.c_flawfinder_minlevel*
g:ale_c_flawfinder_minlevel *g:ale_c_flawfinder_minlevel* *g:ale_c_flawfinder_minlevel*
*b:ale_c_flawfinder_minlevel* *b:ale_c_flawfinder_minlevel*
c_flawfinder_minlevel
g:ale_c_flawfinder_minlevel
Type: |Number| Type: |Number|
Default: `1` Default: `1`
This variable can be changed to ignore risks under the given risk threshold. This variable can be changed to ignore risks under the given risk threshold.
*ale-options.c_flawfinder_options*
g:ale_c_flawfinder_options *g:ale-c-flawfinder* *g:ale_c_flawfinder_options*
*b:ale-c-flawfinder* *b:ale-c-flawfinder*
c_flawfinder_options
g:ale_c_flawfinder_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be used to pass extra options into the flawfinder command. This variable can be used to pass extra options into the flawfinder command.
g:ale_c_flawfinder_error_severity *g:ale_c_flawfinder_error_severity* *ale-options.c_flawfinder_error_severity*
*g:ale_c_flawfinder_error_severity*
*b:ale_c_flawfinder_error_severity* *b:ale_c_flawfinder_error_severity*
c_flawfinder_error_severity
g:ale_c_flawfinder_error_severity
Type: |Number| Type: |Number|
Default: `6` Default: `6`
@@ -462,16 +544,21 @@ g:ale_c_flawfinder_error_severity *g:ale_c_flawfinder_error_severity*
=============================================================================== ===============================================================================
uncrustify *ale-c-uncrustify* uncrustify *ale-c-uncrustify*
g:ale_c_uncrustify_executable *g:ale_c_uncrustify_executable* *ale-options.c_uncrustify_executable*
*g:ale_c_uncrustify_executable*
*b:ale_c_uncrustify_executable* *b:ale_c_uncrustify_executable*
c_uncrustify_executable
g:ale_c_uncrustify_executable
Type: |String| Type: |String|
Default: `'uncrustify'` Default: `'uncrustify'`
This variable can be changed to use a different executable for uncrustify. This variable can be changed to use a different executable for uncrustify.
*ale-options.c_uncrustify_options*
g:ale_c_uncrustify_options *g:ale_c_uncrustify_options* *g:ale_c_uncrustify_options*
*b:ale_c_uncrustify_options* *b:ale_c_uncrustify_options*
c_uncrustify_options
g:ale_c_uncrustify_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+12 -6
View File
@@ -4,26 +4,32 @@ ALE C3 Integration *ale-c3-options*
=============================================================================== ===============================================================================
c3lsp *ale-c3-c3lsp* c3lsp *ale-c3-c3lsp*
g:ale_c3_c3lsp_executable *g:ale_c3_c3lsp_executable* *ale-options.c3_c3lsp_executable*
*g:ale_c3_c3lsp_executable*
*b:ale_c3_c3lsp_executable* *b:ale_c3_c3lsp_executable*
c3_c3lsp_executable
g:ale_c3_c3lsp_executable
Type: |String| Type: |String|
Default: `c3lsp` Default: `c3lsp`
This variable can be changed to set the path to c3lsp executable. This variable can be changed to set the path to c3lsp executable.
*ale-options.c3_c3lsp_options*
g:ale_c3_c3lsp_options *g:ale_c3_c3lsp_options* *g:ale_c3_c3lsp_options*
*b:ale_c3_c3lsp_options* *b:ale_c3_c3lsp_options*
c3_c3lsp_options
g:ale_c3_c3lsp_options
Type: |String| Type: |String|
Default: `''` Default: `''`
Add command line options to the c3lsp executable. This is useful to specify Add command line options to the c3lsp executable. This is useful to specify
the path to the C3 standard library with '-stdlib-path=<path>'. the path to the C3 standard library with '-stdlib-path=<path>'.
*ale-options.c3_c3lsp_init_options*
g:ale_c3_c3lsp_init_options *g:ale_c3_c3lsp_init_options* *g:ale_c3_c3lsp_init_options*
*b:ale_c3_c3lsp_init_options* *b:ale_c3_c3lsp_init_options*
c3_c3lsp_init_options
g:ale_c3_c3lsp_init_options
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
+12 -4
View File
@@ -5,9 +5,12 @@ ALE Cairo Integration *ale-cairo-options*
=============================================================================== ===============================================================================
scarb *ale-cairo-scarb* scarb *ale-cairo-scarb*
g:ale_cairo_scarb_executable *g:ale_cairo_scarb_executable* *ale-options.cairo_scarb_executable*
*g:ale_cairo_scarb_executable*
*b:ale_cairo_scarb_executable* *b:ale_cairo_scarb_executable*
cairo_scarb_executable
g:ale_cairo_scarb_executable
Type: |String|
Default: `'scarb build'` Default: `'scarb build'`
For Cairo1 projects using Scarb For Cairo1 projects using Scarb
@@ -18,13 +21,18 @@ g:ale_cairo_scarb_executable *g:ale_cairo_scarb_executable*
=============================================================================== ===============================================================================
starknet *ale-cairo-starknet* starknet *ale-cairo-starknet*
g:ale_cairo_starknet_executable *g:ale_cairo_starknet_executable* *ale-options.cairo_starknet_executable*
*g:ale_cairo_starknet_executable*
*b:ale_cairo_starknet_executable* *b:ale_cairo_starknet_executable*
cairo_starknet_executable
g:ale_cairo_starknet_executable
Type: |String|
Default: `'starknet-compile'` Default: `'starknet-compile'`
Overrides the starknet-compile binary after installing the cairo-language. Overrides the starknet-compile binary after installing the cairo-language.
For more information read 'https://starknet.io/docs/quickstart.html' For more information read 'https://starknet.io/docs/quickstart.html'
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+16 -6
View File
@@ -5,16 +5,21 @@ ALE Chef Integration *ale-chef-options*
=============================================================================== ===============================================================================
cookstyle *ale-chef-cookstyle* cookstyle *ale-chef-cookstyle*
g:ale_chef_cookstyle_options *g:ale_chef_cookstyle_options* *ale-options.chef_cookstyle_options*
*g:ale_chef_cookstyle_options*
*b:ale_chef_cookstyle_options* *b:ale_chef_cookstyle_options*
chef_cookstyle_options
g:ale_chef_cookstyle_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to modify flags given to cookstyle. This variable can be changed to modify flags given to cookstyle.
*ale-options.chef_cookstyle_executable*
g:ale_chef_cookstyle_executable *g:ale_chef_cookstyle_executable* *g:ale_chef_cookstyle_executable*
*b:ale_chef_cookstyle_executable* *b:ale_chef_cookstyle_executable*
chef_cookstyle_executable
g:ale_chef_cookstyle_executable
Type: |String| Type: |String|
Default: `'cookstyle'` Default: `'cookstyle'`
@@ -25,16 +30,21 @@ g:ale_chef_cookstyle_executable *g:ale_chef_cookstyle_executable*
=============================================================================== ===============================================================================
foodcritic *ale-chef-foodcritic* foodcritic *ale-chef-foodcritic*
g:ale_chef_foodcritic_options *g:ale_chef_foodcritic_options* *ale-options.chef_foodcritic_options*
*g:ale_chef_foodcritic_options*
*b:ale_chef_foodcritic_options* *b:ale_chef_foodcritic_options*
chef_foodcritic_options
g:ale_chef_foodcritic_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to modify flags given to foodcritic. This variable can be changed to modify flags given to foodcritic.
*ale-options.chef_foodcritic_executable*
g:ale_chef_foodcritic_executable *g:ale_chef_foodcritic_executable* *g:ale_chef_foodcritic_executable*
*b:ale_chef_foodcritic_executable* *b:ale_chef_foodcritic_executable*
chef_foodcritic_executable
g:ale_chef_foodcritic_executable
Type: |String| Type: |String|
Default: `'foodcritic'` Default: `'foodcritic'`
+9 -2
View File
@@ -9,13 +9,20 @@ A minimal and opinionated linter for code that sparks joy.
https://github.com/borkdude/clj-kondo https://github.com/borkdude/clj-kondo
g:ale_clojure_clj_kondo_options *g:ale_clojure_clj_kondo_options*
-------------------------------------------------------------------------------
Options
*ale-options.clojure_clj_kondo_options*
*g:ale_clojure_clj_kondo_options*
*b:ale_clojure_clj_kondo_options* *b:ale_clojure_clj_kondo_options*
clojure_clj_kondo_options
g:ale_clojure_clj_kondo_options
Type: |String| Type: |String|
Default: `'--cache'` Default: `'--cache'`
This variable can be changed to modify options passed to clj-kondo. This variable can be changed to modify options passed to clj-kondo.
=============================================================================== ===============================================================================
cljfmt *ale-clojure-cljfmt* cljfmt *ale-clojure-cljfmt*
@@ -43,6 +50,6 @@ directory.
see https://github.com/candid82/joker#linter-mode for more information. see https://github.com/candid82/joker#linter-mode for more information.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+23 -24
View File
@@ -1,46 +1,45 @@
=============================================================================== ===============================================================================
ALE CloudFormation Integration *ale-cloudformation-options* ALE CloudFormation Integration *ale-cloudformation-options*
=============================================================================== ===============================================================================
cfn-python-lint *ale-cloudformation-cfn-python-lint* cfn-python-lint *ale-cloudformation-cfn-python-lint*
cfn-python-lint is a linter for AWS CloudFormation template file. cfn-python-lint is a linter for AWS CloudFormation template file.
Website: https://github.com/awslabs/cfn-python-lint Website: https://github.com/awslabs/cfn-python-lint
Installation
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
Installation
Install cfn-python-lint using either pip or brew: > Install cfn-python-lint using either pip or brew: >
`pip install cfn-lint`. If pip is not available, run pip install cfn-lint
`python setup.py clean --all` then `python setup.py install`.
Homebrew (macOS):
`brew install cfn-lint`
< <
Configuration If pip is not available use setuptools. >
python setup.py clean --all
python setup.py install
<
You can install the linter via brew on macOS. >
brew install cfn-lint
<
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Configuration
To get cloudformation linter to work on only CloudFormation files we must set To get cloudformation linter to work on only CloudFormation files we must set
the buffer |filetype| to yaml.cloudformation. the buffer |filetype| to `yaml.cloudformation`. This causes ALE to lint the
This causes ALE to lint the file with linters configured for cloudformation and file with linters configured for cloudformation and YAML files.
yaml files.
Just put: Just put the following in `ftdetect/cloudformation.vim`: >
> au BufRead,BufNewFile *.template.yaml set filetype=yaml.cloudformation
au BufRead,BufNewFile *.template.yaml set filetype=yaml.cloudformation This will get both cloudformation and yaml linters to work on any file with
`.template.yaml` extension.
<
on `ftdetect/cloudformation.vim`
This will get both cloudformation and yaml linters to work on any file with `.template.yaml` ext.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+25 -9
View File
@@ -5,16 +5,21 @@ ALE CMake Integration *ale-cmake-options*
=============================================================================== ===============================================================================
cmakelint *ale-cmake-cmakelint* cmakelint *ale-cmake-cmakelint*
g:ale_cmake_cmakelint_executable *g:ale_cmake_cmakelint_executable* *ale-options.cmake_cmakelint_executable*
*g:ale_cmake_cmakelint_executable*
*b:ale_cmake_cmakelint_executable* *b:ale_cmake_cmakelint_executable*
cmake_cmakelint_executable
g:ale_cmake_cmakelint_executable
Type: |String| Type: |String|
Default: `'cmakelint'` Default: `'cmakelint'`
This variable can be set to change the path the cmakelint. This variable can be set to change the path the cmakelint.
*ale-options.cmake_cmakelint_options*
g:ale_cmake_cmakelint_options *g:ale_cmake_cmakelint_options* *g:ale_cmake_cmakelint_options*
*b:ale_cmake_cmakelint_options* *b:ale_cmake_cmakelint_options*
cmake_cmakelint_options
g:ale_cmake_cmakelint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -24,16 +29,21 @@ g:ale_cmake_cmakelint_options *g:ale_cmake_cmakelint_options*
=============================================================================== ===============================================================================
cmake-lint *ale-cmake-cmake-lint* cmake-lint *ale-cmake-cmake-lint*
g:ale_cmake_cmake_lint_executable *g:ale_cmake_cmake_lint_executable* *ale-options.cmake_cmake_lint_executable*
*g:ale_cmake_cmake_lint_executable*
*b:ale_cmake_cmake_lint_executable* *b:ale_cmake_cmake_lint_executable*
cmake_cmake_lint_executable
g:ale_cmake_cmake_lint_executable
Type: |String| Type: |String|
Default: `'cmake-lint'` Default: `'cmake-lint'`
This variable can be set to change the path the cmake-lint. This variable can be set to change the path the cmake-lint.
*ale-options.cmake_cmake_lint_options*
g:ale_cmake_cmake_lint_options *g:ale_cmake_cmake_lint_options* *g:ale_cmake_cmake_lint_options*
*b:ale_cmake_cmake_lint_options* *b:ale_cmake_cmake_lint_options*
cmake_cmake_lint_options
g:ale_cmake_cmake_lint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -43,20 +53,26 @@ g:ale_cmake_cmake_lint_options *g:ale_cmake_cmake_lint_options*
=============================================================================== ===============================================================================
cmake-format *ale-cmake-cmakeformat* cmake-format *ale-cmake-cmakeformat*
g:ale_cmake_cmakeformat_executable *g:ale_cmake_cmakeformat_executable* *ale-options.cmake_cmakeformat_executable*
*g:ale_cmake_cmakeformat_executable*
*b:ale_cmake_cmakeformat_executable* *b:ale_cmake_cmakeformat_executable*
cmake_cmakeformat_executable
g:ale_cmake_cmakeformat_executable
Type: |String| Type: |String|
Default: `'cmakeformat'` Default: `'cmakeformat'`
This variable can be set to change the path the cmake-format. This variable can be set to change the path the cmake-format.
*ale-options.cmake_cmakeformat_options*
g:ale_cmake_cmakeformat_options *g:ale_cmake_cmakeformat_options* *g:ale_cmake_cmakeformat_options*
*b:ale_cmake_cmakeformat_options* *b:ale_cmake_cmakeformat_options*
cmake_cmakeformat_options
g:ale_cmake_cmakeformat_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to cmake-format. This variable can be set to pass additional options to cmake-format.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+142 -63
View File
@@ -20,16 +20,21 @@ The following C options also apply to some C++ linters too.
=============================================================================== ===============================================================================
astyle *ale-cpp-astyle* astyle *ale-cpp-astyle*
g:ale_cpp_astyle_executable *g:ale_cpp_astyle_executable* *ale-options.cpp_astyle_executable*
*g:ale_cpp_astyle_executable*
*b:ale_cpp_astyle_executable* *b:ale_cpp_astyle_executable*
cpp_astyle_executable
g:ale_cpp_astyle_executable
Type: |String| Type: |String|
Default: `'astyle'` Default: `'astyle'`
This variable can be changed to use a different executable for astyle. This variable can be changed to use a different executable for astyle.
*ale-options.cpp_astyle_project_options*
g:ale_cpp_astyle_project_options *g:ale_cpp_astyle_project_options* *g:ale_cpp_astyle_project_options*
*b:ale_cpp_astyle_project_options* *b:ale_cpp_astyle_project_options*
cpp_astyle_project_options
g:ale_cpp_astyle_project_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -46,8 +51,11 @@ cc *ale-cpp-cc*
*ale-cpp-gcc* *ale-cpp-gcc*
*ale-cpp-clang* *ale-cpp-clang*
g:ale_cpp_cc_executable *g:ale_cpp_cc_executable* *ale-options.cpp_cc_executable*
*g:ale_cpp_cc_executable*
*b:ale_cpp_cc_executable* *b:ale_cpp_cc_executable*
cpp_cc_executable
g:ale_cpp_cc_executable
Type: |String| Type: |String|
Default: `'<auto>'` Default: `'<auto>'`
@@ -56,17 +64,21 @@ g:ale_cpp_cc_executable *g:ale_cpp_cc_executable*
ALE will try to use `clang++` if Clang is available, otherwise ALE will ALE will try to use `clang++` if Clang is available, otherwise ALE will
default to checking C++ code with `gcc`. default to checking C++ code with `gcc`.
*ale-options.cpp_cc_options*
g:ale_cpp_cc_options *g:ale_cpp_cc_options* *g:ale_cpp_cc_options*
*b:ale_cpp_cc_options* *b:ale_cpp_cc_options*
cpp_cc_options
g:ale_cpp_cc_options
Type: |String| Type: |String|
Default: `'-std=c++14 -Wall'` Default: `'-std=c++14 -Wall'`
This variable can be changed to modify flags given to the C++ compiler. This variable can be changed to modify flags given to the C++ compiler.
*ale-options.cpp_cc_use_header_lang_flag*
g:ale_cpp_cc_use_header_lang_flag *g:ale_cpp_cc_use_header_lang_flag* *g:ale_cpp_cc_use_header_lang_flag*
*b:ale_cpp_cc_use_header_lang_flag* *b:ale_cpp_cc_use_header_lang_flag*
cpp_cc_use_header_lang_flag
g:ale_cpp_cc_use_header_lang_flag
Type: |Number| Type: |Number|
Default: `-1` Default: `-1`
@@ -76,20 +88,22 @@ g:ale_cpp_cc_use_header_lang_flag *g:ale_cpp_cc_use_header_lang_flag*
This variable can be changed to manually activate or deactivate this flag This variable can be changed to manually activate or deactivate this flag
for header files. for header files.
- When set to `-1`, the default beviour is used, `'-x c++-header'` is used with - When set to `-1`, the default behavior is used, `'-x c++-header'` is used
Clang and `'-x c++'` is used with other compilers. with Clang and `'-x c++'` is used with other compilers.
- When set to `0`, the flag is deactivated, `'-x c++'` is always used - When set to `0`, the flag is deactivated, `'-x c++'` is always used
independently of the compiler. independently of the compiler.
- When set to `1`, the flag is activated, `'-x c++-header'` is always used - When set to `1`, the flag is activated, `'-x c++-header'` is always used
independently of the compiler. independently of the compiler.
Gcc does not support `'-x c++-header'` when using `'-'` as input filename, GCC does not support `'-x c++-header'` when using `'-'` as input filename,
which is what ALE does. This why, by default, ALE only uses `'-x c++-header'` which is what ALE does. This why, by default, ALE only uses `'-x c++-header'`
with Clang. with Clang.
*ale-options.cpp_cc_header_exts*
g:ale_cpp_cc_header_exts *g:ale_cpp_cc_header_exts* *g:ale_cpp_cc_header_exts*
*b:ale_cpp_cc_header_exts* *b:ale_cpp_cc_header_exts*
cpp_cc_header_exts
g:ale_cpp_cc_header_exts
Type: |List| Type: |List|
Default: `['h', 'hpp']` Default: `['h', 'hpp']`
@@ -103,29 +117,35 @@ g:ale_cpp_cc_header_exts *g:ale_cpp_cc_header_exts*
=============================================================================== ===============================================================================
ccls *ale-cpp-ccls* ccls *ale-cpp-ccls*
g:ale_cpp_ccls_executable *g:ale_cpp_ccls_executable* *ale-options.cpp_ccls_executable*
*g:ale_cpp_ccls_executable*
*b:ale_cpp_ccls_executable* *b:ale_cpp_ccls_executable*
cpp_ccls_executable
g:ale_cpp_ccls_executable
Type: |String| Type: |String|
Default: `'ccls'` Default: `'ccls'`
This variable can be changed to use a different executable for ccls. This variable can be changed to use a different executable for ccls.
*ale-options.cpp_ccls_init_options*
g:ale_cpp_ccls_init_options *g:ale_cpp_ccls_init_options* *g:ale_cpp_ccls_init_options*
*b:ale_cpp_ccls_init_options* *b:ale_cpp_ccls_init_options*
cpp_ccls_init_options
g:ale_cpp_ccls_init_options
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
This variable can be changed to customize ccls initialization options. This variable can be changed to customize ccls initialization options.
Example: > Example: >
{
\ 'cacheDirectory': '/tmp/ccls', let g:ale_cpp_ccls_init_options = {
\ 'cacheFormat': 'binary', \ 'cacheDirectory': '/tmp/ccls',
\ 'diagnostics': { \ 'cacheFormat': 'binary',
\ 'onOpen': 0, \ 'diagnostics': {
\ 'opChange': 1000, \ 'onOpen': 0,
\ }, \ 'opChange': 1000,
\ } \ },
\}
< <
Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
available options and explanations. available options and explanations.
@@ -136,22 +156,29 @@ clangcheck *ale-cpp-clangcheck*
`clang-check` will be run only when files are saved to disk, so that `clang-check` will be run only when files are saved to disk, so that
`compile_commands.json` files can be used. It is recommended to use this `compile_commands.json` files can be used. It is recommended to use this
linter in combination with `compile_commands.json` files. linter in combination with `compile_commands.json` files. Therefore,
Therefore, `clang-check` linter reads the options |g:ale_c_build_dir| and `clang-check` linter reads the options |g:ale_c_build_dir| and
|g:ale_c_build_dir_names|. Also, setting |g:ale_c_build_dir| actually |g:ale_c_build_dir_names|. Also, setting |g:ale_c_build_dir| actually
overrides |g:ale_c_build_dir_names|. overrides |g:ale_c_build_dir_names|.
g:ale_cpp_clangcheck_executable *g:ale_cpp_clangcheck_executable* -------------------------------------------------------------------------------
Options
*ale-options.cpp_clangcheck_executable*
*g:ale_cpp_clangcheck_executable*
*b:ale_cpp_clangcheck_executable* *b:ale_cpp_clangcheck_executable*
cpp_clangcheck_executable
g:ale_cpp_clangcheck_executable
Type: |String| Type: |String|
Default: `'clang-check'` Default: `'clang-check'`
This variable can be changed to use a different executable for clangcheck. This variable can be changed to use a different executable for clangcheck.
*ale-options.cpp_clangcheck_options*
g:ale_cpp_clangcheck_options *g:ale_cpp_clangcheck_options* *g:ale_cpp_clangcheck_options*
*b:ale_cpp_clangcheck_options* *b:ale_cpp_clangcheck_options*
cpp_clangcheck_options
g:ale_cpp_clangcheck_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -165,16 +192,21 @@ g:ale_cpp_clangcheck_options *g:ale_cpp_clangcheck_options*
=============================================================================== ===============================================================================
clangd *ale-cpp-clangd* clangd *ale-cpp-clangd*
g:ale_cpp_clangd_executable *g:ale_cpp_clangd_executable* *ale-options.cpp_clangd_executable*
*g:ale_cpp_clangd_executable*
*b:ale_cpp_clangd_executable* *b:ale_cpp_clangd_executable*
cpp_clangd_executable
g:ale_cpp_clangd_executable
Type: |String| Type: |String|
Default: `'clangd'` Default: `'clangd'`
This variable can be changed to use a different executable for clangd. This variable can be changed to use a different executable for clangd.
*ale-options.cpp_clangd_options*
g:ale_cpp_clangd_options *g:ale_cpp_clangd_options* *g:ale_cpp_clangd_options*
*b:ale_cpp_clangd_options* *b:ale_cpp_clangd_options*
cpp_clangd_options
g:ale_cpp_clangd_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -199,8 +231,13 @@ Therefore, `clang-tidy` linter reads the options |g:ale_c_build_dir| and
overrides |g:ale_c_build_dir_names|. overrides |g:ale_c_build_dir_names|.
g:ale_cpp_clangtidy_checks *g:ale_cpp_clangtidy_checks* -------------------------------------------------------------------------------
Options
*ale-options.cpp_clangtidy_checks*
*g:ale_cpp_clangtidy_checks*
*b:ale_cpp_clangtidy_checks* *b:ale_cpp_clangtidy_checks*
cpp_clangtidy_checks
g:ale_cpp_clangtidy_checks
Type: |List| Type: |List|
Default: `[]` Default: `[]`
@@ -210,17 +247,21 @@ g:ale_cpp_clangtidy_checks *g:ale_cpp_clangtidy_checks*
the shell. The `-checks` flag can be removed entirely by setting this the shell. The `-checks` flag can be removed entirely by setting this
option to an empty List. option to an empty List.
*ale-options.cpp_clangtidy_executable*
g:ale_cpp_clangtidy_executable *g:ale_cpp_clangtidy_executable* *g:ale_cpp_clangtidy_executable*
*b:ale_cpp_clangtidy_executable* *b:ale_cpp_clangtidy_executable*
cpp_clangtidy_executable
g:ale_cpp_clangtidy_executable
Type: |String| Type: |String|
Default: `'clang-tidy'` Default: `'clang-tidy'`
This variable can be changed to use a different executable for clangtidy. This variable can be changed to use a different executable for clangtidy.
*ale-options.cpp_clangtidy_options*
g:ale_cpp_clangtidy_options *g:ale_cpp_clangtidy_options* *g:ale_cpp_clangtidy_options*
*b:ale_cpp_clangtidy_options* *b:ale_cpp_clangtidy_options*
cpp_clangtidy_options
g:ale_cpp_clangtidy_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -236,17 +277,21 @@ g:ale_cpp_clangtidy_options *g:ale_cpp_clangtidy_options*
entirely manually, and no `compile_commands.json` file is in one entirely manually, and no `compile_commands.json` file is in one
of the |g:ale_c_build_dir_names| directories of the project tree. of the |g:ale_c_build_dir_names| directories of the project tree.
*ale-options.cpp_clangtidy_extra_options*
g:ale_cpp_clangtidy_extra_options *g:ale_cpp_clangtidy_extra_options* *g:ale_cpp_clangtidy_extra_options*
*b:ale_cpp_clangtidy_extra_options* *b:ale_cpp_clangtidy_extra_options*
cpp_clangtidy_extra_options
g:ale_cpp_clangtidy_extra_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to modify flags given to clang-tidy. This variable can be changed to modify flags given to clang-tidy.
*ale-options.cpp_clangtidy_fix_errors*
g:ale_cpp_clangtidy_fix_errors *g:ale_cpp_clangtidy_fix_errors* *g:ale_cpp_clangtidy_fix_errors*
*b:ale_cpp_clangtidy_fix_errors* *b:ale_cpp_clangtidy_fix_errors*
cpp_clangtidy_fix_errors
g:ale_cpp_clangtidy_fix_errors
Type: |Number| Type: |Number|
Default: `1` Default: `1`
@@ -257,16 +302,21 @@ g:ale_cpp_clangtidy_fix_errors *g:ale_cpp_clangtidy_fix_errors*
=============================================================================== ===============================================================================
clazy *ale-cpp-clazy* clazy *ale-cpp-clazy*
g:ale_cpp_clazy_executable *g:ale_cpp_clazy_executable* *ale-options.cpp_clazy_executable*
*g:ale_cpp_clazy_executable*
*b:ale_cpp_clazy_executable* *b:ale_cpp_clazy_executable*
cpp_clazy_executable
g:ale_cpp_clazy_executable
Type: |String| Type: |String|
Default: `'clazy-standalone'` Default: `'clazy-standalone'`
This variable can be changed to use a different executable for clazy. This variable can be changed to use a different executable for clazy.
*ale-options.cpp_clazy_checks*
g:ale_cpp_clazy_checks *g:ale_cpp_clazy_checks* *g:ale_cpp_clazy_checks*
*b:ale_cpp_clazy_checks* *b:ale_cpp_clazy_checks*
cpp_clazy_checks
g:ale_cpp_clazy_checks
Type: |List| Type: |List|
Default: `['level1']` Default: `['level1']`
@@ -276,9 +326,11 @@ g:ale_cpp_clazy_checks *g:ale_cpp_clazy_checks*
the shell. The `-checks` flag can be removed entirely by setting this the shell. The `-checks` flag can be removed entirely by setting this
option to an empty List. option to an empty List.
*ale-options.cpp_clazy_options*
g:ale_cpp_clazy_options *g:ale_cpp_clazy_options* *g:ale_cpp_clazy_options*
*b:ale_cpp_clazy_options* *b:ale_cpp_clazy_options*
cpp_clazy_options
g:ale_cpp_clazy_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -288,16 +340,21 @@ g:ale_cpp_clazy_options *g:ale_cpp_clazy_options*
=============================================================================== ===============================================================================
cppcheck *ale-cpp-cppcheck* cppcheck *ale-cpp-cppcheck*
g:ale_cpp_cppcheck_executable *g:ale_cpp_cppcheck_executable* *ale-options.cpp_cppcheck_executable*
*g:ale_cpp_cppcheck_executable*
*b:ale_cpp_cppcheck_executable* *b:ale_cpp_cppcheck_executable*
cpp_cppcheck_executable
g:ale_cpp_cppcheck_executable
Type: |String| Type: |String|
Default: `'cppcheck'` Default: `'cppcheck'`
This variable can be changed to use a different executable for cppcheck. This variable can be changed to use a different executable for cppcheck.
*ale-options.cpp_cppcheck_options*
g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options* *g:ale_cpp_cppcheck_options*
*b:ale_cpp_cppcheck_options* *b:ale_cpp_cppcheck_options*
cpp_cppcheck_options
g:ale_cpp_cppcheck_options
Type: |String| Type: |String|
Default: `'--enable=style'` Default: `'--enable=style'`
@@ -307,31 +364,41 @@ g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options*
=============================================================================== ===============================================================================
cpplint *ale-cpp-cpplint* cpplint *ale-cpp-cpplint*
g:ale_cpp_cpplint_executable *g:ale_cpp_cpplint_executable* *ale-options.cpp_cpplint_executable*
*g:ale_cpp_cpplint_executable*
*b:ale_cpp_cpplint_executable* *b:ale_cpp_cpplint_executable*
cpp_cpplint_executable
g:ale_cpp_cpplint_executable
Type: |String| Type: |String|
Default: `'cpplint'` Default: `'cpplint'`
This variable can be changed to use a different executable for cpplint. This variable can be changed to use a different executable for cpplint.
*ale-options.cpp_cpplint_options*
g:ale_cpp_cpplint_options *g:ale_cpp_cpplint_options* *g:ale_cpp_cpplint_options*
*b:ale_cpp_cpplint_options* *b:ale_cpp_cpplint_options*
cpp_cpplint_options
g:ale_cpp_cpplint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to modify flags given to cpplint. This variable can be changed to modify flags given to cpplint.
g:ale_c_cpplint_executable *g:ale_c_cpplint_executable* *ale-options.c_cpplint_executable*
*g:ale_c_cpplint_executable*
*b:ale_c_cpplint_executable* *b:ale_c_cpplint_executable*
c_cpplint_executable
g:ale_c_cpplint_executable
Type: |String| Type: |String|
Default: `'cpplint'` Default: `'cpplint'`
This variable can be changed to use a different executable for cpplint. This variable can be changed to use a different executable for cpplint.
*ale-options.c_cpplint_options*
g:ale_c_cpplint_options *g:ale_c_cpplint_options* *g:ale_c_cpplint_options*
*b:ale_c_cpplint_options* *b:ale_c_cpplint_options*
c_cpplint_options
g:ale_c_cpplint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -341,16 +408,21 @@ g:ale_c_cpplint_options *g:ale_c_cpplint_options*
=============================================================================== ===============================================================================
cquery *ale-cpp-cquery* cquery *ale-cpp-cquery*
g:ale_cpp_cquery_executable *g:ale_cpp_cquery_executable* *ale-options.cpp_cquery_executable*
*g:ale_cpp_cquery_executable*
*b:ale_cpp_cquery_executable* *b:ale_cpp_cquery_executable*
cpp_cquery_executable
g:ale_cpp_cquery_executable
Type: |String| Type: |String|
Default: `'cquery'` Default: `'cquery'`
This variable can be changed to use a different executable for cquery. This variable can be changed to use a different executable for cquery.
*ale-options.cpp_cquery_cache_directory*
g:ale_cpp_cquery_cache_directory *g:ale_cpp_cquery_cache_directory* *g:ale_cpp_cquery_cache_directory*
*b:ale_cpp_cquery_cache_directory* *b:ale_cpp_cquery_cache_directory*
cpp_cquery_cache_directory
g:ale_cpp_cquery_cache_directory
Type: |String| Type: |String|
Default: `'~/.cache/cquery'` Default: `'~/.cache/cquery'`
@@ -367,24 +439,31 @@ See |ale-cspell-options|
=============================================================================== ===============================================================================
flawfinder *ale-cpp-flawfinder* flawfinder *ale-cpp-flawfinder*
g:ale_cpp_flawfinder_executable *g:ale_cpp_flawfinder_executable* *ale-options.cpp_flawfinder_executable*
*g:ale_cpp_flawfinder_executable*
*b:ale_cpp_flawfinder_executable* *b:ale_cpp_flawfinder_executable*
cpp_flawfinder_executable
g:ale_cpp_flawfinder_executable
Type: |String| Type: |String|
Default: `'flawfinder'` Default: `'flawfinder'`
This variable can be changed to use a different executable for flawfinder. This variable can be changed to use a different executable for flawfinder.
*ale-options.cpp_flawfinder_minlevel*
g:ale_cpp_flawfinder_minlevel *g:ale_cpp_flawfinder_minlevel* *g:ale_cpp_flawfinder_minlevel*
*b:ale_cpp_flawfinder_minlevel* *b:ale_cpp_flawfinder_minlevel*
cpp_flawfinder_minlevel
g:ale_cpp_flawfinder_minlevel
Type: |Number| Type: |Number|
Default: `1` Default: `1`
This variable can be changed to ignore risks under the given risk threshold. This variable can be changed to ignore risks under the given risk threshold.
*ale-options.cpp_flawfinder_options*
g:ale_cpp_flawfinder_options *g:ale-cpp-flawfinder* *g:ale_cpp_flawfinder_options*
*b:ale-cpp-flawfinder* *b:ale-cpp-flawfinder*
cpp_flawfinder_options
g:ale_cpp_flawfinder_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+100 -70
View File
@@ -1,7 +1,6 @@
=============================================================================== ===============================================================================
ALE C# Integration *ale-cs-options* ALE C# Integration *ale-cs-options*
In addition to the linters that are provided with ALE, C# code can be checked In addition to the linters that are provided with ALE, C# code can be checked
with the OmniSharp plugin. See here: https://github.com/OmniSharp/omnisharp-vim with the OmniSharp plugin. See here: https://github.com/OmniSharp/omnisharp-vim
@@ -16,34 +15,39 @@ Note that the C options are also used for C#.
=============================================================================== ===============================================================================
csc *ale-cs-csc* csc *ale-cs-csc*
The |ale-cs-csc| linter checks for semantic errors when files are opened or The |ale-cs-csc| linter checks for semantic errors when files are opened or
saved. saved.
See |ale-lint-file-linters| for more information on linters which do not See |ale-lint-file-linters| for more information on linters which do not check
check for problems while you type. for problems while you type.
The csc linter uses the mono csc compiler, providing full C# 7 and newer The csc linter uses the mono csc compiler, providing full C# 7 and newer
support, to generate a temporary module target file (/t:module). The module support, to generate a temporary module target file (/t:module). The module
includes all '*.cs' files contained in the directory tree rooted at the path includes all '*.cs' files contained in the directory tree rooted at the path
defined by the |g:ale_cs_csc_source| or |b:ale_cs_csc_source| variable and defined by the |g:ale_cs_csc_source| or |b:ale_cs_csc_source| variable and all
all sub directories. sub directories.
It will in future replace the |ale-cs-mcs| and |ale-cs-mcsc| linters as both It will in future replace the |ale-cs-mcs| and |ale-cs-mcsc| linters as both
utilize the mcsc compiler which, according to the mono project, is no longer utilize the mcsc compiler which, according to the mono project, is no longer
actively developed, and only receives maintenance updates. However, because actively developed, and only receives maintenance updates. However, because
the csc compiler does not support the -syntax option, this linter does not the csc compiler does not support the -syntax option, this linter does not
offer any as-you-type syntax checking, similar to the |ale-cs-mcsc| linter. offer any as-you-type syntax checking, similar to the |ale-cs-mcsc| linter.
The paths to search for additional assembly files can be specified using the The paths to search for additional assembly files can be specified using the
|g:ale_cs_csc_assembly_path| or |b:ale_cs_csc_assembly_path| variables. |g:ale_cs_csc_assembly_path| or |b:ale_cs_csc_assembly_path| variables.
NOTE: ALE will not find any errors in files apart from syntax errors if any NOTE: ALE will not find any errors in files apart from syntax errors if any
one of the source files contains a syntax error. Syntax errors must be fixed one of the source files contains a syntax error. Syntax errors must be fixed
first before other errors will be shown. first before other errors will be shown.
g:ale_cs_csc_options *g:ale_cs_csc_options* -------------------------------------------------------------------------------
Options
*ale-options.cs_csc_options*
*g:ale_cs_csc_options*
*b:ale_cs_csc_options* *b:ale_cs_csc_options*
cs_csc_options
g:ale_cs_csc_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -55,9 +59,11 @@ g:ale_cs_csc_options *g:ale_cs_csc_options*
< <
NOTE: the `/unsafe` option is always passed to `csc`. NOTE: the `/unsafe` option is always passed to `csc`.
*ale-options.cs_csc_source*
g:ale_cs_csc_source *g:ale_cs_csc_source* *g:ale_cs_csc_source*
*b:ale_cs_csc_source* *b:ale_cs_csc_source*
cs_csc_source
g:ale_cs_csc_source
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -68,9 +74,11 @@ g:ale_cs_csc_source *g:ale_cs_csc_source*
NOTE: Currently it is not possible to specify sub directories and NOTE: Currently it is not possible to specify sub directories and
directory sub trees which shall not be searched for *.cs files. directory sub trees which shall not be searched for *.cs files.
*ale-options.cs_csc_assembly_path*
g:ale_cs_csc_assembly_path *g:ale_cs_csc_assembly_path* *g:ale_cs_csc_assembly_path*
*b:ale_cs_csc_assembly_path* *b:ale_cs_csc_assembly_path*
cs_csc_assembly_path
g:ale_cs_csc_assembly_path
Type: |List| Type: |List|
Default: `[]` Default: `[]`
@@ -78,9 +86,11 @@ g:ale_cs_csc_assembly_path *g:ale_cs_csc_assembly_path*
assembly files. The list is passed to the csc compiler using the `/lib:` assembly files. The list is passed to the csc compiler using the `/lib:`
flag. flag.
*ale-options.cs_csc_assemblies*
g:ale_cs_csc_assemblies *g:ale_cs_csc_assemblies* *g:ale_cs_csc_assemblies*
*b:ale_cs_csc_assemblies* *b:ale_cs_csc_assemblies*
cs_csc_assemblies
g:ale_cs_csc_assemblies
Type: |List| Type: |List|
Default: `[]` Default: `[]`
@@ -90,11 +100,11 @@ g:ale_cs_csc_assemblies *g:ale_cs_csc_assemblies*
For example: > For example: >
" Compile C# programs with the Unity engine DLL file on Mac. " Compile C# programs with the Unity engine DLL file on Mac.
let g:ale_cs_mcsc_assemblies = [ let g:ale_cs_mcsc_assemblies = [
\ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll', \ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll',
\ 'path-to-unityproject/obj/Debug', \ 'path-to-unityproject/obj/Debug',
\] \]
< <
=============================================================================== ===============================================================================
@@ -106,8 +116,9 @@ See |ale-cspell-options|
=============================================================================== ===============================================================================
dotnet-format *ale-cs-dotnet-format* dotnet-format *ale-cs-dotnet-format*
Installation
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Installation
Installing .NET SDK should probably ensure that `dotnet` is in your `$PATH`. Installing .NET SDK should probably ensure that `dotnet` is in your `$PATH`.
For .NET 6 the `dotnet format` tool is already included in the .NET SDK. For For .NET 6 the `dotnet format` tool is already included in the .NET SDK. For
@@ -115,20 +126,24 @@ For .NET 6 the `dotnet format` tool is already included in the .NET SDK. For
from listed in this repository: https://github.com/dotnet/format from listed in this repository: https://github.com/dotnet/format
Options
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Options
g:ale_cs_dotnet_format_executable *g:ale_cs_dotnet_format_executable* *ale-options.cs_dotnet_format_executable*
*g:ale_cs_dotnet_format_executable*
*b:ale_cs_dotnet_format_executable* *b:ale_cs_dotnet_format_executable*
cs_dotnet_format_executable
g:ale_cs_dotnet_format_executable
Type: |String| Type: |String|
Default: `'dotnet'` Default: `'dotnet'`
This variable can be set to specify an absolute path to the This variable can be set to specify an absolute path to the
`dotnet` executable (or to specify an alternate executable). `dotnet` executable (or to specify an alternate executable).
*ale-options.cs_dotnet_format_options*
g:ale_cs_dotnet_format_options *g:ale_cs_dotnet_format_options* *g:ale_cs_dotnet_format_options*
*b:ale_cs_dotnet_format_options* *b:ale_cs_dotnet_format_options*
cs_dotnet_format_options
g:ale_cs_dotnet_format_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -139,15 +154,19 @@ g:ale_cs_dotnet_format_options *g:ale_cs_dotnet_format_options*
=============================================================================== ===============================================================================
mcs *ale-cs-mcs* mcs *ale-cs-mcs*
The `mcs` linter looks only for syntax errors while you type. See The `mcs` linter looks only for syntax errors while you type. See
|ale-cs-mcsc| for the separately configured linter for checking for semantic |ale-cs-mcsc| for the separately configured linter for checking for semantic
errors. errors.
g:ale_cs_mcs_options *g:ale_cs_mcs_options* -------------------------------------------------------------------------------
Options
*ale-options.cs_mcs_options*
*g:ale_cs_mcs_options*
*b:ale_cs_mcs_options* *b:ale_cs_mcs_options*
cs_mcs_options
Type: String g:ale_cs_mcs_options
Type: |String|
Default: `''` Default: `''`
This variable can be changed to pass additional flags given to mcs. This variable can be changed to pass additional flags given to mcs.
@@ -160,26 +179,31 @@ g:ale_cs_mcs_options *g:ale_cs_mcs_options*
=============================================================================== ===============================================================================
mcsc *ale-cs-mcsc* mcsc *ale-cs-mcsc*
The mcsc linter checks for semantic errors when files are opened or saved The mcsc linter checks for semantic errors when files are opened or saved See
See |ale-lint-file-linters| for more information on linters which do not |ale-lint-file-linters| for more information on linters which do not check for
check for problems while you type. problems while you type.
The mcsc linter uses the mono mcs compiler to generate a temporary module The mcsc linter uses the mono mcs compiler to generate a temporary module
target file (-t:module). The module includes including all '*.cs' files target file (-t:module). The module includes including all '*.cs' files
contained in the directory tree rooted at the path defined by the contained in the directory tree rooted at the path defined by the
|g:ale_cs_mcsc_source| or |b:ale_cs_mcsc_source| variable. |g:ale_cs_mcsc_source| or |b:ale_cs_mcsc_source| variable. variable and all
variable and all sub directories. sub directories.
The paths to search for additional assembly files can be specified using the The paths to search for additional assembly files can be specified using the
|g:ale_cs_mcsc_assembly_path| or |b:ale_cs_mcsc_assembly_path| variables. |g:ale_cs_mcsc_assembly_path| or |b:ale_cs_mcsc_assembly_path| variables.
NOTE: ALE will not find any errors in files apart from syntax errors if any NOTE: ALE will not find any errors in files apart from syntax errors if any
one of the source files contains a syntax error. Syntax errors must be fixed one of the source files contains a syntax error. Syntax errors must be fixed
first before other errors will be shown. first before other errors will be shown.
g:ale_cs_mcsc_options *g:ale_cs_mcsc_options* -------------------------------------------------------------------------------
Options
*ale-options.cs_mcsc_options*
*g:ale_cs_mcsc_options*
*b:ale_cs_mcsc_options* *b:ale_cs_mcsc_options*
cs_mcsc_options
g:ale_cs_mcsc_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -187,13 +211,15 @@ g:ale_cs_mcsc_options *g:ale_cs_mcsc_options*
For example, to add the dotnet package which is not added per default: > For example, to add the dotnet package which is not added per default: >
let g:ale_cs_mcs_options = '-pkg:dotnet' let g:ale_cs_mcs_options = '-pkg:dotnet'
< <
NOTE: the `-unsafe` option is always passed to `mcs`. NOTE: the `-unsafe` option is always passed to `mcs`.
*ale-options.cs_mcsc_source*
g:ale_cs_mcsc_source *g:ale_cs_mcsc_source* *g:ale_cs_mcsc_source*
*b:ale_cs_mcsc_source* *b:ale_cs_mcsc_source*
cs_mcsc_source
g:ale_cs_mcsc_source
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -204,9 +230,11 @@ g:ale_cs_mcsc_source *g:ale_cs_mcsc_source*
NOTE: Currently it is not possible to specify sub directories and NOTE: Currently it is not possible to specify sub directories and
directory sub trees which shall not be searched for *.cs files. directory sub trees which shall not be searched for *.cs files.
*ale-options.cs_mcsc_assembly_path*
g:ale_cs_mcsc_assembly_path *g:ale_cs_mcsc_assembly_path* *g:ale_cs_mcsc_assembly_path*
*b:ale_cs_mcsc_assembly_path* *b:ale_cs_mcsc_assembly_path*
cs_mcsc_assembly_path
g:ale_cs_mcsc_assembly_path
Type: |List| Type: |List|
Default: `[]` Default: `[]`
@@ -214,9 +242,11 @@ g:ale_cs_mcsc_assembly_path *g:ale_cs_mcsc_assembly_path*
assembly files. The list is passed to the mcs compiler using the `-lib:` assembly files. The list is passed to the mcs compiler using the `-lib:`
flag. flag.
*ale-options.cs_mcsc_assemblies*
g:ale_cs_mcsc_assemblies *g:ale_cs_mcsc_assemblies* *g:ale_cs_mcsc_assemblies*
*b:ale_cs_mcsc_assemblies* *b:ale_cs_mcsc_assemblies*
cs_mcsc_assemblies
g:ale_cs_mcsc_assemblies
Type: |List| Type: |List|
Default: `[]` Default: `[]`
@@ -226,11 +256,11 @@ g:ale_cs_mcsc_assemblies *g:ale_cs_mcsc_assemblies*
For example: > For example: >
" Compile C# programs with the Unity engine DLL file on Mac. " Compile C# programs with the Unity engine DLL file on Mac.
let g:ale_cs_mcsc_assemblies = [ let g:ale_cs_mcsc_assemblies = [
\ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll', \ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll',
\ 'path-to-unityproject/obj/Debug', \ 'path-to-unityproject/obj/Debug',
\] \]
< <
=============================================================================== ===============================================================================
+26 -11
View File
@@ -11,24 +11,31 @@ See |ale-cspell-options|
=============================================================================== ===============================================================================
css-beautify *ale-css-css-beautify* css-beautify *ale-css-css-beautify*
g:ale_css_css_beautify_executable *g:ale_css_css_beautify_executable* *ale-options.css_css_beautify_executable*
*g:ale_css_css_beautify_executable*
*b:ale_css_css_beautify_executable* *b:ale_css_css_beautify_executable*
css_css_beautify_executable
g:ale_css_css_beautify_executable
Type: |String| Type: |String|
Default: `'css-beautify'` Default: `'css-beautify'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.css_css_beautify_options*
g:ale_css_css_beautify_options *g:ale_css_css_beautify_options* *g:ale_css_css_beautify_options*
*b:ale_css_css_beautify_options* *b:ale_css_css_beautify_options*
css_css_beautify_options
g:ale_css_css_beautify_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to css-beautify. This variable can be set to pass additional options to css-beautify.
*ale-options.css_css_beautify_use_global*
g:ale_css_css_beautify_use_global *g:ale_css_css_beautify_use_global* *g:ale_css_css_beautify_use_global*
*b:ale_css_css_beautify_use_global* *b:ale_css_css_beautify_use_global*
css_css_beautify_use_global
g:ale_css_css_beautify_use_global
Type: |String| Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -52,24 +59,31 @@ See |ale-javascript-prettier| for information about the available options.
=============================================================================== ===============================================================================
stylelint *ale-css-stylelint* stylelint *ale-css-stylelint*
g:ale_css_stylelint_executable *g:ale_css_stylelint_executable* *ale-options.css_stylelint_executable*
*g:ale_css_stylelint_executable*
*b:ale_css_stylelint_executable* *b:ale_css_stylelint_executable*
css_stylelint_executable
g:ale_css_stylelint_executable
Type: |String| Type: |String|
Default: `'stylelint'` Default: `'stylelint'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.css_stylelint_options*
g:ale_css_stylelint_options *g:ale_css_stylelint_options* *g:ale_css_stylelint_options*
*b:ale_css_stylelint_options* *b:ale_css_stylelint_options*
css_stylelint_options
g:ale_css_stylelint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to stylelint. This variable can be set to pass additional options to stylelint.
*ale-options.css_stylelint_use_global*
g:ale_css_stylelint_use_global *g:ale_css_stylelint_use_global* *g:ale_css_stylelint_use_global*
*b:ale_css_stylelint_use_global* *b:ale_css_stylelint_use_global*
css_stylelint_use_global
g:ale_css_stylelint_use_global
Type: |String| Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -81,8 +95,9 @@ vscodecss *ale-css-vscode*
Website: https://github.com/hrsh7th/vscode-langservers-extracted Website: https://github.com/hrsh7th/vscode-langservers-extracted
Installation
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Installation
Install VSCode css language server either globally or locally: > Install VSCode css language server either globally or locally: >
+16 -6
View File
@@ -12,16 +12,21 @@ Note that the C options are also used for CUDA.
=============================================================================== ===============================================================================
clangd *ale-cuda-clangd* clangd *ale-cuda-clangd*
g:ale_cuda_clangd_executable *g:ale_cuda_clangd_executable* *ale-options.cuda_clangd_executable*
*g:ale_cuda_clangd_executable*
*b:ale_cuda_clangd_executable* *b:ale_cuda_clangd_executable*
cuda_clangd_executable
g:ale_cuda_clangd_executable
Type: |String| Type: |String|
Default: `'clangd'` Default: `'clangd'`
This variable can be changed to use a different executable for clangd. This variable can be changed to use a different executable for clangd.
*ale-options.cuda_clangd_options*
g:ale_cuda_clangd_options *g:ale_cuda_clangd_options* *g:ale_cuda_clangd_options*
*b:ale_cuda_clangd_options* *b:ale_cuda_clangd_options*
cuda_clangd_options
g:ale_cuda_clangd_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -31,17 +36,22 @@ g:ale_cuda_clangd_options *g:ale_cuda_clangd_options*
=============================================================================== ===============================================================================
nvcc *ale-cuda-nvcc* nvcc *ale-cuda-nvcc*
g:ale_cuda_nvcc_executable *g:ale_cuda_nvcc_executable* *ale-options.cuda_nvcc_executable*
*g:ale_cuda_nvcc_executable*
*b:ale_cuda_nvcc_executable* *b:ale_cuda_nvcc_executable*
cuda_nvcc_executable
g:ale_cuda_nvcc_executable
Type: |String| Type: |String|
Default: `'nvcc'` Default: `'nvcc'`
This variable can be changed to use a different executable for nvcc. This variable can be changed to use a different executable for nvcc.
Currently only nvcc 8.0 is supported. Currently only nvcc 8.0 is supported.
*ale-options.cuda_nvcc_options*
g:ale_cuda_nvcc_options *g:ale_cuda_nvcc_options* *g:ale_cuda_nvcc_options*
*b:ale_cuda_nvcc_options* *b:ale_cuda_nvcc_options*
cuda_nvcc_options
g:ale_cuda_nvcc_options
Type: |String| Type: |String|
Default: `'-std=c++11'` Default: `'-std=c++11'`
+11 -4
View File
@@ -1,25 +1,32 @@
=============================================================================== ===============================================================================
ALE D Integration *ale-d-options* ALE D Integration *ale-d-options*
=============================================================================== ===============================================================================
dfmt *ale-d-dfmt* dfmt *ale-d-dfmt*
g:ale_d_dfmt_options *g:ale_d_dfmt_options* *ale-options.d_dfmt_options*
*g:ale_d_dfmt_options*
*b:ale_d_dfmt_options* *b:ale_d_dfmt_options*
d_dfmt_options
g:ale_d_dfmt_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to the dfmt fixer. This variable can be set to pass additional options to the dfmt fixer.
=============================================================================== ===============================================================================
dls *ale-d-dls* dls *ale-d-dls*
g:ale_d_dls_executable *g:ale_d_dls_executable* *ale-options.d_dls_executable*
*g:ale_d_dls_executable*
*b:ale_d_dls_executable* *b:ale_d_dls_executable*
d_dls_executable
g:ale_d_dls_executable
Type: |String| Type: |String|
Default: `dls` Default: `dls`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
=============================================================================== ===============================================================================
+5 -1
View File
@@ -5,12 +5,16 @@ ALE Dafny Integration *ale-dafny-options*
=============================================================================== ===============================================================================
dafny *ale-dafny-dafny* dafny *ale-dafny-dafny*
g:ale_dafny_dafny_timelimit *g:ale_dafny_dafny_timelimit* *ale-options.dafny_dafny_timelimit*
*g:ale_dafny_dafny_timelimit*
*b:ale_dafny_dafny_timelimit* *b:ale_dafny_dafny_timelimit*
dafny_dafny_timelimit
g:ale_dafny_dafny_timelimit
Type: |Number| Type: |Number|
Default: `10` Default: `10`
This variable sets the `/timeLimit` used for dafny. This variable sets the `/timeLimit` used for dafny.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+47 -27
View File
@@ -5,8 +5,9 @@ ALE Dart Integration *ale-dart-options*
=============================================================================== ===============================================================================
analysis_server *ale-dart-analysis_server* analysis_server *ale-dart-analysis_server*
Installation
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Installation
Install Dart via whatever means. `analysis_server` will be included in the SDK. Install Dart via whatever means. `analysis_server` will be included in the SDK.
@@ -16,20 +17,23 @@ its absolute path. : >
let g:ale_dart_analysis_server_executable = '/usr/local/bin/dart' let g:ale_dart_analysis_server_executable = '/usr/local/bin/dart'
< <
Options
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Options
g:ale_dart_analysis_server_executable *g:ale_dart_analysis_server_executable* *ale-options.dart_analysis_server_executable*
*g:ale_dart_analysis_server_executable*
*b:ale_dart_analysis_server_executable* *b:ale_dart_analysis_server_executable*
dart_analysis_server_executable
g:ale_dart_analysis_server_executable
Type: |String| Type: |String|
Default: `'dart'` Default: `'dart'`
This variable can be set to change the path of dart. This variable can be set to change the path of dart.
*ale-options.dart_analysis_server_enable_language_server*
g:ale_dart_analysis_server_enable_language_server
*g:ale_dart_analysis_server_enable_language_server* *g:ale_dart_analysis_server_enable_language_server*
*b:ale_dart_analysis_server_enable_language_server* *b:ale_dart_analysis_server_enable_language_server*
dart_analysis_server_enable_language_server
g:ale_dart_analysis_server_enable_language_server
Type: |Number| Type: |Number|
Default: `1` Default: `1`
@@ -43,8 +47,9 @@ g:ale_dart_analysis_server_enable_language_server
=============================================================================== ===============================================================================
dart-analyze *ale-dart-analyze* dart-analyze *ale-dart-analyze*
Installation
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Installation
Installing Dart should probably ensure that `dart` is in your `$PATH`. Installing Dart should probably ensure that `dart` is in your `$PATH`.
@@ -55,11 +60,14 @@ In case it is not, try to set the executable option to its absolute path. : >
Install Dart via whatever means. `dart analyze` will be included in the SDK. Install Dart via whatever means. `dart analyze` will be included in the SDK.
Options
-------------------------------------------------------------------------------
g:ale_dart_analyze_executable *g:ale_dart_analyze_executable* -------------------------------------------------------------------------------
Options
*ale-options.dart_analyze_executable*
*g:ale_dart_analyze_executable*
*b:ale_dart_analyze_executable* *b:ale_dart_analyze_executable*
dart_analyze_executable
g:ale_dart_analyze_executable
Type: |String| Type: |String|
Default: `'dart'` Default: `'dart'`
@@ -70,30 +78,36 @@ g:ale_dart_analyze_executable *g:ale_dart_analyze_executable*
=============================================================================== ===============================================================================
dart-format *ale-dart-format* dart-format *ale-dart-format*
Installation
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Installation
Installing Dart should probably ensure that `dart` is in your `$PATH`. Installing Dart should probably ensure that `dart` is in your `$PATH`.
In case it is not, try to set the executable option to its absolute path. : > In case it is not, try to set the executable option to its absolute path: >
" Set the executable path for dart to the absolute path to it. " Set the executable path for dart to the absolute path to it.
let g:ale_dart_format_executable = '/usr/lib/dart/bin/dart' let g:ale_dart_format_executable = '/usr/lib/dart/bin/dart'
> <
Options
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Options
g:ale_dart_format_executable *g:ale_dart_format_executable* *ale-options.dart_format_executable*
*g:ale_dart_format_executable*
*b:ale_dart_format_executable* *b:ale_dart_format_executable*
dart_format_executable
g:ale_dart_format_executable
Type: |String| Type: |String|
Default: `'dart'` Default: `'dart'`
This variable can be set to specify an absolute path to the This variable can be set to specify an absolute path to the
format executable (or to specify an alternate executable). format executable (or to specify an alternate executable).
*ale-options.dart_format_options*
g:ale_dart_format_options *g:ale_dart_format_options* *g:ale_dart_format_options*
*b:ale_dart_format_options* *b:ale_dart_format_options*
dart_format_options
g:ale_dart_format_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -103,35 +117,41 @@ g:ale_dart_format_options *g:ale_dart_format_options*
=============================================================================== ===============================================================================
dartfmt *ale-dart-dartfmt* dartfmt *ale-dart-dartfmt*
Installation
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Installation
Installing Dart should probably ensure that `dartfmt` is in your `$PATH`. Installing Dart should probably ensure that `dartfmt` is in your `$PATH`.
In case it is not, try to set the executable option to its absolute path. : > In case it is not, try to set the executable option to its absolute path: >
" Set the executable path for dartfmt to the absolute path to it. " Set the executable path for dartfmt to the absolute path to it.
let g:ale_dart_dartfmt_executable = '/usr/lib/dart/bin/dartfmt' let g:ale_dart_dartfmt_executable = '/usr/lib/dart/bin/dartfmt'
> <
Options
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Options
g:ale_dart_dartfmt_executable *g:ale_dart_dartfmt_executable* *ale-options.dart_dartfmt_executable*
*g:ale_dart_dartfmt_executable*
*b:ale_dart_dartfmt_executable* *b:ale_dart_dartfmt_executable*
dart_dartfmt_executable
g:ale_dart_dartfmt_executable
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to specify an absolute path to the This variable can be set to specify an absolute path to the
dartfmt executable (or to specify an alternate executable). dartfmt executable (or to specify an alternate executable).
*ale-options.dart_dartfmt_options*
g:ale_dart_dartfmt_options *g:ale_dart_dartfmt_options* *g:ale_dart_dartfmt_options*
*b:ale_dart_dartfmt_options* *b:ale_dart_dartfmt_options*
dart_dartfmt_options
g:ale_dart_dartfmt_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to the dartfmt fixer. This variable can be set to pass additional options to the dartfmt fixer.
===============================================================================
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+6 -1
View File
@@ -8,14 +8,19 @@ desktop-file-validate *ale-desktop-desktop-file-validate*
ALE supports checking .desktop files with `desktop-file-validate.` ALE supports checking .desktop files with `desktop-file-validate.`
g:ale_desktop_desktop_file_validate_options -------------------------------------------------------------------------------
Options
*ale-options.desktop_desktop_file_validate_options*
*g:ale_desktop_desktop_file_validate_options* *g:ale_desktop_desktop_file_validate_options*
*b:ale_desktop_desktop_file_validate_options* *b:ale_desktop_desktop_file_validate_options*
desktop_desktop_file_validate_options
g:ale_desktop_desktop_file_validate_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to set options for `desktop-file-validate`, This variable can be changed to set options for `desktop-file-validate`,
such as `'--warn-kde'`. such as `'--warn-kde'`.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+10
View File
@@ -17,6 +17,7 @@ CONTENTS *ale-development-contents*
5. Contributing.........................|ale-development-contributing| 5. Contributing.........................|ale-development-contributing|
5.1. Preparing a Release..............|ale-development-release| 5.1. Preparing a Release..............|ale-development-release|
=============================================================================== ===============================================================================
1. Introduction *ale-development-introduction* 1. Introduction *ale-development-introduction*
@@ -25,6 +26,7 @@ design goals, information on how to run the tests, coding standards, and so
on. You should read this document if you want to get involved with ALE on. You should read this document if you want to get involved with ALE
development. development.
=============================================================================== ===============================================================================
2. Design Goals *ale-design-goals* 2. Design Goals *ale-design-goals*
@@ -66,6 +68,7 @@ better support for LSP features as time goes on.
When merging pull requests, you should respond with `Cheers! :beers:`, purely When merging pull requests, you should respond with `Cheers! :beers:`, purely
for comedy value. for comedy value.
=============================================================================== ===============================================================================
3. Coding Standards *ale-coding-standards* 3. Coding Standards *ale-coding-standards*
@@ -147,6 +150,7 @@ Apply the following rules when writing Bash scripts.
See: https://github.com/koalaman/shellcheck See: https://github.com/koalaman/shellcheck
* Try to write scripts so they will run on Linux, BSD, or Mac OSX. * Try to write scripts so they will run on Linux, BSD, or Mac OSX.
=============================================================================== ===============================================================================
4. Testing ALE *ale-development-tests* *ale-dev-tests* *ale-tests* 4. Testing ALE *ale-development-tests* *ale-dev-tests* *ale-tests*
@@ -246,6 +250,7 @@ margin. For example, if you add a heading for an `aardvark` tool to
Make sure to make the table of contents match the headings, and to keep the Make sure to make the table of contents match the headings, and to keep the
doc tags on the right margin. doc tags on the right margin.
=============================================================================== ===============================================================================
4.1 Writing Linter Tests *ale-development-linter-tests* 4.1 Writing Linter Tests *ale-development-linter-tests*
@@ -326,6 +331,7 @@ given the above setup are as follows.
`AssertLSPProject project_root` - Check the root given to an LSP server. `AssertLSPProject project_root` - Check the root given to an LSP server.
`AssertLSPAddress address` - Check the address to an LSP server. `AssertLSPAddress address` - Check the address to an LSP server.
=============================================================================== ===============================================================================
4.2 Writing Fixer Tests *ale-development-fixer-tests* 4.2 Writing Fixer Tests *ale-development-fixer-tests*
@@ -367,6 +373,7 @@ given the above setup are as follows.
`AssertFixer results` - Check the fixer results `AssertFixer results` - Check the fixer results
`AssertFixerNotExecuted` - Check that fixers will not be executed. `AssertFixerNotExecuted` - Check that fixers will not be executed.
=============================================================================== ===============================================================================
4.3 Running Tests in a Windows VM *ale-development-windows-tests* 4.3 Running Tests in a Windows VM *ale-development-windows-tests*
@@ -443,6 +450,7 @@ You can run a specific test by passing the filename as an argument to the
batch file, for example: `run-tests test/test_c_flag_parsing.vader` . This will batch file, for example: `run-tests test/test_c_flag_parsing.vader` . This will
give you results much more quickly. give you results much more quickly.
=============================================================================== ===============================================================================
5. Contributing *ale-development-contributing* 5. Contributing *ale-development-contributing*
@@ -461,6 +469,7 @@ and profile settings. See: https://docs.github.com/en/account-and-profile/
Unless configuring GitHub to expose contact details, commits will be rewritten Unless configuring GitHub to expose contact details, commits will be rewritten
to appear by `USERNAME <RANDOM_NUMBER+USERNAME@users.noreply.github.com>` . to appear by `USERNAME <RANDOM_NUMBER+USERNAME@users.noreply.github.com>` .
=============================================================================== ===============================================================================
5.1 Preparing a Release *ale-development-release* 5.1 Preparing a Release *ale-development-release*
@@ -532,5 +541,6 @@ Once you do, follow these steps.
Have fun creating ALE releases. Drink responsibly, or not at all, which is the Have fun creating ALE releases. Drink responsibly, or not at all, which is the
preference of w0rp. preference of w0rp.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+16 -11
View File
@@ -1,13 +1,21 @@
=============================================================================== ===============================================================================
ALE Dhall Integration *ale-dhall-options* ALE Dhall Integration *ale-dhall-options*
g:ale_dhall_executable *g:ale_dhall_executable* Dhall - https://dhall-lang.org/
*ale-options.dhall_executable*
*g:ale_dhall_executable*
*b:ale_dhall_executable* *b:ale_dhall_executable*
dhall_executable
g:ale_dhall_executable
Type: |String| Type: |String|
Default: `'dhall'` Default: `'dhall'`
g:ale_dhall_options *g:ale_dhall_options* *ale-options.dhall_options*
*g:ale_dhall_options*
*b:ale_dhall_options* *b:ale_dhall_options*
dhall_options
g:ale_dhall_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -20,18 +28,18 @@ g:ale_dhall_options *g:ale_dhall_options*
=============================================================================== ===============================================================================
dhall-format *ale-dhall-format* dhall-format *ale-dhall-format*
Dhall
(https://dhall-lang.org/)
=============================================================================== ===============================================================================
dhall-freeze *ale-dhall-freeze* dhall-freeze *ale-dhall-freeze*
Dhall
(https://dhall-lang.org/)
g:ale_dhall_freeze_options *g:ale_dhall_freeze_options* -------------------------------------------------------------------------------
Options
*ale-options.dhall_freeze_options*
*g:ale_dhall_freeze_options*
*b:ale_dhall_freeze_options* *b:ale_dhall_freeze_options*
dhall_freeze_options
g:ale_dhall_freeze_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -44,9 +52,6 @@ g:ale_dhall_freeze_options *g:ale_dhall_freeze_options*
=============================================================================== ===============================================================================
dhall-lint *ale-dhall-lint* dhall-lint *ale-dhall-lint*
Dhall
(https://dhall-lang.org/)
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+28 -14
View File
@@ -5,19 +5,22 @@ ALE Dockerfile Integration *ale-dockerfile-options*
=============================================================================== ===============================================================================
dockerfile_lint *ale-dockerfile-dockerfile_lint* dockerfile_lint *ale-dockerfile-dockerfile_lint*
g:ale_dockerfile_dockerfile_lint_executable *ale-options.dockerfile_dockerfile_lint_executable*
*g:ale_dockerfile_dockerfile_lint_executable* *g:ale_dockerfile_dockerfile_lint_executable*
*b:ale_dockerfile_dockerfile_lint_executable* *b:ale_dockerfile_dockerfile_lint_executable*
dockerfile_dockerfile_lint_executable
g:ale_dockerfile_dockerfile_lint_executable
Type: |String| Type: |String|
Default: `'dockerfile_lint'` Default: `'dockerfile_lint'`
This variable can be changed to specify the executable used to run This variable can be changed to specify the executable used to run
dockerfile_lint. dockerfile_lint.
*ale-options.dockerfile_dockerfile_lint_options*
g:ale_dockerfile_dockerfile_lint_options
*g:ale_dockerfile_dockerfile_lint_options* *g:ale_dockerfile_dockerfile_lint_options*
*b:ale_dockerfile_dockerfile_lint_options* *b:ale_dockerfile_dockerfile_lint_options*
dockerfile_dockerfile_lint_options
g:ale_dockerfile_dockerfile_lint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -28,9 +31,11 @@ g:ale_dockerfile_dockerfile_lint_options
=============================================================================== ===============================================================================
dockerlinter *ale-dockerfile-dockerlinter* dockerlinter *ale-dockerfile-dockerlinter*
g:ale_dockerfile_dockerlinter_executable *ale-options.dockerfile_dockerlinter_executable*
*g:ale_dockerfile_dockerlinter_executable* *g:ale_dockerfile_dockerlinter_executable*
*b:ale_dockerfile_dockerlinter_executable* *b:ale_dockerfile_dockerlinter_executable*
dockerfile_dockerlinter_executable
g:ale_dockerfile_dockerlinter_executable
Type: |String| Type: |String|
Default: `'dockerlinter'` Default: `'dockerlinter'`
@@ -38,17 +43,17 @@ g:ale_dockerfile_dockerlinter_executable
dockerlinter. dockerlinter.
g:ale_dockerfile_dockerlinter_options *ale-options.dockerfile_dockerlinter_options*
*g:ale_dockerfile_dockerlinter_options* *g:ale_dockerfile_dockerlinter_options*
*b:ale_dockerfile_dockerlinter_options* *b:ale_dockerfile_dockerlinter_options*
dockerfile_dockerlinter_options
g:ale_dockerfile_dockerlinter_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to add additional command-line arguments to This variable can be changed to add additional command-line arguments to
the dockerfile lint invocation - like custom rule file definitions. the dockerfile lint invocation - like custom rule file definitions.
dockerlinter
=============================================================================== ===============================================================================
dprint *ale-dockerfile-dprint* dprint *ale-dockerfile-dprint*
@@ -59,11 +64,16 @@ See |ale-dprint-options| and https://dprint.dev/plugins/dockerfile
=============================================================================== ===============================================================================
hadolint *ale-dockerfile-hadolint* hadolint *ale-dockerfile-hadolint*
hadolint can be found at: https://github.com/hadolint/hadolint hadolint can be found at: https://github.com/hadolint/hadolint
g:ale_dockerfile_hadolint_options *g:ale_dockerfile_hadolint_options* -------------------------------------------------------------------------------
Options
*ale-options.dockerfile_hadolint_options*
*g:ale_dockerfile_hadolint_options*
*b:ale_dockerfile_hadolint_options* *b:ale_dockerfile_hadolint_options*
dockerfile_hadolint_options
g:ale_dockerfile_hadolint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -71,9 +81,11 @@ g:ale_dockerfile_hadolint_options *g:ale_dockerfile_hadolint_options*
invocation. These arguments will be used whether docker is being used or not invocation. These arguments will be used whether docker is being used or not
(see below). (see below).
*ale-options.dockerfile_hadolint_use_docker*
g:ale_dockerfile_hadolint_use_docker *g:ale_dockerfile_hadolint_use_docker* *g:ale_dockerfile_hadolint_use_docker*
*b:ale_dockerfile_hadolint_use_docker* *b:ale_dockerfile_hadolint_use_docker*
dockerfile_hadolint_use_docker
g:ale_dockerfile_hadolint_use_docker
Type: |String| Type: |String|
Default: `'never'` Default: `'never'`
@@ -85,16 +97,18 @@ g:ale_dockerfile_hadolint_use_docker *g:ale_dockerfile_hadolint_use_docker*
For now, the default is 'never'. This may change as ale's support for using For now, the default is 'never'. This may change as ale's support for using
docker to lint evolves. docker to lint evolves.
*ale-options.dockerfile_hadolint_image*
g:ale_dockerfile_hadolint_image *g:ale_dockerfile_hadolint_image* *g:ale_dockerfile_hadolint_image*
*b:ale_dockerfile_hadolint_image* *b:ale_dockerfile_hadolint_image*
dockerfile_hadolint_image
g:ale_dockerfile_hadolint_image
Type: |String| Type: |String|
Default: `'hadolint/hadolint'` Default: `'hadolint/hadolint'`
This variable controls the docker image used to run hadolint. The default This variable controls the docker image used to run hadolint. The default
is hadolint's author's build, and can be found at: is hadolint's author's build, and can be found at:
https://hub.docker.com/r/hadolint/hadolint/ https://hub.docker.com/r/hadolint/hadolint/
=============================================================================== ===============================================================================
+36 -16
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. The `mix` linter is disabled by default, as it can be too expensive to run.
See `:help g:ale_linters` See `:help g:ale_linters`
*ale-options.elixir_mix_options*
g:ale_elixir_mix_options *g:ale_elixir_mix_options* *g:ale_elixir_mix_options*
*b:ale_elixir_mix_options* *b:ale_elixir_mix_options*
elixir_mix_options
g:ale_elixir_mix_options
Type: |String| Type: |String|
Default: `'mix'` Default: `'mix'`
@@ -21,8 +23,11 @@ g:ale_elixir_mix_options *g:ale_elixir_mix_options*
=============================================================================== ===============================================================================
mix_format *ale-elixir-mix-format* 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* *b:ale_elixir_mix_format_options*
elixir_mix_format_options
g:ale_elixir_mix_format_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -52,26 +57,33 @@ elixir-ls *ale-elixir-elixir-ls*
Elixir Language Server (https://github.com/JakeBecker/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* *b:ale_elixir_elixir_ls_release*
elixir_elixir_ls_release
g:ale_elixir_elixir_ls_release
Type: |String| Type: |String|
Default: `'elixir-ls'` Default: `'elixir-ls'`
Location of the elixir-ls release directory. This directory must contain Location of the elixir-ls release directory. This directory must contain
the language server scripts (language_server.sh and language_server.bat). 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* *b:ale_elixir_elixir_ls_config*
elixir_elixir_ls_config
g:ale_elixir_elixir_ls_config
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
Dictionary containing configuration settings that will be passed to the Dictionary containing configuration settings that will be passed to the
language server. For example, to disable Dialyzer: > language server. For example, to disable Dialyzer: >
{
\ 'elixirLS': { let g:ale_elixir_elixir_ls_config = {
\ 'dialyzerEnabled': v:false, \ 'elixirLS': {
\ }, \ 'dialyzerEnabled': v:false,
\ } \ },
\}
< <
Consult the ElixirLS documentation for more information about settings. Consult the ElixirLS documentation for more information about settings.
@@ -81,17 +93,22 @@ credo *ale-elixir-credo*
Credo (https://github.com/rrrene/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| Type: |Integer|
Default: `0` Default: `0`
Tells credo to run in strict mode or suggest mode. Set variable to 1 to Tells credo to run in strict mode or suggest mode. Set variable to 1 to
enable --strict mode. enable --strict mode.
*ale-options.elixir_credo_config_file*
g:ale_elixir_credo_config_file *g:ale_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| Type: |String|
Default: `''` Default: `''`
@@ -109,8 +126,11 @@ lexical *ale-elixir-lexical*
Lexical (https://github.com/lexical-lsp/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* *b:ale_elixir_lexical_release*
elixir_lexical_release
g:ale_elixir_lexical_release
Type: |String| Type: |String|
Default: `'lexical'` Default: `'lexical'`
+47 -19
View File
@@ -5,96 +5,124 @@ ALE Elm Integration *ale-elm-options*
=============================================================================== ===============================================================================
elm-format *ale-elm-elm-format* elm-format *ale-elm-elm-format*
g:ale_elm_format_executable *g:ale_elm_format_executable* *ale-options.elm_format_executable*
*g:ale_elm_format_executable*
*b:ale_elm_format_executable* *b:ale_elm_format_executable*
elm_format_executable
g:ale_elm_format_executable
Type: |String| Type: |String|
Default: `'elm-format'` Default: `'elm-format'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.elm_format_use_global*
g:ale_elm_format_use_global *g:ale_elm_format_use_global* *g:ale_elm_format_use_global*
*b:ale_elm_format_use_global* *b:ale_elm_format_use_global*
elm_format_use_global
g:ale_elm_format_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.elm_format_options*
g:ale_elm_format_options *g:ale_elm_format_options* *g:ale_elm_format_options*
*b:ale_elm_format_options* *b:ale_elm_format_options*
elm_format_options
g:ale_elm_format_options
Type: |String| Type: |String|
Default: `'--yes'` Default: `'--yes'`
This variable can be set to pass additional options to elm-format. This variable can be set to pass additional options to elm-format.
=============================================================================== ===============================================================================
elm-ls *ale-elm-elm-ls* elm-ls *ale-elm-elm-ls*
g:ale_elm_ls_executable *g:ale_elm_ls_executable* *ale-options.elm_ls_executable*
*g:ale_elm_ls_executable*
*b:ale_elm_ls_executable* *b:ale_elm_ls_executable*
elm_ls_executable
g:ale_elm_ls_executable
Type: |String| Type: |String|
Default: `'elm-language-server'` Default: `'elm-language-server'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.elm_ls_use_global*
g:ale_elm_ls_use_global *g:ale_elm_ls_use_global* *g:ale_elm_ls_use_global*
*b:ale_elm_ls_use_global* *b:ale_elm_ls_use_global*
elm_ls_use_global
g:ale_elm_ls_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 1)` Default: `get(g:, 'ale_use_global_executables', 1)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.elm_ls_elm_path*
g:ale_elm_ls_elm_path *g:ale_elm_ls_elm_path* *g:ale_elm_ls_elm_path*
*b:ale_elm_ls_elm_path* *b:ale_elm_ls_elm_path*
elm_ls_elm_path
g:ale_elm_ls_elm_path
Type: |String| Type: |String|
Default: `''` Default: `''`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.elm_ls_elm_format_path*
g:ale_elm_ls_elm_format_path *g:ale_elm_ls_elm_format_path* *g:ale_elm_ls_elm_format_path*
*b:ale_elm_ls_elm_format_path* *b:ale_elm_ls_elm_format_path*
elm_ls_elm_format_path
g:ale_elm_ls_elm_format_path
Type: |String| Type: |String|
Default: `''` Default: `''`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.elm_ls_elm_test_path*
g:ale_elm_ls_elm_test_path *g:ale_elm_ls_elm_test_path* *g:ale_elm_ls_elm_test_path*
*b:ale_elm_ls_elm_test_path* *b:ale_elm_ls_elm_test_path*
elm_ls_elm_test_path
g:ale_elm_ls_elm_test_path
Type: |String| Type: |String|
Default: `''` Default: `''`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.elm_ls_elm_analyse_trigger*
g:ale_elm_ls_elm_analyse_trigger *g:ale_elm_ls_elm_analyse_trigger* *g:ale_elm_ls_elm_analyse_trigger*
*b:ale_elm_ls_elm_analyse_trigger* *b:ale_elm_ls_elm_analyse_trigger*
elm_ls_elm_analyse_trigger
g:ale_elm_ls_elm_analyse_trigger
Type: |String| Type: |String|
Default: `'change'` Default: `'change'`
One of 'change', 'save' or 'never' One of 'change', 'save' or 'never'
=============================================================================== ===============================================================================
elm-make *ale-elm-elm-make* elm-make *ale-elm-elm-make*
g:ale_elm_make_executable *g:ale_elm_make_executable* *ale-options.elm_make_executable*
*g:ale_elm_make_executable*
*b:ale_elm_make_executable* *b:ale_elm_make_executable*
elm_make_executable
g:ale_elm_make_executable
Type: |String| Type: |String|
Default: `'elm'` Default: `'elm'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.elm_make_use_global*
g:ale_elm_make_use_global *g:ale_elm_make_use_global* *g:ale_elm_make_use_global*
*b:ale_elm_make_use_global* *b:ale_elm_make_use_global*
elm_make_use_global
g:ale_elm_make_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+80 -30
View File
@@ -5,34 +5,44 @@ ALE Erlang Integration *ale-erlang-options*
=============================================================================== ===============================================================================
dialyzer *ale-erlang-dialyzer* dialyzer *ale-erlang-dialyzer*
g:ale_erlang_dialyzer_executable *g:ale_erlang_dialyzer_executable* *ale-options.erlang_dialyzer_executable*
*g:ale_erlang_dialyzer_executable*
*b:ale_erlang_dialyzer_executable* *b:ale_erlang_dialyzer_executable*
erlang_dialyzer_executable
g:ale_erlang_dialyzer_executable
Type: |String| Type: |String|
Default: `'dialyzer'` Default: `'dialyzer'`
This variable can be changed to specify the dialyzer executable. This variable can be changed to specify the dialyzer executable.
*ale-options.erlang_dialyzer_options*
g:ale_erlang_dialyzer_options *g:ale_erlang_dialyzer_options* *g:ale_erlang_dialyzer_options*
*b:ale_erlang_dialyzer_options* *b:ale_erlang_dialyzer_options*
erlang_dialyzer_options
g:ale_erlang_dialyzer_options
Type: |String| Type: |String|
Default: `'-Wunmatched_returns -Werror_handling -Wrace_conditions -Wunderspec'` Default: `'-Wunmatched_returns -Werror_handling -Wrace_conditions -Wunderspec'`
This variable can be changed to specify the options to pass to the dialyzer This variable can be changed to specify the options to pass to the dialyzer
executable. executable.
*ale-options.erlang_dialyzer_plt_file*
g:ale_erlang_dialyzer_plt_file *g:ale_erlang_dialyzer_plt_file* *g:ale_erlang_dialyzer_plt_file*
*b:ale_erlang_dialyzer_plt_file* *b:ale_erlang_dialyzer_plt_file*
erlang_dialyzer_plt_file
g:ale_erlang_dialyzer_plt_file
Type: |String| Type: |String|
Default: `''`
This variable can be changed to specify the path to the PLT file. By This variable can be changed to specify the path to the PLT file. By
default, it will search for the PLT file inside the `_build` directory. If default, it will search for the PLT file inside the `_build` directory. If
there isn't one, it will fallback to the path `$REBAR_PLT_DIR/dialyzer/plt`. there isn't one, it will fallback to the path `$REBAR_PLT_DIR/dialyzer/plt`.
Otherwise, it will default to `$HOME/.dialyzer_plt`. Otherwise, it will default to `$HOME/.dialyzer_plt`.
*ale-options.erlang_dialyzer_rebar3_profile*
g:ale_erlang_dialyzer_rebar3_profile *g:ale_erlang_dialyzer_rebar3_profile* *g:ale_erlang_dialyzer_rebar3_profile*
*b:ale_erlang_dialyzer_rebar3_profile* *b:ale_erlang_dialyzer_rebar3_profile*
erlang_dialyzer_rebar3_profile
g:ale_erlang_dialyzer_rebar3_profile
Type: |String| Type: |String|
Default: `'default'` Default: `'default'`
@@ -40,106 +50,138 @@ g:ale_erlang_dialyzer_rebar3_profile *g:ale_erlang_dialyzer_rebar3_profile*
run dialyzer with rebar3. run dialyzer with rebar3.
------------------------------------------------------------------------------- ===============================================================================
elvis *ale-erlang-elvis* elvis *ale-erlang-elvis*
g:ale_erlang_elvis_executable *g:ale_erlang_elvis_executable* *ale-options.erlang_elvis_executable*
*g:ale_erlang_elvis_executable*
*b:ale_erlang_elvis_executable* *b:ale_erlang_elvis_executable*
erlang_elvis_executable
g:ale_erlang_elvis_executable
Type: |String| Type: |String|
Default: `'elvis'` Default: `'elvis'`
This variable can be changed to specify the elvis executable. This variable can be changed to specify the elvis executable.
------------------------------------------------------------------------------- ===============================================================================
erlang-mode *ale-erlang-erlang-mode* erlang-mode *ale-erlang-erlang-mode*
g:ale_erlang_erlang_mode_emacs_executable *ale-options.erlang_erlang_mode_emacs_executable*
*g:ale_erlang_erlang_mode_emacs_executable* *g:ale_erlang_erlang_mode_emacs_executable*
*b:ale_erlang_erlang_mode_emacs_executable* *b:ale_erlang_erlang_mode_emacs_executable*
erlang_erlang_mode_emacs_executable
g:ale_erlang_erlang_mode_emacs_executable
Type: |String| Type: |String|
Default: `'emacs'` Default: `'emacs'`
This variable can be changed to specify the Emacs executable. This variable can be changed to specify the Emacs executable.
g:ale_erlang_erlang_mode_indent_level *g:ale_erlang_erlang_mode_indent_level* *ale-options.erlang_erlang_mode_indent_level*
*g:ale_erlang_erlang_mode_indent_level*
*b:ale_erlang_erlang_mode_indent_level* *b:ale_erlang_erlang_mode_indent_level*
erlang_erlang_mode_indent_level
g:ale_erlang_erlang_mode_indent_level
Type: |Number| Type: |Number|
Default: `4` Default: `4`
Indentation of Erlang calls/clauses within blocks. Indentation of Erlang calls/clauses within blocks.
g:ale_erlang_erlang_mode_icr_indent *g:ale_erlang_erlang_mode_icr_indent* *ale-options.erlang_erlang_mode_icr_indent*
*g:ale_erlang_erlang_mode_icr_indent*
*b:ale_erlang_erlang_mode_icr_indent* *b:ale_erlang_erlang_mode_icr_indent*
erlang_erlang_mode_icr_indent
g:ale_erlang_erlang_mode_icr_indent
Type: `'nil'` or |Number| Type: `'nil'` or |Number|
Default: `'nil'` Default: `'nil'`
Indentation of Erlang if/case/receive patterns. `'nil'` means keeping default Indentation of Erlang if/case/receive patterns. `'nil'` means keeping default
behavior. When non-`'nil'`, indent to the column of if/case/receive. behavior. When non-`'nil'`, indent to the column of if/case/receive.
g:ale_erlang_erlang_mode_indent_guard *g:ale_erlang_erlang_mode_indent_guard* *ale-options.erlang_erlang_mode_indent_guard*
*g:ale_erlang_erlang_mode_indent_guard*
*b:ale_erlang_erlang_mode_indent_guard* *b:ale_erlang_erlang_mode_indent_guard*
erlang_erlang_mode_indent_guard
g:ale_erlang_erlang_mode_indent_guard
Type: |Number| Type: |Number|
Default: `2` Default: `2`
Indentation of Erlang guards. Indentation of Erlang guards.
g:ale_erlang_erlang_mode_argument_indent *ale-options.erlang_erlang_mode_argument_indent*
*g:ale_erlang_erlang_mode_argument_indent* *g:ale_erlang_erlang_mode_argument_indent*
*b:ale_erlang_erlang_mode_argument_indent* *b:ale_erlang_erlang_mode_argument_indent*
erlang_erlang_mode_argument_indent
g:ale_erlang_erlang_mode_argument_indent
Type: `'nil'` or |Number| Type: `'nil'` or |Number|
Default: `2` Default: `2`
Indentation of the first argument in a function call. When `'nil'`, indent Indentation of the first argument in a function call. When `'nil'`, indent
to the column after the `'('` of the function. to the column after the `'('` of the function.
g:ale_erlang_erlang_mode_indent_tabs_mode *ale-options.erlang_erlang_mode_indent_tabs_mode*
*g:ale_erlang_erlang_mode_indent_tabs_mode* *g:ale_erlang_erlang_mode_indent_tabs_mode*
*b:ale_erlang_erlang_mode_indent_tabs_mode* *b:ale_erlang_erlang_mode_indent_tabs_mode*
erlang_erlang_mode_indent_tabs_mode
g:ale_erlang_erlang_mode_indent_tabs_mode
Type: `'nil'` or `'t'` Type: `'nil'` or `'t'`
Default: `'nil'` Default: `'nil'`
Indentation can insert tabs if this is non-`'nil'`. Indentation can insert tabs if this is non-`'nil'`.
------------------------------------------------------------------------------- ===============================================================================
erlang_ls *ale-erlang-erlang_ls* erlang_ls *ale-erlang-erlang_ls*
g:ale_erlang_erlang_ls_executable *g:ale_erlang_erlang_ls_executable* *ale-options.erlang_erlang_ls_executable*
*g:ale_erlang_erlang_ls_executable*
*b:ale_erlang_erlang_ls_executable* *b:ale_erlang_erlang_ls_executable*
erlang_erlang_ls_executable
g:ale_erlang_erlang_ls_executable
Type: |String| Type: |String|
Default: `'erlang_ls'` Default: `'erlang_ls'`
This variable can be changed to specify the erlang_ls executable. This variable can be changed to specify the erlang_ls executable.
g:ale_erlang_erlang_ls_log_dir *g:ale_erlang_erlang_ls_log_dir* *ale-options.erlang_erlang_ls_log_dir*
*g:ale_erlang_erlang_ls_log_dir*
*b:ale_erlang_erlang_ls_log_dir* *b:ale_erlang_erlang_ls_log_dir*
erlang_erlang_ls_log_dir
g:ale_erlang_erlang_ls_log_dir
Type: |String| Type: |String|
Default: `''` Default: `''`
If set this variable overrides default directory where logs will be written. If set this variable overrides default directory where logs will be written.
g:ale_erlang_erlang_ls_log_level *g:ale_erlang_erlang_ls_log_level* *ale-options.erlang_erlang_ls_log_level*
*g:ale_erlang_erlang_ls_log_level*
*b:ale_erlang_erlang_ls_log_level* *b:ale_erlang_erlang_ls_log_level*
erlang_erlang_ls_log_level
g:ale_erlang_erlang_ls_log_level
Type: |String| Type: |String|
Default: `'info'` Default: `'info'`
This variable can be changed to specify log level. This variable can be changed to specify log level.
------------------------------------------------------------------------------- ===============================================================================
erlc *ale-erlang-erlc* erlc *ale-erlang-erlc*
g:ale_erlang_erlc_executable *g:ale_erlang_erlc_executable* *ale-options.erlang_erlc_executable*
*g:ale_erlang_erlc_executable*
*b:ale_erlang_erlc_executable* *b:ale_erlang_erlc_executable*
erlang_erlc_executable
g:ale_erlang_erlc_executable
Type: |String| Type: |String|
Default: `'erlc'` Default: `'erlc'`
This variable can be changed to specify the erlc executable. This variable can be changed to specify the erlc executable.
*ale-options.erlang_erlc_options*
g:ale_erlang_erlc_options *g:ale_erlang_erlc_options* *g:ale_erlang_erlc_options*
*b:ale_erlang_erlc_options* *b:ale_erlang_erlc_options*
erlang_erlc_options
g:ale_erlang_erlc_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -147,19 +189,24 @@ g:ale_erlang_erlc_options *g:ale_erlang_erlc_options*
or `-pa`. or `-pa`.
------------------------------------------------------------------------------- ===============================================================================
erlfmt *ale-erlang-erlfmt* erlfmt *ale-erlang-erlfmt*
g:ale_erlang_erlfmt_executable *g:ale_erlang_erlfmt_executable* *ale-options.erlang_erlfmt_executable*
*g:ale_erlang_erlfmt_executable*
*b:ale_erlang_erlfmt_executable* *b:ale_erlang_erlfmt_executable*
erlang_erlfmt_executable
g:ale_erlang_erlfmt_executable
Type: |String| Type: |String|
Default: `'erlfmt'` Default: `'erlfmt'`
This variable can be changed to specify the erlfmt executable. This variable can be changed to specify the erlfmt executable.
*ale-options.erlang_erlfmt_options*
g:ale_erlang_erlfmt_options *g:ale_erlang_erlfmt_options* *g:ale_erlang_erlfmt_options*
*b:ale_erlang_erlfmt_options* *b:ale_erlang_erlfmt_options*
erlang_erlfmt_options
g:ale_erlang_erlfmt_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -167,11 +214,14 @@ g:ale_erlang_erlfmt_options *g:ale_erlang_erlfmt_options*
`--insert-pragma` or `--print-width`. `--insert-pragma` or `--print-width`.
------------------------------------------------------------------------------- ===============================================================================
syntaxerl *ale-erlang-syntaxerl* syntaxerl *ale-erlang-syntaxerl*
g:ale_erlang_syntaxerl_executable *g:ale_erlang_syntaxerl_executable* *ale-options.erlang_syntaxerl_executable*
*g:ale_erlang_syntaxerl_executable*
*b:ale_erlang_syntaxerl_executable* *b:ale_erlang_syntaxerl_executable*
erlang_syntaxerl_executable
g:ale_erlang_syntaxerl_executable
Type: |String| Type: |String|
Default: `'syntaxerl'` Default: `'syntaxerl'`
+24 -8
View File
@@ -19,8 +19,11 @@ the result. To selectively enable a subset, see |g:ale_linters|.
=============================================================================== ===============================================================================
erb-formatter *ale-eruby-erbformatter* erb-formatter *ale-eruby-erbformatter*
g:ale_eruby_erbformatter_executable *g:ale_eruby_erbformatter_executable* *ale-options.eruby_erbformatter_executable*
*g:ale_eruby_erbformatter_executable*
*b:ale_eruby_erbformatter_executable* *b:ale_eruby_erbformatter_executable*
eruby_erbformatter_executable
g:ale_eruby_erbformatter_executable
Type: |String| Type: |String|
Default: `'erb-formatter'` Default: `'erb-formatter'`
@@ -31,17 +34,22 @@ g:ale_eruby_erbformatter_executable *g:ale_eruby_erbformatter_executable*
=============================================================================== ===============================================================================
erblint *ale-eruby-erblint* erblint *ale-eruby-erblint*
g:ale_eruby_erblint_executable *g:ale_eruby_erblint_executable* *ale-options.eruby_erblint_executable*
*g:ale_eruby_erblint_executable*
*b:ale_eruby_erblint_executable* *b:ale_eruby_erblint_executable*
eruby_erblint_executable
g:ale_eruby_erblint_executable
Type: |String| Type: |String|
Default: `'erblint'` Default: `'erblint'`
Override the invoked erblint binary. This is useful for running erblint Override the invoked erblint binary. This is useful for running erblint
from binstubs or a bundle. from binstubs or a bundle.
*ale-options.eruby_erblint_options*
g:ale_eruby_erblint_options *g:ale_ruby_erblint_options* *g:ale_eruby_erblint_options*
*b:ale_ruby_erblint_options* *b:ale_ruby_erblint_options*
eruby_erblint_options
g:ale_eruby_erblint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -51,8 +59,11 @@ g:ale_eruby_erblint_options *g:ale_ruby_erblint_options*
=============================================================================== ===============================================================================
htmlbeautifier *ale-eruby-htmlbeautifier* htmlbeautifier *ale-eruby-htmlbeautifier*
g:ale_eruby_htmlbeautifier_executable *g:ale_eruby_htmlbeautifier_executable* *ale-options.eruby_htmlbeautifier_executable*
*g:ale_eruby_htmlbeautifier_executable*
*b:ale_eruby_htmlbeautifier_executable* *b:ale_eruby_htmlbeautifier_executable*
eruby_htmlbeautifier_executable
g:ale_eruby_htmlbeautifier_executable
Type: |String| Type: |String|
Default: `'htmlbeautifier'` Default: `'htmlbeautifier'`
@@ -63,17 +74,22 @@ g:ale_eruby_htmlbeautifier_executable *g:ale_eruby_htmlbeautifier_executable*
=============================================================================== ===============================================================================
ruumba *ale-eruby-ruumba* ruumba *ale-eruby-ruumba*
g:ale_eruby_ruumba_executable *g:ale_eruby_ruumba_executable* *ale-options.eruby_ruumba_executable*
*g:ale_eruby_ruumba_executable*
*b:ale_eruby_ruumba_executable* *b:ale_eruby_ruumba_executable*
eruby_ruumba_executable
g:ale_eruby_ruumba_executable
Type: |String| Type: |String|
Default: `'ruumba'` Default: `'ruumba'`
Override the invoked ruumba binary. This is useful for running ruumba Override the invoked ruumba binary. This is useful for running ruumba
from binstubs or a bundle. from binstubs or a bundle.
*ale-options.eruby_ruumba_options*
g:ale_eruby_ruumba_options *g:ale_ruby_ruumba_options* *g:ale_eruby_ruumba_options*
*b:ale_ruby_ruumba_options* *b:ale_ruby_ruumba_options*
eruby_ruumba_options
g:ale_eruby_ruumba_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+14 -6
View File
@@ -10,22 +10,30 @@ displaying errors if an error message is not found.
If ALE is not showing any errors but your file does not run as expected, run If ALE is not showing any errors but your file does not run as expected, run
`fish -n <file.fish>` from the command line. `fish -n <file.fish>` from the command line.
===============================================================================
fish_indent *ale-fish-fish_indent*
g:ale_fish_fish_indent_executable *g:ale_fish_fish_indent_executable* ===============================================================================
*b:ale_fish_fish_indent_executable* fish_indent *ale-fish-fish_indent*
*ale-options.fish_fish_indent_executable*
*g:ale_fish_fish_indent_executable*
*b:ale_fish_fish_indent_executable*
fish_fish_indent_executable
g:ale_fish_fish_indent_executable
Type: |String| Type: |String|
Default: `'fish_indent'` Default: `'fish_indent'`
This variable can be changed to use a different executable for fish_indent. This variable can be changed to use a different executable for fish_indent.
g:ale_fish_fish_indent_options *g:ale_fish_fish_indent_options* *ale-options.fish_fish_indent_options*
*b:ale_fish_fish_indent_options* *g:ale_fish_fish_indent_options*
*b:ale_fish_fish_indent_options*
fish_fish_indent_options
g:ale_fish_fish_indent_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to fish_indent. This variable can be set to pass additional options to fish_indent.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+23 -10
View File
@@ -5,25 +5,32 @@ ALE Fortran Integration *ale-fortran-options*
=============================================================================== ===============================================================================
gcc *ale-fortran-gcc* gcc *ale-fortran-gcc*
g:ale_fortran_gcc_executable *g:ale_fortran_gcc_executable* *ale-options.fortran_gcc_executable*
*g:ale_fortran_gcc_executable*
*b:ale_fortran_gcc_executable* *b:ale_fortran_gcc_executable*
fortran_gcc_executable
g:ale_fortran_gcc_executable
Type: |String| Type: |String|
Default: `'gcc'` Default: `'gcc'`
This variable can be changed to modify the executable used for checking This variable can be changed to modify the executable used for checking
Fortran code with GCC. Fortran code with GCC.
*ale-options.fortran_gcc_options*
g:ale_fortran_gcc_options *g:ale_fortran_gcc_options* *g:ale_fortran_gcc_options*
*b:ale_fortran_gcc_options* *b:ale_fortran_gcc_options*
fortran_gcc_options
g:ale_fortran_gcc_options
Type: |String| Type: |String|
Default: `'-Wall'` Default: `'-Wall'`
This variable can be changed to modify flags given to gcc. This variable can be changed to modify flags given to gcc.
*ale-options.fortran_gcc_use_free_form*
g:ale_fortran_gcc_use_free_form *g:ale_fortran_gcc_use_free_form* *g:ale_fortran_gcc_use_free_form*
*b:ale_fortran_gcc_use_free_form* *b:ale_fortran_gcc_use_free_form*
fortran_gcc_use_free_form
g:ale_fortran_gcc_use_free_form
Type: |Number| Type: |Number|
Default: `1` Default: `1`
@@ -33,18 +40,24 @@ g:ale_fortran_gcc_use_free_form *g:ale_fortran_gcc_use_free_form*
=============================================================================== ===============================================================================
language_server *ale-fortran-language-server* language_server *ale-fortran-language-server*
g:ale_fortran_language_server_executable *g:ale_fortran_language_server_executable* *ale-options.fortran_language_server_executable*
*b:ale_fortran_language_server_executable* *g:ale_fortran_language_server_executable*
*b:ale_fortran_language_server_executable*
fortran_language_server_executable
g:ale_fortran_language_server_executable
Type: |String| Type: |String|
Default: `'fortls'` Default: `'fortls'`
This variable can be changed to modify the executable used for the Fortran This variable can be changed to modify the executable used for the Fortran
Language Server. Language Server.
g:ale_fortran_language_server_use_global *g:ale_fortran_language_server_use_global* *ale-options.fortran_language_server_use_global*
*b:ale_fortran_language_server_use_global* *g:ale_fortran_language_server_use_global*
*b:ale_fortran_language_server_use_global*
fortran_language_server_use_global
g:ale_fortran_language_server_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
+8 -3
View File
@@ -5,16 +5,21 @@ ALE FusionScript Integration *ale-fuse-options*
=============================================================================== ===============================================================================
fusion-lint *ale-fuse-fusionlint* fusion-lint *ale-fuse-fusionlint*
g:ale_fusion_fusionlint_executable *g:ale_fuse_fusionlint_executable* *ale-options.fusion_fusionlint_executable*
*g:ale_fusion_fusionlint_executable*
*b:ale_fuse_fusionlint_executable* *b:ale_fuse_fusionlint_executable*
fusion_fusionlint_executable
g:ale_fusion_fusionlint_executable
Type: |String| Type: |String|
Default: `'fusion-lint'` Default: `'fusion-lint'`
This variable can be changed to change the path to fusion-lint. This variable can be changed to change the path to fusion-lint.
*ale-options.fuse_fusionlint_options*
g:ale_fuse_fusionlint_options *g:ale_fuse_fusionlint_options* *g:ale_fuse_fusionlint_options*
*b:ale_fuse_fusionlint_options* *b:ale_fuse_fusionlint_options*
fuse_fusionlint_options
g:ale_fuse_fusionlint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+15 -7
View File
@@ -5,32 +5,39 @@ ALE Git Commit Integration *ale-gitcommit-options*
=============================================================================== ===============================================================================
gitlint *ale-gitcommit-gitlint* gitlint *ale-gitcommit-gitlint*
g:ale_gitcommit_gitlint_executable *g:ale_gitcommit_gitlint_executable* *ale-options.gitcommit_gitlint_executable*
*g:ale_gitcommit_gitlint_executable*
*b:ale_gitcommit_gitlint_executable* *b:ale_gitcommit_gitlint_executable*
gitcommit_gitlint_executable
g:ale_gitcommit_gitlint_executable
Type: |String| Type: |String|
Default: `'gitlint'` Default: `'gitlint'`
This variable can be changed to modify the executable used for gitlint. This variable can be changed to modify the executable used for gitlint.
*ale-options.gitcommit_gitlint_options*
g:ale_gitcommit_gitlint_options *g:ale_gitcommit_gitlint_options* *g:ale_gitcommit_gitlint_options*
*b:ale_gitcommit_gitlint_options* *b:ale_gitcommit_gitlint_options*
gitcommit_gitlint_options
g:ale_gitcommit_gitlint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to add command-line arguments to the gitlint This variable can be changed to add command-line arguments to the gitlint
invocation. For example, you can specify the path to a configuration file. > invocation. For example, you can specify the path to a configuration file. >
let g:ale_gitcommit_gitlint_options = '-C /home/user/.config/gitlint.ini' let g:ale_gitcommit_gitlint_options = '-C /home/user/.config/gitlint.ini'
< <
You can also disable particular error codes using this option. For example, You can also disable particular error codes using this option. For example,
you can ignore errors for git commits with a missing body. > you can ignore errors for git commits with a missing body. >
let g:ale_gitcommit_gitlint_options = '--ignore B6' let g:ale_gitcommit_gitlint_options = '--ignore B6'
< <
*ale-options.gitcommit_gitlint_use_global*
g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global* *g:ale_gitcommit_gitlint_use_global*
*b:ale_gitcommit_gitlint_use_global* *b:ale_gitcommit_gitlint_use_global*
gitcommit_gitlint_use_global
g:ale_gitcommit_gitlint_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -40,5 +47,6 @@ g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global*
Both variables can be set with `b:` buffer variables instead. Both variables can be set with `b:` buffer variables instead.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+8 -2
View File
@@ -6,8 +6,11 @@ ALE Gleam Integration *ale-gleam-options*
=============================================================================== ===============================================================================
gleam_format *ale-gleam-gleam_format* gleam_format *ale-gleam-gleam_format*
g:ale_gleam_gleam_format_executable *g:ale_gleam_gleam_format_executable* *ale-options.gleam_gleam_format_executable*
*g:ale_gleam_gleam_format_executable*
*b:ale_gleam_gleam_format_executable* *b:ale_gleam_gleam_format_executable*
gleam_gleam_format_executable
g:ale_gleam_gleam_format_executable
Type: |String| Type: |String|
Default: `'gleam'` Default: `'gleam'`
@@ -18,8 +21,11 @@ g:ale_gleam_gleam_format_executable *g:ale_gleam_gleam_format_executable*
=============================================================================== ===============================================================================
gleamlsp *ale-gleam-gleamlsp* gleamlsp *ale-gleam-gleamlsp*
g:ale_gleam_gleamlsp_executable *g:ale_gleam_gleamlsp_executable* *ale-options.gleam_gleamlsp_executable*
*g:ale_gleam_gleamlsp_executable*
*b:ale_gleam_gleamlsp_executable* *b:ale_gleam_gleamlsp_executable*
gleam_gleamlsp_executable
g:ale_gleam_gleamlsp_executable
Type: |String| Type: |String|
Default: `'gleam'` Default: `'gleam'`
+16 -5
View File
@@ -16,16 +16,21 @@ Integration Information
=============================================================================== ===============================================================================
glslang *ale-glsl-glslang* glslang *ale-glsl-glslang*
g:ale_glsl_glslang_executable *g:ale_glsl_glslang_executable* *ale-options.glsl_glslang_executable*
*g:ale_glsl_glslang_executable*
*b:ale_glsl_glslang_executable* *b:ale_glsl_glslang_executable*
glsl_glslang_executable
g:ale_glsl_glslang_executable
Type: |String| Type: |String|
Default: `'glslangValidator'` Default: `'glslangValidator'`
This variable can be changed to change the path to glslangValidator. This variable can be changed to change the path to glslangValidator.
*ale-options.glsl_glslang_options*
g:ale_glsl_glslang_options *g:ale_glsl_glslang_options* *g:ale_glsl_glslang_options*
*b:ale_glsl_glslang_options* *b:ale_glsl_glslang_options*
glsl_glslang_options
g:ale_glsl_glslang_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -35,16 +40,22 @@ g:ale_glsl_glslang_options *g:ale_glsl_glslang_options*
=============================================================================== ===============================================================================
glslls *ale-glsl-glslls* glslls *ale-glsl-glslls*
g:ale_glsl_glslls_executable *g:ale_glsl_glslls_executable* *ale-options.glsl_glslls_executable*
*g:ale_glsl_glslls_executable*
*b:ale_glsl_glslls_executable* *b:ale_glsl_glslls_executable*
glsl_glslls_executable
g:ale_glsl_glslls_executable
Type: |String| Type: |String|
Default: `'glslls'` Default: `'glslls'`
This variable can be changed to change the path to glslls. This variable can be changed to change the path to glslls.
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
g:ale_glsl_glslls_logfile *g:ale_glsl_glslls_logfile* *ale-options.glsl_glslls_logfile*
*g:ale_glsl_glslls_logfile*
*b:ale_glsl_glslls_logfile* *b:ale_glsl_glslls_logfile*
glsl_glslls_logfile
g:ale_glsl_glslls_logfile
Type: |String| Type: |String|
Default: `''` Default: `''`
+123 -50
View File
@@ -14,19 +14,22 @@ A possible configuration is to enable golangci-lint and `gofmt:
" Enable all of the linters you want for Go. " Enable all of the linters you want for Go.
let g:ale_linters = {'go': ['golangci-lint', 'gofmt']} let g:ale_linters = {'go': ['golangci-lint', 'gofmt']}
< <
*ale-options.go_go_executable*
g:ale_go_go_executable *g:ale_go_go_executable* *g:ale_go_go_executable*
*b:ale_go_go_executable* *b:ale_go_go_executable*
go_go_executable
g:ale_go_go_executable
Type: |String| Type: |String|
Default: `'go'` Default: `'go'`
The executable that will be run for the `gobuild` and `govet` linters, and The executable that will be run for the `gobuild` and `govet` linters, and
the `gomod` fixer. the `gomod` fixer.
*ale-options.go_go111module*
g:ale_go_go111module *g:ale_go_go111module* *g:ale_go_go111module*
*b:ale_go_go111module* *b:ale_go_go111module*
go_go111module
g:ale_go_go111module
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -37,16 +40,21 @@ g:ale_go_go111module *g:ale_go_go111module*
=============================================================================== ===============================================================================
bingo *ale-go-bingo* bingo *ale-go-bingo*
g:ale_go_bingo_executable *g:ale_go_bingo_executable* *ale-options.go_bingo_executable*
*g:ale_go_bingo_executable*
*b:ale_go_bingo_executable* *b:ale_go_bingo_executable*
go_bingo_executable
g:ale_go_bingo_executable
Type: |String| Type: |String|
Default: `'bingo'` Default: `'bingo'`
Location of the bingo binary file. Location of the bingo binary file.
*ale-options.go_bingo_options*
g:ale_go_bingo_options *g:ale_go_bingo_options* *g:ale_go_bingo_options*
*b:ale_go_bingo_options* *b:ale_go_bingo_options*
go_bingo_options
g:ale_go_bingo_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -56,11 +64,15 @@ cspell *ale-go-cspell*
See |ale-cspell-options| See |ale-cspell-options|
=============================================================================== ===============================================================================
gobuild *ale-go-gobuild* gobuild *ale-go-gobuild*
g:ale_go_gobuild_options *g:ale_go_gobuild_options* *ale-options.go_gobuild_options*
*g:ale_go_gobuild_options*
*b:ale_go_gobuild_options* *b:ale_go_gobuild_options*
go_gobuild_options
g:ale_go_gobuild_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -71,8 +83,11 @@ g:ale_go_gobuild_options *g:ale_go_gobuild_options*
=============================================================================== ===============================================================================
gofmt *ale-go-gofmt* gofmt *ale-go-gofmt*
g:ale_go_gofmt_options *g:ale_go_gofmt_options* *ale-options.go_gofmt_options*
*g:ale_go_gofmt_options*
*b:ale_go_gofmt_options* *b:ale_go_gofmt_options*
go_gofmt_options
g:ale_go_gofmt_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -82,15 +97,21 @@ g:ale_go_gofmt_options *g:ale_go_gofmt_options*
=============================================================================== ===============================================================================
gofumpt *ale-go-gofumpt* gofumpt *ale-go-gofumpt*
g:ale_go_gofumpt_executable *g:ale_go_gofumpt_executable* *ale-options.go_gofumpt_executable*
*g:ale_go_gofumpt_executable*
*b:ale_go_gofumpt_executable* *b:ale_go_gofumpt_executable*
go_gofumpt_executable
g:ale_go_gofumpt_executable
Type: |String| Type: |String|
Default: `'gofumpt'` Default: `'gofumpt'`
Executable to run to use as the gofumpt fixer. Executable to run to use as the gofumpt fixer.
g:ale_go_gofumpt_options *g:ale_go_gofumpt_options* *ale-options.go_gofumpt_options*
*g:ale_go_gofumpt_options*
*b:ale_go_gofumpt_options* *b:ale_go_gofumpt_options*
go_gofumpt_options
g:ale_go_gofumpt_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -104,25 +125,32 @@ golangci-lint *ale-go-golangci-lint*
written to disk. This differs from the default behavior of linting the buffer. written to disk. This differs from the default behavior of linting the buffer.
See: |ale-lint-file| See: |ale-lint-file|
g:ale_go_golangci_lint_executable *g:ale_go_golangci_lint_executable* *ale-options.go_golangci_lint_executable*
*g:ale_go_golangci_lint_executable*
*b:ale_go_golangci_lint_executable* *b:ale_go_golangci_lint_executable*
go_golangci_lint_executable
g:ale_go_golangci_lint_executable
Type: |String| Type: |String|
Default: `'golangci-lint'` Default: `'golangci-lint'`
The executable that will be run for golangci-lint. The executable that will be run for golangci-lint.
*ale-options.go_golangci_lint_options*
g:ale_go_golangci_lint_options *g:ale_go_golangci_lint_options* *g:ale_go_golangci_lint_options*
*b:ale_go_golangci_lint_options* *b:ale_go_golangci_lint_options*
go_golangci_lint_options
g:ale_go_golangci_lint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to alter the command-line arguments to the This variable can be changed to alter the command-line arguments to the
golangci-lint invocation. golangci-lint invocation.
*ale-options.go_golangci_lint_package*
g:ale_go_golangci_lint_package *g:ale_go_golangci_lint_package* *g:ale_go_golangci_lint_package*
*b:ale_go_golangci_lint_package* *b:ale_go_golangci_lint_package*
go_golangci_lint_package
g:ale_go_golangci_lint_package
Type: |Number| Type: |Number|
Default: `0` Default: `0`
@@ -133,16 +161,21 @@ g:ale_go_golangci_lint_package *g:ale_go_golangci_lint_package*
=============================================================================== ===============================================================================
golangserver *ale-go-golangserver* golangserver *ale-go-golangserver*
g:ale_go_langserver_executable *g:ale_go_langserver_executable* *ale-options.go_langserver_executable*
*g:ale_go_langserver_executable*
*b:ale_go_langserver_executable* *b:ale_go_langserver_executable*
go_langserver_executable
g:ale_go_langserver_executable
Type: |String| Type: |String|
Default: `'go-langserver'` Default: `'go-langserver'`
Location of the go-langserver binary file. Location of the go-langserver binary file.
*ale-options.go_langserver_options*
g:ale_go_langserver_options *g:ale_go_langserver_options* *g:ale_go_langserver_options*
*b:ale_go_langserver_options* *b:ale_go_langserver_options*
go_langserver_options
g:ale_go_langserver_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -154,15 +187,21 @@ g:ale_go_langserver_options *g:ale_go_langserver_options*
=============================================================================== ===============================================================================
golines *ale-go-golines* golines *ale-go-golines*
g:ale_go_golines_executable *g:ale_go_lines_executable* *ale-options.go_golines_executable*
*g:ale_go_golines_executable*
*b:ale_go_lines_executable* *b:ale_go_lines_executable*
go_golines_executable
g:ale_go_golines_executable
Type: |String| Type: |String|
Default: `'golines'` Default: `'golines'`
Location of the golines binary file Location of the golines binary file
g:ale_go_golines_options *g:ale_go_golines_options* *ale-options.go_golines_options*
*g:ale_go_golines_options*
*b:ale_go_golines_options* *b:ale_go_golines_options*
go_golines_options
g:ale_go_golines_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -187,8 +226,13 @@ do anything else. See the `gopls` README file for more information:
https://github.com/golang/tools/blob/master/gopls/README.md https://github.com/golang/tools/blob/master/gopls/README.md
g:ale_go_gopls_executable *g:ale_go_gopls_executable* -------------------------------------------------------------------------------
Options
*ale-options.go_gopls_executable*
*g:ale_go_gopls_executable*
*b:ale_go_gopls_executable* *b:ale_go_gopls_executable*
go_gopls_executable
g:ale_go_gopls_executable
Type: |String| Type: |String|
Default: `'gopls'` Default: `'gopls'`
@@ -198,52 +242,64 @@ g:ale_go_gopls_executable *g:ale_go_gopls_executable*
default, and fall back on a globally installed `gopls` if it can't be found default, and fall back on a globally installed `gopls` if it can't be found
otherwise. otherwise.
*ale-options.go_gopls_options*
g:ale_go_gopls_options *g:ale_go_gopls_options* *g:ale_go_gopls_options*
*b:ale_go_gopls_options* *b:ale_go_gopls_options*
go_gopls_options
g:ale_go_gopls_options
Type: |String| Type: |String|
Default: `''` Default: `''`
Command-line options passed to the gopls executable. See `gopls -h`. Command-line options passed to the gopls executable. See `gopls -h`.
*ale-options.go_gopls_fix_executable*
g:ale_go_gopls_fix_executable *g:ale_go_gopls_fix_executable* *g:ale_go_gopls_fix_executable*
*b:ale_go_gopls_fix_executable* *b:ale_go_gopls_fix_executable*
go_gopls_fix_executable
g:ale_go_gopls_fix_executable
Type: |String| Type: |String|
Default: `'gopls'` Default: `'gopls'`
Executable to run to use as the gopls fixer. Executable to run to use as the gopls fixer.
g:ale_go_gopls_fix_options *g:ale_go_gopls_fix_options* *ale-options.go_gopls_fix_options*
*g:ale_go_gopls_fix_options*
*b:ale_go_gopls_fix_options* *b:ale_go_gopls_fix_options*
go_gopls_fix_options
g:ale_go_gopls_fix_options
Type: |String| Type: |String|
Default: `''` Default: `''`
Options to pass to the gopls fixer. Options to pass to the gopls fixer.
*ale-options.go_gopls_init_options*
g:ale_go_gopls_init_options *g:ale_go_gopls_init_options* *g:ale_go_gopls_init_options*
*b:ale_go_gopls_init_options* *b:ale_go_gopls_init_options*
go_gopls_init_options
g:ale_go_gopls_init_options
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
LSP initialization options passed to gopls. This can be used to configure LSP initialization options passed to gopls. This can be used to configure
the behaviour of gopls. the behaviour of gopls.
Example: > For example: >
let g:ale_go_gopls_init_options = {'ui.diagnostic.analyses': { let g:ale_go_gopls_init_options = {
\ 'composites': v:false, \ 'ui.diagnostic.analyses': {
\ 'unusedparams': v:true, \ 'composites': v:false,
\ 'unusedresult': v:true, \ 'unusedparams': v:true,
\ }} \ 'unusedresult': v:true,
\ },
\}
< <
For a full list of supported analyzers, see: For a full list of supported analyzers, see:
https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md
*ale-options.go_gopls_use_global*
g:ale_go_gopls_use_global *g:ale_go_gopls_use_global* *g:ale_go_gopls_use_global*
*b:ale_go_gopls_use_global* *b:ale_go_gopls_use_global*
go_gopls_use_global
g:ale_go_gopls_use_global
Type: |String| Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -253,8 +309,11 @@ g:ale_go_gopls_use_global *g:ale_go_gopls_use_global*
=============================================================================== ===============================================================================
govet *ale-go-govet* govet *ale-go-govet*
g:ale_go_govet_options *g:ale_go_govet_options* *ale-options.go_govet_options*
*g:ale_go_govet_options*
*b:ale_go_govet_options* *b:ale_go_govet_options*
go_govet_options
g:ale_go_govet_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -264,16 +323,21 @@ g:ale_go_govet_options *g:ale_go_govet_options*
=============================================================================== ===============================================================================
revive *ale-go-revive* revive *ale-go-revive*
g:ale_go_revive_executable *g:ale_go_revive_executable* *ale-options.go_revive_executable*
*g:ale_go_revive_executable*
*b:ale_go_revive_executable* *b:ale_go_revive_executable*
go_revive_executable
g:ale_go_revive_executable
Type: |String| Type: |String|
Default: `'revive'` Default: `'revive'`
This variable can be set to change the revive executable path. This variable can be set to change the revive executable path.
*ale-options.go_revive_options*
g:ale_go_revive_options *g:ale_go_revive_options* *g:ale_go_revive_options*
*b:ale_go_revive_options* *b:ale_go_revive_options*
go_revive_options
g:ale_go_revive_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -283,8 +347,11 @@ g:ale_go_revive_options *g:ale_go_revive_options*
=============================================================================== ===============================================================================
staticcheck *ale-go-staticcheck* staticcheck *ale-go-staticcheck*
g:ale_go_staticcheck_executable *g:ale_go_staticcheck_executable* *ale-options.go_staticcheck_executable*
*g:ale_go_staticcheck_executable*
*b:ale_go_staticcheck_executable* *b:ale_go_staticcheck_executable*
go_staticcheck_executable
g:ale_go_staticcheck_executable
Type: |String| Type: |String|
Default: `'staticcheck'` Default: `'staticcheck'`
@@ -294,27 +361,33 @@ g:ale_go_staticcheck_executable *g:ale_go_staticcheck_executable*
default, and fall back on a globally installed `staticcheck` if it can't be default, and fall back on a globally installed `staticcheck` if it can't be
found otherwise. found otherwise.
*ale-options.go_staticcheck_options*
g:ale_go_staticcheck_options *g:ale_go_staticcheck_options* *g:ale_go_staticcheck_options*
*b:ale_go_staticcheck_options* *b:ale_go_staticcheck_options*
go_staticcheck_options
g:ale_go_staticcheck_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to the staticcheck This variable can be set to pass additional options to the staticcheck
linter. linter.
*ale-options.go_staticcheck_lint_package*
g:ale_go_staticcheck_lint_package *g:ale_go_staticcheck_lint_package* *g:ale_go_staticcheck_lint_package*
*b:ale_go_staticcheck_lint_package* *b:ale_go_staticcheck_lint_package*
go_staticcheck_lint_package
g:ale_go_staticcheck_lint_package
Type: |Number| Type: |Number|
Default: `1` Default: `1`
When set to `1`, the whole Go package will be checked instead of only the When set to `1`, the whole Go package will be checked instead of only the
current file. current file.
*ale-options.go_staticcheck_use_global*
g:ale_go_staticcheck_use_global *g:ale_go_staticcheck_use_global* *g:ale_go_staticcheck_use_global*
*b:ale_go_staticcheck_use_global* *b:ale_go_staticcheck_use_global*
go_staticcheck_use_global
g:ale_go_staticcheck_use_global
Type: |String| Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
+12 -5
View File
@@ -12,24 +12,31 @@ Linting and fixing of Groovy files is enabled with the integration of
=============================================================================== ===============================================================================
npm-groovy-lint *ale-groovy-npm-groovy-lint* npm-groovy-lint *ale-groovy-npm-groovy-lint*
g:ale_groovy_npmgroovylint_executable *g:ale_groovy_npmgroovylint_executable* *ale-options.groovy_npmgroovylint_executable*
*g:ale_groovy_npmgroovylint_executable*
*b:ale_groovy_npmgroovylint_executable* *b:ale_groovy_npmgroovylint_executable*
groovy_npmgroovylint_executable
g:ale_groovy_npmgroovylint_executable
Type: |String| Type: |String|
Default: `'npm-groovy-lint'` Default: `'npm-groovy-lint'`
Location of the npm-groovy-lint binary file. Location of the npm-groovy-lint binary file.
*ale-options.groovy_npmgroovylint_options*
g:ale_groovy_npmgroovylint_options *g:ale_groovy_npmgroovylint_options* *g:ale_groovy_npmgroovylint_options*
*b:ale_groovy_npmgroovylint_options* *b:ale_groovy_npmgroovylint_options*
groovy_npmgroovylint_options
g:ale_groovy_npmgroovylint_options
Type: |String| Type: |String|
Default: `'--loglevel warning'` Default: `'--loglevel warning'`
Additional npm-groovy-lint linter options. Additional npm-groovy-lint linter options.
*ale-options.groovy_npmgroovylint_fix_options*
g:ale_groovy_npmgroovylint_fix_options *g:ale_groovy_npmgroovylint_fix_options* *g:ale_groovy_npmgroovylint_fix_options*
*b:ale_groovy_npmgroovylint_fix_options* *b:ale_groovy_npmgroovylint_fix_options*
groovy_npmgroovylint_fix_options
g:ale_groovy_npmgroovylint_fix_options
Type: |String| Type: |String|
Default: `'--fix'` Default: `'--fix'`
+18 -8
View File
@@ -4,18 +4,23 @@ ALE Hack Integration *ale-hack-options*
HHAST is disabled by default, as it executes code in the project root. HHAST is disabled by default, as it executes code in the project root.
Currently linters must be enabled globally. HHAST can be enabled with: Currently linters must be enabled globally. HHAST can be enabled in ftplugin
files like so: >
> let b:ale_linters = ['hack', 'hhast']
let g:ale_linters = {'hack': ['hack', 'hhast']} <
Or in Lua: >
require("ale").setup.buffer({linters = {"hack", "hhast"}})
< <
=============================================================================== ===============================================================================
hack *ale-hack-hack* hack *ale-hack-hack*
g:ale_hack_hack_executable *g:ale_hack_hack_executable* *ale-options.hack_hack_executable*
*g:ale_hack_hack_executable*
*b:ale_hack_hack_executable* *b:ale_hack_hack_executable*
hack_hack_executable
g:ale_hack_hack_executable
Type: |String| Type: |String|
Default: `'hh_client'` Default: `'hh_client'`
@@ -26,8 +31,11 @@ g:ale_hack_hack_executable *g:ale_hack_hack_executable*
=============================================================================== ===============================================================================
hackfmt *ale-hack-hackfmt* hackfmt *ale-hack-hackfmt*
g:ale_hack_hackfmt_options *g:ale_hack_hackfmt_options* *ale-options.hack_hackfmt_options*
*g:ale_hack_hackfmt_options*
*b:ale_hack_hackfmt_options* *b:ale_hack_hackfmt_options*
hack_hackfmt_options
g:ale_hack_hackfmt_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -37,9 +45,11 @@ g:ale_hack_hackfmt_options *g:ale_hack_hackfmt_options*
=============================================================================== ===============================================================================
hhast *ale-hack-hhast* hhast *ale-hack-hhast*
g:ale_hack_hhast_executable *g:ale_hack_hhast_executable* *ale-options.hack_hhast_executable*
*g:ale_hack_hhast_executable*
*b:ale_hack_hhast_executable* *b:ale_hack_hhast_executable*
hack_hhast_executable
g:ale_hack_hhast_executable
Type: |String| Type: |String|
Default: `'vendor/bin/hhast-lint'` Default: `'vendor/bin/hhast-lint'`
+6 -4
View File
@@ -7,7 +7,6 @@ djlint *ale-handlebars-djlint*
See |ale-html-djlint| See |ale-html-djlint|
===============================================================================
=============================================================================== ===============================================================================
prettier *ale-handlebars-prettier* prettier *ale-handlebars-prettier*
@@ -19,18 +18,21 @@ Uses glimmer parser by default.
=============================================================================== ===============================================================================
ember-template-lint *ale-handlebars-embertemplatelint* ember-template-lint *ale-handlebars-embertemplatelint*
g:ale_handlebars_embertemplatelint_executable *ale-options.handlebars_embertemplatelint_executable*
*g:ale_handlebars_embertemplatelint_executable* *g:ale_handlebars_embertemplatelint_executable*
*b:ale_handlebars_embertemplatelint_executable* *b:ale_handlebars_embertemplatelint_executable*
handlebars_embertemplatelint_executable
g:ale_handlebars_embertemplatelint_executable
Type: |String| Type: |String|
Default: `'ember-template-lint'` Default: `'ember-template-lint'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.handlebars_embertemplatelint_use_global*
g:ale_handlebars_embertemplatelint_use_global
*g:ale_handlebars_embertemplatelint_use_global* *g:ale_handlebars_embertemplatelint_use_global*
*b:ale_handlebars_embertemplatelint_use_global* *b:ale_handlebars_embertemplatelint_use_global*
handlebars_embertemplatelint_use_global
g:ale_handlebars_embertemplatelint_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
+84 -27
View File
@@ -5,8 +5,11 @@ ALE Haskell Integration *ale-haskell-options*
=============================================================================== ===============================================================================
brittany *ale-haskell-brittany* brittany *ale-haskell-brittany*
g:ale_haskell_brittany_executable *g:ale_haskell_brittany_executable* *ale-options.haskell_brittany_executable*
*g:ale_haskell_brittany_executable*
*b:ale_haskell_brittany_executable* *b:ale_haskell_brittany_executable*
haskell_brittany_executable
g:ale_haskell_brittany_executable
Type: |String| Type: |String|
Default: `'brittany'` Default: `'brittany'`
@@ -22,8 +25,11 @@ See |ale-cspell-options|
=============================================================================== ===============================================================================
floskell *ale-haskell-floskell* floskell *ale-haskell-floskell*
g:ale_haskell_floskell_executable *g:ale_haskell_floskell_executable* *ale-options.haskell_floskell_executable*
*g:ale_haskell_floskell_executable*
*b:ale_haskell_floskell_executable* *b:ale_haskell_floskell_executable*
haskell_floskell_executable
g:ale_haskell_floskell_executable
Type: |String| Type: |String|
Default: `'floskell'` Default: `'floskell'`
@@ -33,8 +39,11 @@ g:ale_haskell_floskell_executable *g:ale_haskell_floskell_executable*
=============================================================================== ===============================================================================
ghc *ale-haskell-ghc* ghc *ale-haskell-ghc*
g:ale_haskell_ghc_options *g:ale_haskell_ghc_options* *ale-options.haskell_ghc_options*
*g:ale_haskell_ghc_options*
*b:ale_haskell_ghc_options* *b:ale_haskell_ghc_options*
haskell_ghc_options
g:ale_haskell_ghc_options
Type: |String| Type: |String|
Default: `'-fno-code -v0'` Default: `'-fno-code -v0'`
@@ -44,8 +53,11 @@ g:ale_haskell_ghc_options *g:ale_haskell_ghc_options*
=============================================================================== ===============================================================================
ghc-mod *ale-haskell-ghc-mod* ghc-mod *ale-haskell-ghc-mod*
g:ale_haskell_ghc_mod_executable *g:ale_haskell_ghc_mod_executable* *ale-options.haskell_ghc_mod_executable*
*g:ale_haskell_ghc_mod_executable*
*b:ale_haskell_ghc_mod_executable* *b:ale_haskell_ghc_mod_executable*
haskell_ghc_mod_executable
g:ale_haskell_ghc_mod_executable
Type: |String| Type: |String|
Default: `'ghc-mod'` Default: `'ghc-mod'`
@@ -55,8 +67,11 @@ g:ale_haskell_ghc_mod_executable *g:ale_haskell_ghc_mod_executable*
=============================================================================== ===============================================================================
cabal-ghc *ale-haskell-cabal-ghc* cabal-ghc *ale-haskell-cabal-ghc*
g:ale_haskell_cabal_ghc_options *g:ale_haskell_cabal_ghc_options* *ale-options.haskell_cabal_ghc_options*
*g:ale_haskell_cabal_ghc_options*
*b:ale_haskell_cabal_ghc_options* *b:ale_haskell_cabal_ghc_options*
haskell_cabal_ghc_options
g:ale_haskell_cabal_ghc_options
Type: |String| Type: |String|
Default: `'-fno-code -v0'` Default: `'-fno-code -v0'`
@@ -67,16 +82,21 @@ g:ale_haskell_cabal_ghc_options *g:ale_haskell_cabal_ghc_options*
=============================================================================== ===============================================================================
hdevtools *ale-haskell-hdevtools* hdevtools *ale-haskell-hdevtools*
g:ale_haskell_hdevtools_executable *g:ale_haskell_hdevtools_executable* *ale-options.haskell_hdevtools_executable*
*g:ale_haskell_hdevtools_executable*
*b:ale_haskell_hdevtools_executable* *b:ale_haskell_hdevtools_executable*
haskell_hdevtools_executable
g:ale_haskell_hdevtools_executable
Type: |String| Type: |String|
Default: `'hdevtools'` Default: `'hdevtools'`
This variable can be changed to use a different executable for hdevtools. This variable can be changed to use a different executable for hdevtools.
*ale-options.haskell_hdevtools_options*
g:ale_haskell_hdevtools_options *g:ale_haskell_hdevtools_options* *g:ale_haskell_hdevtools_options*
*b:ale_haskell_hdevtools_options* *b:ale_haskell_hdevtools_options*
haskell_hdevtools_options
g:ale_haskell_hdevtools_options
Type: |String| Type: |String|
Default: `get(g:, 'hdevtools_options', '-g -Wall')` Default: `get(g:, 'hdevtools_options', '-g -Wall')`
@@ -91,8 +111,11 @@ g:ale_haskell_hdevtools_options *g:ale_haskell_hdevtools_options*
=============================================================================== ===============================================================================
hfmt *ale-haskell-hfmt* hfmt *ale-haskell-hfmt*
g:ale_haskell_hfmt_executable *g:ale_haskell_hfmt_executable* *ale-options.haskell_hfmt_executable*
*g:ale_haskell_hfmt_executable*
*b:ale_haskell_hfmt_executable* *b:ale_haskell_hfmt_executable*
haskell_hfmt_executable
g:ale_haskell_hfmt_executable
Type: |String| Type: |String|
Default: `'hfmt'` Default: `'hfmt'`
@@ -102,8 +125,11 @@ g:ale_haskell_hfmt_executable *g:ale_haskell_hfmt_executable*
=============================================================================== ===============================================================================
hindent *ale-haskell-hindent* hindent *ale-haskell-hindent*
g:ale_haskell_hindent_executable *g:ale_haskell_hindent_executable* *ale-options.haskell_hindent_executable*
*g:ale_haskell_hindent_executable*
*b:ale_haskell_hindent_executable* *b:ale_haskell_hindent_executable*
haskell_hindent_executable
g:ale_haskell_hindent_executable
Type: |String| Type: |String|
Default: `'hindent'` Default: `'hindent'`
@@ -113,16 +139,21 @@ g:ale_haskell_hindent_executable *g:ale_haskell_hindent_executable*
=============================================================================== ===============================================================================
hlint *ale-haskell-hlint* hlint *ale-haskell-hlint*
g:ale_haskell_hlint_executable *g:ale_haskell_hlint_executable* *ale-options.haskell_hlint_executable*
*g:ale_haskell_hlint_executable*
*b:ale_haskell_hlint_executable* *b:ale_haskell_hlint_executable*
haskell_hlint_executable
g:ale_haskell_hlint_executable
Type: |String| Type: |String|
Default: `'hlint'` Default: `'hlint'`
This variable can be changed to use a different executable for hlint. This variable can be changed to use a different executable for hlint.
*ale-options.haskell_hlint_options*
g:ale_haskell_hlint_options g:ale_haskell_hlint_options *g:ale_haskell_hlint_options*
b:ale_haskell_hlint_options *b:ale_haskell_hlint_options*
haskell_hlint_options
g:ale_haskell_hlint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -133,17 +164,22 @@ g:ale_haskell_hlint_options g:ale_haskell_hlint_options
=============================================================================== ===============================================================================
hls *ale-haskell-hls* hls *ale-haskell-hls*
g:ale_haskell_hls_executable *g:ale_haskell_hls_executable* *ale-options.haskell_hls_executable*
*g:ale_haskell_hls_executable*
*b:ale_haskell_hls_executable* *b:ale_haskell_hls_executable*
haskell_hls_executable
g:ale_haskell_hls_executable
Type: |String| Type: |String|
Default: `'haskell-language-server-wrapper'` Default: `'haskell-language-server-wrapper'`
This variable can be changed to use a different executable for the haskell This variable can be changed to use a different executable for the haskell
language server. language server.
*ale-options.haskell_hls_config*
g:ale_haskell_hls_config *g:ale_haskell_hls_config* *g:ale_haskell_hls_config*
*b:ale_haskell_hls_config* *b:ale_haskell_hls_config*
haskell_hls_config
g:ale_haskell_hls_config
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
@@ -159,8 +195,11 @@ g:ale_haskell_hls_config *g:ale_haskell_hls_config*
=============================================================================== ===============================================================================
stack-build *ale-haskell-stack-build* stack-build *ale-haskell-stack-build*
g:ale_haskell_stack_build_options *g:ale_haskell_stack_build_options* *ale-options.haskell_stack_build_options*
*g:ale_haskell_stack_build_options*
*b:ale_haskell_stack_build_options* *b:ale_haskell_stack_build_options*
haskell_stack_build_options
g:ale_haskell_stack_build_options
Type: |String| Type: |String|
Default: `'--fast'` Default: `'--fast'`
@@ -171,8 +210,11 @@ g:ale_haskell_stack_build_options *g:ale_haskell_stack_build_options*
=============================================================================== ===============================================================================
stack-ghc *ale-haskell-stack-ghc* stack-ghc *ale-haskell-stack-ghc*
g:ale_haskell_stack_ghc_options *g:ale_haskell_stack_ghc_options* *ale-options.haskell_stack_ghc_options*
*g:ale_haskell_stack_ghc_options*
*b:ale_haskell_stack_ghc_options* *b:ale_haskell_stack_ghc_options*
haskell_stack_ghc_options
g:ale_haskell_stack_ghc_options
Type: |String| Type: |String|
Default: `'-fno-code -v0'` Default: `'-fno-code -v0'`
@@ -183,9 +225,11 @@ g:ale_haskell_stack_ghc_options *g:ale_haskell_stack_ghc_options*
=============================================================================== ===============================================================================
stylish-haskell *ale-haskell-stylish-haskell* stylish-haskell *ale-haskell-stylish-haskell*
g:ale_haskell_stylish_haskell_executable *ale-options.haskell_stylish_haskell_executable*
*g:ale_haskell_stylish_haskell_executable* *g:ale_haskell_stylish_haskell_executable*
*b:ale_haskell_stylish_haskell_executable* *b:ale_haskell_stylish_haskell_executable*
haskell_stylish_haskell_executable
g:ale_haskell_stylish_haskell_executable
Type: |String| Type: |String|
Default: `'stylish-haskell'` Default: `'stylish-haskell'`
@@ -195,8 +239,11 @@ g:ale_haskell_stylish_haskell_executable
=============================================================================== ===============================================================================
hie *ale-haskell-hie* hie *ale-haskell-hie*
g:ale_haskell_hie_executable *g:ale_haskell_hie_executable* *ale-options.haskell_hie_executable*
*g:ale_haskell_hie_executable*
*b:ale_haskell_hie_executable* *b:ale_haskell_hie_executable*
haskell_hie_executable
g:ale_haskell_hie_executable
Type: |String| Type: |String|
Default: `'hie'` Default: `'hie'`
@@ -207,16 +254,21 @@ g:ale_haskell_hie_executable *g:ale_haskell_hie_executable*
=============================================================================== ===============================================================================
ormolu *ale-haskell-ormolu* ormolu *ale-haskell-ormolu*
g:ale_haskell_ormolu_executable *g:ale_haskell_ormolu_executable* *ale-options.haskell_ormolu_executable*
*g:ale_haskell_ormolu_executable*
*b:ale_haskell_ormolu_executable* *b:ale_haskell_ormolu_executable*
haskell_ormolu_executable
g:ale_haskell_ormolu_executable
Type: |String| Type: |String|
Default: `'ormolu'` Default: `'ormolu'`
This variable can be changed to use a different executable for ormolu. This variable can be changed to use a different executable for ormolu.
*ale-options.haskell_ormolu_options*
g:ale_haskell_ormolu_options *g:ale_haskell_ormolu_options* *g:ale_haskell_ormolu_options*
*b:ale_haskell_ormolu_options* *b:ale_haskell_ormolu_options*
haskell_ormolu_options
g:ale_haskell_ormolu_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -227,16 +279,21 @@ g:ale_haskell_ormolu_options *g:ale_haskell_ormolu_options*
=============================================================================== ===============================================================================
fourmolu *ale-haskell-fourmolu* fourmolu *ale-haskell-fourmolu*
g:ale_haskell_fourmolu_executable *g:ale_haskell_fourmolu_executable* *ale-options.haskell_fourmolu_executable*
*g:ale_haskell_fourmolu_executable*
*b:ale_haskell_fourmolu_executable* *b:ale_haskell_fourmolu_executable*
haskell_fourmolu_executable
g:ale_haskell_fourmolu_executable
Type: |String| Type: |String|
Default: `'fourmolu'` Default: `'fourmolu'`
This variable can be changed to use a different executable for fourmolu. This variable can be changed to use a different executable for fourmolu.
*ale-options.haskell_fourmolu_options*
g:ale_haskell_fourmolu_options *g:ale_haskell_fourmolu_options* *g:ale_haskell_fourmolu_options*
*b:ale_haskell_fourmolu_options* *b:ale_haskell_fourmolu_options*
haskell_fourmolu_options
g:ale_haskell_fourmolu_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+79 -33
View File
@@ -11,17 +11,21 @@ ALE supports language server features for Angular. You can install it via `npm`:
< <
Angular 11 and up are supported. Angular 11 and up are supported.
*ale-options.html_angular_executable*
g:ale_html_angular_executable *g:ale_html_angular_executable* *g:ale_html_angular_executable*
*b:ale_html_angular_executable* *b:ale_html_angular_executable*
html_angular_executable
g:ale_html_angular_executable
Type: |String| Type: |String|
Default: `'ngserver'` Default: `'ngserver'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.html_angular_use_global*
g:ale_html_angular_use_global *g:ale_html_angular_use_global* *g:ale_html_angular_use_global*
*b:ale_html_angular_use_global* *b:ale_html_angular_use_global*
html_angular_use_global
g:ale_html_angular_use_global
Type: |String| Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -33,22 +37,28 @@ cspell *ale-html-cspell*
See |ale-cspell-options| See |ale-cspell-options|
=============================================================================== ===============================================================================
djlint *ale-html-djlint* djlint *ale-html-djlint*
`djlint` options for HTML are the same as the options for htmlangular, `djlint` options for HTML are the same as the options for htmlangular,
htmldjango, jinja, handlebars, nunjucks and gotmplhtml. htmldjango, jinja, handlebars, nunjucks and gotmplhtml.
g:ale_html_djlint_executable *g:ale_html_djlint_executable* *ale-options.html_djlint_executable*
*g:ale_html_djlint_executable*
*b:ale_html_djlint_executable* *b:ale_html_djlint_executable*
html_djlint_executable
g:ale_html_djlint_executable
Type: |String| Type: |String|
Default: `'djlint'` Default: `'djlint'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.html_djlint_options*
g:ale_html_djlint_options *g:ale_html_djlint_options* *g:ale_html_djlint_options*
*b:ale_html_djlint_options* *b:ale_html_djlint_options*
html_djlint_options
g:ale_html_djlint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -67,24 +77,31 @@ See: |ale-javascript-fecs|.
=============================================================================== ===============================================================================
html-beautify *ale-html-beautify* html-beautify *ale-html-beautify*
g:ale_html_beautify_executable *g:ale_html_beautify_executable* *ale-options.html_beautify_executable*
*g:ale_html_beautify_executable*
*b:ale_html_beautify_executable* *b:ale_html_beautify_executable*
html_beautify_executable
g:ale_html_beautify_executable
Type: |String| Type: |String|
Default: `'html-beautify'` Default: `'html-beautify'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.html_beautify_options*
g:ale_html_beautify_options *g:ale_html_beautify_options* *g:ale_html_beautify_options*
*b:ale_html_beautify_options* *b:ale_html_beautify_options*
html_beautify_options
g:ale_html_beautify_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to modify flags given to html-beautify. This variable can be changed to modify flags given to html-beautify.
*ale-options.html_beautify_use_global*
g:ale_html_beautify_use_global *g:ale_html_beautify_use_global* *g:ale_html_beautify_use_global*
*b:ale_html_beautify_use_global* *b:ale_html_beautify_use_global*
html_beautify_use_global
g:ale_html_beautify_use_global
Type: |String| Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -94,24 +111,31 @@ g:ale_html_beautify_use_global *g:ale_html_beautify_use_global*
=============================================================================== ===============================================================================
htmlhint *ale-html-htmlhint* htmlhint *ale-html-htmlhint*
g:ale_html_htmlhint_executable *g:ale_html_htmlhint_executable* *ale-options.html_htmlhint_executable*
*g:ale_html_htmlhint_executable*
*b:ale_html_htmlhint_executable* *b:ale_html_htmlhint_executable*
html_htmlhint_executable
g:ale_html_htmlhint_executable
Type: |String| Type: |String|
Default: `'htmlhint'` Default: `'htmlhint'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.html_htmlhint_options*
g:ale_html_htmlhint_options *g:ale_html_htmlhint_options* *g:ale_html_htmlhint_options*
*b:ale_html_htmlhint_options* *b:ale_html_htmlhint_options*
html_htmlhint_options
g:ale_html_htmlhint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to modify flags given to HTMLHint. This variable can be changed to modify flags given to HTMLHint.
*ale-options.html_htmlhint_use_global*
g:ale_html_htmlhint_use_global *g:ale_html_htmlhint_use_global* *g:ale_html_htmlhint_use_global*
*b:ale_html_htmlhint_use_global* *b:ale_html_htmlhint_use_global*
html_htmlhint_use_global
g:ale_html_htmlhint_use_global
Type: |String| Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -127,16 +151,21 @@ See |ale-javascript-prettier| for information about the available options.
=============================================================================== ===============================================================================
rustywind *ale-html-rustywind* rustywind *ale-html-rustywind*
g:ale_html_rustywind_executable *g:ale_html_rustywind_executable* *ale-options.html_rustywind_executable*
*g:ale_html_rustywind_executable*
*b:ale_html_rustywind_executable* *b:ale_html_rustywind_executable*
html_rustywind_executable
g:ale_html_rustywind_executable
Type: |String| Type: |String|
Default: `'rustywind'` Default: `'rustywind'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.html_rustywind_options*
g:ale_html_rustywind_options *g:ale_html_rustywind_options* *g:ale_html_rustywind_options*
*b:ale_html_rustywind_options* *b:ale_html_rustywind_options*
html_rustywind_options
g:ale_html_rustywind_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -146,24 +175,31 @@ g:ale_html_rustywind_options *g:ale_html_rustywind_options*
=============================================================================== ===============================================================================
stylelint *ale-html-stylelint* stylelint *ale-html-stylelint*
g:ale_html_stylelint_executable *g:ale_html_stylelint_executable* *ale-options.html_stylelint_executable*
*g:ale_html_stylelint_executable*
*b:ale_html_stylelint_executable* *b:ale_html_stylelint_executable*
html_stylelint_executable
g:ale_html_stylelint_executable
Type: |String| Type: |String|
Default: `'stylelint'` Default: `'stylelint'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.html_stylelint_options*
g:ale_html_stylelint_options *g:ale_html_stylelint_options* *g:ale_html_stylelint_options*
*b:ale_html_stylelint_options* *b:ale_html_stylelint_options*
html_stylelint_options
g:ale_html_stylelint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to stylelint. This variable can be set to pass additional options to stylelint.
*ale-options.html_stylelint_use_global*
g:ale_html_stylelint_use_global *g:ale_html_stylelint_use_global* *g:ale_html_stylelint_use_global*
*b:ale_html_stylelint_use_global* *b:ale_html_stylelint_use_global*
html_stylelint_use_global
g:ale_html_stylelint_use_global
Type: |String| Type: |String|
Default: `0` Default: `0`
@@ -188,16 +224,24 @@ To use `tidy` on macOS, please install the latest version with Homebrew:
< <
`/usr/local/bin/tidy` is installed. `/usr/local/bin/tidy` is installed.
g:ale_html_tidy_executable *g:ale_html_tidy_executable*
-------------------------------------------------------------------------------
Options
*ale-options.html_tidy_executable*
*g:ale_html_tidy_executable*
*b:ale_html_tidy_executable* *b:ale_html_tidy_executable*
html_tidy_executable
g:ale_html_tidy_executable
Type: |String| Type: |String|
Default: `'tidy'` Default: `'tidy'`
This variable can be changed to change the path to tidy. This variable can be changed to change the path to tidy.
*ale-options.html_tidy_options*
g:ale_html_tidy_options *g:ale_html_tidy_options* *g:ale_html_tidy_options*
*b:ale_html_tidy_options* *b:ale_html_tidy_options*
html_tidy_options
g:ale_html_tidy_options
Type: |String| Type: |String|
Default: `'-q -e -language en'` Default: `'-q -e -language en'`
@@ -211,9 +255,10 @@ g:ale_html_tidy_options *g:ale_html_tidy_options*
cp850 (ibm858), cp932 (shiftjis), iso-2022-jp (iso-2022), latin1, macroman cp850 (ibm858), cp932 (shiftjis), iso-2022-jp (iso-2022), latin1, macroman
(mac), sjis (shiftjis), utf-16le, utf-16, utf-8 (mac), sjis (shiftjis), utf-16le, utf-16, utf-8
*ale-options.html_tidy_use_global*
g:ale_html_tidy_use_global *g:html_tidy_use_global* *g:ale_html_tidy_use_global*
html_tidy_use_global
g:ale_html_tidy_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -225,8 +270,9 @@ vscodehtml *ale-html-vscode*
Website: https://github.com/hrsh7th/vscode-langservers-extracted Website: https://github.com/hrsh7th/vscode-langservers-extracted
Installation
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Installation
Install VSCode html language server either globally or locally: > Install VSCode html language server either globally or locally: >
+4 -1
View File
@@ -5,8 +5,11 @@ ALE HTTP Integration *ale-http-options*
=============================================================================== ===============================================================================
kulala_fmt *ale-http-kulala_fmt* kulala_fmt *ale-http-kulala_fmt*
g:ale_http_kulala_fmt *g:ale_http_kulala_fmt_executable* *ale-options.http_kulala_fmt_executable*
*g:ale_http_kulala_fmt_executable*
*b:ale_http_kulala_fmt_executable* *b:ale_http_kulala_fmt_executable*
http_kulala_fmt
g:ale_http_kulala_fmt
Type: |String| Type: |String|
Default: `'kulala_fmt'` Default: `'kulala_fmt'`
+4 -1
View File
@@ -5,8 +5,11 @@ ALE Hurl Integration *ale-hurl-options*
=============================================================================== ===============================================================================
hurlfmt *ale-hurl-hurlfmt* hurlfmt *ale-hurl-hurlfmt*
g:ale_hurl_hurlfmt_executable *g:ale_hurl_hurlfmt_executable* *ale-options.hurl_hurlfmt_executable*
*g:ale_hurl_hurlfmt_executable*
*b:ale_hurl_hurlfmt_executable* *b:ale_hurl_hurlfmt_executable*
hurl_hurlfmt_executable
g:ale_hurl_hurlfmt_executable
Type: |String| Type: |String|
Default: `'hurlfmt'` Default: `'hurlfmt'`
+10 -3
View File
@@ -1,23 +1,30 @@
=============================================================================== ===============================================================================
ALE Idris Integration *ale-idris-options* ALE Idris Integration *ale-idris-options*
=============================================================================== ===============================================================================
idris *ale-idris-idris* idris *ale-idris-idris*
g:ale_idris_idris_executable *g:ale_idris_idris_executable* *ale-options.idris_idris_executable*
*g:ale_idris_idris_executable*
*b:ale_idris_idris_executable* *b:ale_idris_idris_executable*
idris_idris_executable
g:ale_idris_idris_executable
Type: |String| Type: |String|
Default: `'idris'` Default: `'idris'`
This variable can be changed to change the path to idris. This variable can be changed to change the path to idris.
*ale-options.idris_idris_options*
g:ale_idris_idris_options *g:ale_idris_idris_options* *g:ale_idris_idris_options*
*b:ale_idris_idris_options* *b:ale_idris_idris_options*
idris_idris_options
g:ale_idris_idris_options
Type: |String| Type: |String|
Default: `'--total --warnpartial --warnreach --warnipkg'` Default: `'--total --warnpartial --warnreach --warnipkg'`
This variable can be changed to modify flags given to idris. This variable can be changed to modify flags given to idris.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+20 -14
View File
@@ -5,19 +5,23 @@ ALE Ink Integration *ale-ink-options*
=============================================================================== ===============================================================================
ink-language-server *ale-ink-language-server* ink-language-server *ale-ink-language-server*
Ink Language Server Ink Language Server - https://github.com/ephraim/ink-language-server
(https://github.com/ephraim/ink-language-server)
g:ale_ink_ls_executable g:ale_ink_ls_executable *ale-options.ink_ls_executable*
b:ale_ink_ls_executable *g:ale_ink_ls_executable*
*b:ale_ink_ls_executable*
ink_ls_executable
g:ale_ink_ls_executable
Type: |String| Type: |String|
Default: `'ink-language-server'` Default: `'ink-language-server'`
Ink language server executable. Ink language server executable.
*ale-options.ink_ls_initialization_options*
*g:ale_ink_ls_initialization_options*
*b:ale_ink_ls_initialization_options*
ink_ls_initialization_options
g:ale_ink_ls_initialization_options g:ale_ink_ls_initialization_options
g:ale_ink_ls_initialization_options
b:ale_ink_ls_initialization_options
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
@@ -27,14 +31,16 @@ g:ale_ink_ls_initialization_options
change these settings - see the ink-language-server website for more change these settings - see the ink-language-server website for more
information. information.
An example of setting non-default options: An example of setting non-default options: >
{
\ 'ink': { let g:ale_ink_ls_initialization_options = {
\ 'mainStoryPath': 'init.ink', \ 'ink': {
\ 'inklecateExecutablePath': '/usr/local/bin/inklecate', \ 'mainStoryPath': 'init.ink',
\ 'runThroughMono': v:false \ 'inklecateExecutablePath': '/usr/local/bin/inklecate',
\ } \ 'runThroughMono': v:false,
\} \ },
\}
<
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+4 -5
View File
@@ -2,16 +2,15 @@
ALE Inko Integration *ale-inko-options* ALE Inko Integration *ale-inko-options*
*ale-integration-inko* *ale-integration-inko*
===============================================================================
Integration Information
Currently, the only supported linter for Inko is the Inko compiler itself.
=============================================================================== ===============================================================================
inko *ale-inko-inko* inko *ale-inko-inko*
g:ale_inko_inko_executable *g:ale_inko_inko_executable* *ale-options.inko_inko_executable*
*g:ale_inko_inko_executable*
*b:ale_inko_inko_executable* *b:ale_inko_inko_executable*
inko_inko_executable
g:ale_inko_inko_executable
Type: |String| Type: |String|
Default: `'inko'` Default: `'inko'`
+9 -3
View File
@@ -5,20 +5,26 @@ ALE ISPC Integration *ale-ispc-options*
=============================================================================== ===============================================================================
ispc *ale-ispc-ispc* ispc *ale-ispc-ispc*
g:ale_ispc_ispc_executable *g:ale_ispc_ispc_executable* *ale-options.ispc_ispc_executable*
*g:ale_ispc_ispc_executable*
*b:ale_ispc_ispc_executable* *b:ale_ispc_ispc_executable*
ispc_ispc_executable
g:ale_ispc_ispc_executable
Type: |String| Type: |String|
Default: `'ispc'` Default: `'ispc'`
This variable can be changed to use a different executable for ispc. This variable can be changed to use a different executable for ispc.
*ale-options.ispc_ispc_options*
g:ale_ispc_ispc_options *g:ale_ispc_ispc_options* *g:ale_ispc_ispc_options*
*b:ale_ispc_ispc_options* *b:ale_ispc_ispc_options*
ispc_ispc_options
g:ale_ispc_ispc_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to modify flags given to ispc. This variable can be changed to modify flags given to ispc.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+131 -83
View File
@@ -5,9 +5,11 @@ ALE Java Integration *ale-java-options*
=============================================================================== ===============================================================================
checkstyle *ale-java-checkstyle* checkstyle *ale-java-checkstyle*
g:ale_java_checkstyle_config *g:ale_java_checkstyle_config* *ale-options.java_checkstyle_config*
*g:ale_java_checkstyle_config*
*b:ale_java_checkstyle_config* *b:ale_java_checkstyle_config*
java_checkstyle_config
g:ale_java_checkstyle_config
Type: |String| Type: |String|
Default: `'/google_checks.xml'` Default: `'/google_checks.xml'`
@@ -19,19 +21,21 @@ g:ale_java_checkstyle_config *g:ale_java_checkstyle_config*
The path to the configuration file can be an absolute path or a relative The path to the configuration file can be an absolute path or a relative
path. ALE will search for the relative path in parent directories. path. ALE will search for the relative path in parent directories.
*ale-options.java_checkstyle_executable*
g:ale_java_checkstyle_executable *g:ale_java_checkstyle_executable* *g:ale_java_checkstyle_executable*
*b:ale_java_checkstyle_executable* *b:ale_java_checkstyle_executable*
java_checkstyle_executable
g:ale_java_checkstyle_executable
Type: |String| Type: |String|
Default: `'checkstyle'` Default: `'checkstyle'`
This variable can be changed to modify the executable used for checkstyle. This variable can be changed to modify the executable used for checkstyle.
*ale-options.java_checkstyle_options*
g:ale_java_checkstyle_options *g:ale_java_checkstyle_options* *g:ale_java_checkstyle_options*
*b:ale_java_checkstyle_options* *b:ale_java_checkstyle_options*
java_checkstyle_options
g:ale_java_checkstyle_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -57,68 +61,80 @@ See |ale-cspell-options|
=============================================================================== ===============================================================================
javac *ale-java-javac* javac *ale-java-javac*
g:ale_java_javac_classpath *g:ale_java_javac_classpath* *ale-options.java_javac_classpath*
*g:ale_java_javac_classpath*
*b:ale_java_javac_classpath* *b:ale_java_javac_classpath*
java_javac_classpath
g:ale_java_javac_classpath
Type: |String| or |List| Type: |String| or |List|
Default: `''` Default: `''`
This variable can be set to change the global classpath for Java. This variable can be set to change the global classpath for Java.
*ale-options.java_javac_executable*
g:ale_java_javac_executable *g:ale_java_javac_executable* *g:ale_java_javac_executable*
*b:ale_java_javac_executable* *b:ale_java_javac_executable*
java_javac_executable
g:ale_java_javac_executable
Type: |String| Type: |String|
Default: `'javac'` Default: `'javac'`
This variable can be set to change the executable path used for javac. This variable can be set to change the executable path used for javac.
*ale-options.java_javac_options*
g:ale_java_javac_options *g:ale_java_javac_options* *g:ale_java_javac_options*
*b:ale_java_javac_options* *b:ale_java_javac_options*
java_javac_options
g:ale_java_javac_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to javac. This variable can be set to pass additional options to javac.
g:ale_java_javac_sourcepath *g:ale_java_javac_sourcepath* *ale-options.java_javac_sourcepath*
*g:ale_java_javac_sourcepath*
*b:ale_java_javac_sourcepath* *b:ale_java_javac_sourcepath*
java_javac_sourcepath
g:ale_java_javac_sourcepath
Type: |String| or |List| Type: |String| or |List|
Default: `''` Default: `''`
This variable can set multiple source code paths, the source code path is a This variable can set multiple source code paths, the source code path is a
relative path (relative to the project root directory). relative path (relative to the project root directory).
Example: The source path can be set as a String with a system-dependent path
separator. Note that the Unix path separator is a colon (`:`), and on
Windows the path separator is a semicolon (`;`). >
String type:
Note that the unix system separator is a colon(`:`) window system
is a semicolon(`;`).
>
let g:ale_java_javac_sourcepath = 'build/gen/source/xx/main:build/gen/source' let g:ale_java_javac_sourcepath = 'build/gen/source/xx/main:build/gen/source'
< <
List type: The source path can be set as a List so ALE will add the appropriate path
> separator for the host system automatically. >
let g:ale_java_javac_sourcepath = [ let g:ale_java_javac_sourcepath = [
\ 'build/generated/source/querydsl/main', \ 'build/generated/source/querydsl/main',
\ 'target/generated-sources/source/querydsl/main' \ 'target/generated-sources/source/querydsl/main',
\ ] \]
< <
=============================================================================== ===============================================================================
google-java-format *ale-java-google-java-format* google-java-format *ale-java-google-java-format*
*ale-options.java_google_java_format_executable*
g:ale_java_google_java_format_executable
*g:ale_java_google_java_format_executable* *g:ale_java_google_java_format_executable*
*b:ale_java_google_java_format_executable* *b:ale_java_google_java_format_executable*
java_google_java_format_executable
g:ale_java_google_java_format_executable
Type: |String| Type: |String|
Default: `'google-java-format'` Default: `'google-java-format'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.java_google_java_format_options*
g:ale_java_google_java_format_options *g:ale_java_google_java_format_options* *g:ale_java_google_java_format_options*
*b:ale_java_google_java_format_options* *b:ale_java_google_java_format_options*
java_google_java_format_options
g:ale_java_google_java_format_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -128,9 +144,11 @@ g:ale_java_google_java_format_options *g:ale_java_google_java_format_options*
=============================================================================== ===============================================================================
pmd *ale-java-pmd* pmd *ale-java-pmd*
g:ale_java_pmd_options *g:ale_java_pmd_options* *ale-options.java_pmd_options*
*g:ale_java_pmd_options*
*b:ale_java_pmd_options* *b:ale_java_pmd_options*
java_pmd_options
g:ale_java_pmd_options
Type: |String| Type: |String|
Default: `'-R category/java/bestpractices'` Default: `'-R category/java/bestpractices'`
@@ -151,56 +169,77 @@ set.
After downloading the source code and installing all pre-requisites you can After downloading the source code and installing all pre-requisites you can
build the language server with the included build.sh script: build the language server with the included build.sh script:
scripts/build.sh `scripts/build.sh`
This will create launch scripts for Linux, Mac, and Windows in the dist folder This will create launch scripts for Linux, Mac, and Windows in the dist folder
within the repo: within the repo:
- lang_server_linux.sh - `lang_server_linux.sh`
- lang_server_mac.sh - `lang_server_mac.sh`
- lang_server_windows.sh - `lang_server_windows.sh`
To let ALE use this language server you need to set the To let ALE use this language server you need to set the executable, as
g:ale_java_javalsp_executable variable to the absolute path of the launcher documented below.
executable for your platform.
g:ale_java_javalsp_executable *g:ale_java_javalsp_executable* *ale-options.java_javalsp_executable*
*g:ale_java_javalsp_executable*
*b:ale_java_javalsp_executable* *b:ale_java_javalsp_executable*
java_javalsp_executable
g:ale_java_javalsp_executable
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable must be set to the absolute path of the language server launcher This variable must be set to the absolute path of the language server
executable. For example: launcher executable. For example: >
>
let g:ale_java_javalsp_executable=/java-language-server/dist/lang_server_linux.sh
<
g:ale_java_javalsp_config *g:ale_java_javalsp_config* let g:ale_java_javalsp_executable = '/java-language-server/dist/lang_server_linux.sh'
<
*ale-options.java_javalsp_config*
*g:ale_java_javalsp_config*
*b:ale_java_javalsp_config* *b:ale_java_javalsp_config*
java_javalsp_config
g:ale_java_javalsp_config
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
The javalsp linter automatically detects external dependencies for Maven and The javalsp linter automatically detects external dependencies for Maven and
Gradle projects. In case the javalsp fails to detect some of them, you can Gradle projects. In case the javalsp fails to detect some of them, you can
specify them setting a dictionary to |g:ale_java_javalsp_config| variable. specify them configuring settings for the language server, such as in your
> ftplugin file. >
let g:ale_java_javalsp_config =
\ {
\ 'java': {
\ 'externalDependencies': [
\ 'junit:junit:jar:4.12:test', " Maven format
\ 'junit:junit:4.1' " Gradle format
\ ],
\ 'classPath': [
\ 'lib/some-dependency.jar',
\ '/android-sdk/platforms/android-28.jar'
\ ]
\ }
\ }
The Java language server will look for the dependencies you specify in let b:ale_java_javalsp_config = {
`externalDependencies` array in your Maven and Gradle caches ~/.m2 and \ 'java': {
~/.gradle. \ 'externalDependencies': [
\ 'junit:junit:jar:4.12:test',
\ 'junit:junit:4.1'
\ ],
\ 'classPath': [
\ 'lib/some-dependency.jar',
\ '/android-sdk/platforms/android-28.jar',
\ ],
\ },
\}
<
Or in Lua: >
require("ale").setup.buffer({
java_lsp_config = {
java = {
externalDependencies = {
"junit:junit:jar:4.12:test",
"junit:junit:4.1"
},
classPath = {
"lib/some-dependency.jar",
"/android-sdk/platforms/android-28.jar",
},
},
}
})
<
The Java language server will look for the dependencies you specify in
`externalDependencies` array in your Maven and Gradle caches ~/.m2 and
~/.gradle.
=============================================================================== ===============================================================================
@@ -210,7 +249,7 @@ To enable Eclipse JDT LSP linter you need to clone and build the eclipse.jdt.ls
language server from https://github.com/eclipse/eclipse.jdt.ls. Simply language server from https://github.com/eclipse/eclipse.jdt.ls. Simply
clone the source code repo and then build the plugin: clone the source code repo and then build the plugin:
./mvnw clean verify `./mvnw clean verify`
Note: currently, the build can only run when launched with JDK 11. More Note: currently, the build can only run when launched with JDK 11. More
recent versions can be used to run the server though. recent versions can be used to run the server though.
@@ -224,9 +263,11 @@ Under your project folder, modify the file `.settings/org.eclipse.jdt.core.prefs
with options presented at with options presented at
https://help.eclipse.org/neon/topic/org.eclipse.jdt.doc.isv/reference/api/org/eclipse/jdt/core/JavaCore.html. https://help.eclipse.org/neon/topic/org.eclipse.jdt.doc.isv/reference/api/org/eclipse/jdt/core/JavaCore.html.
g:ale_java_eclipselsp_path *g:ale_java_eclipselsp_path* *ale-options.java_eclipselsp_path*
*g:ale_java_eclipselsp_path*
*b:ale_java_eclipselsp_path* *b:ale_java_eclipselsp_path*
java_eclipselsp_path
g:ale_java_eclipselsp_path
Type: |String| Type: |String|
Default: `'$HOME/eclipse.jdt.ls'` Default: `'$HOME/eclipse.jdt.ls'`
@@ -235,32 +276,37 @@ g:ale_java_eclipselsp_path *g:ale_java_eclipselsp_path*
extensions folder (e.g. $HOME/.vscode/extensions/redhat.java-0.4x.0 in extensions folder (e.g. $HOME/.vscode/extensions/redhat.java-0.4x.0 in
Linux). Linux).
*ale-options.java_eclipselsp_executable*
g:ale_java_eclipselsp_executable *g:ale_java_eclipse_executable* *g:ale_java_eclipselsp_executable*
*b:ale_java_eclipse_executable* *b:ale_java_eclipse_executable*
java_eclipselsp_executable
g:ale_java_eclipselsp_executable
Type: |String| Type: |String|
Default: `'java'` Default: `'java'`
This variable can be set to change the executable path used for java. This variable can be set to change the executable path used for java.
*ale-options.java_eclipselsp_config_path*
g:ale_java_eclipselsp_config_path *g:ale_java_eclipse_config_path* *g:ale_java_eclipselsp_config_path*
*b:ale_java_eclipse_config_path* *b:ale_java_eclipse_config_path*
java_eclipselsp_config_path
g:ale_java_eclipselsp_config_path
Type: |String| Type: |String|
Default: `''` Default: `''`
Set this variable to change the configuration directory path used by Set this variable to change the configuration directory path used by
eclipselsp (e.g. `$HOME/.jdtls` in Linux). eclipselsp (e.g. `$HOME/.jdtls` in Linux). By default ALE will attempt to
By default ALE will attempt to use the configuration within the installation use the configuration within the installation directory.
directory.
This setting is particularly useful when eclipselsp is installed in a This setting is particularly useful when eclipselsp is installed in a
non-writable directory like `/usr/share/java/jdtls`, as is the case when non-writable directory like `/usr/share/java/jdtls`, as is the case when
installed via system package. installed via system package.
*ale-options.java_eclipselsp_workspace_path*
g:ale_java_eclipselsp_workspace_path *g:ale_java_eclipselsp_workspace_path* *g:ale_java_eclipselsp_workspace_path*
*b:ale_java_eclipselsp_workspace_path* *b:ale_java_eclipselsp_workspace_path*
java_eclipselsp_workspace_path
g:ale_java_eclipselsp_workspace_path
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -268,16 +314,18 @@ g:ale_java_eclipselsp_workspace_path *g:ale_java_eclipselsp_workspace_path*
absolute path of the Eclipse workspace. If not set this value will be set to absolute path of the Eclipse workspace. If not set this value will be set to
the parent folder of the project root. the parent folder of the project root.
g:ale_java_eclipselsp_javaagent *g:ale_java_eclipselsp_javaagent* *ale-options.java_eclipselsp_javaagent*
*g:ale_java_eclipselsp_javaagent*
*b:ale_java_eclipselsp_javaagent* *b:ale_java_eclipselsp_javaagent*
java_eclipselsp_javaagent
g:ale_java_eclipselsp_javaagent
Type: |String| Type: |String|
Default: `''` Default: `''`
A variable to add java agent for annotation processing such as Lombok. A variable to add java agent for annotation processing such as Lombok.
If you have multiple java agent files, use space to separate them. If you have multiple java agent files, use space to separate them.
For example: For example: >
>
let g:ale_java_eclipselsp_javaagent='/eclipse/lombok.jar /eclipse/jacoco.jar' let g:ale_java_eclipselsp_javaagent='/eclipse/lombok.jar /eclipse/jacoco.jar'
< <
+115 -51
View File
@@ -1,6 +1,5 @@
=============================================================================== ===============================================================================
ALE JavaScript Integration *ale-javascript-options* ALE JavaScript Integration *ale-javascript-options*
*ale-eslint-nested-configuration-files* *ale-eslint-nested-configuration-files*
For fixing files with ESLint, nested configuration files with `root: false` For fixing files with ESLint, nested configuration files with `root: false`
@@ -24,7 +23,6 @@ To this: >
/path/foo/bar/.eslintrc.js # extends: ["/path/foo/.base-eslintrc.js"] /path/foo/bar/.eslintrc.js # extends: ["/path/foo/.base-eslintrc.js"]
< <
=============================================================================== ===============================================================================
biome *ale-javascript-biome* biome *ale-javascript-biome*
@@ -59,33 +57,42 @@ See |ale-dprint-options| and https://dprint.dev/plugins/typescript
=============================================================================== ===============================================================================
eslint *ale-javascript-eslint* eslint *ale-javascript-eslint*
g:ale_javascript_eslint_executable *g:ale_javascript_eslint_executable* *ale-options.javascript_eslint_executable*
*g:ale_javascript_eslint_executable*
*b:ale_javascript_eslint_executable* *b:ale_javascript_eslint_executable*
javascript_eslint_executable
g:ale_javascript_eslint_executable
Type: |String| Type: |String|
Default: `'eslint'` Default: `'eslint'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.javascript_eslint_options*
g:ale_javascript_eslint_options *g:ale_javascript_eslint_options* *g:ale_javascript_eslint_options*
*b:ale_javascript_eslint_options* *b:ale_javascript_eslint_options*
javascript_eslint_options
g:ale_javascript_eslint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to eslint. This variable can be set to pass additional options to eslint.
*ale-options.javascript_eslint_use_global*
g:ale_javascript_eslint_use_global *g:ale_javascript_eslint_use_global* *g:ale_javascript_eslint_use_global*
*b:ale_javascript_eslint_use_global* *b:ale_javascript_eslint_use_global*
javascript_eslint_use_global
g:ale_javascript_eslint_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
g:ale_javascript_eslint_suppress_eslintignore *ale-options.javascript_eslint_suppress_eslintignore*
*g:ale_javascript_eslint_suppress_eslintignore* *g:ale_javascript_eslint_suppress_eslintignore*
*b:ale_javascript_eslint_suppress_eslintignore* *b:ale_javascript_eslint_suppress_eslintignore*
javascript_eslint_suppress_eslintignore
g:ale_javascript_eslint_suppress_eslintignore
Type: |Number| Type: |Number|
Default: `0` Default: `0`
@@ -93,9 +100,11 @@ g:ale_javascript_eslint_suppress_eslintignore
by eslint. by eslint.
g:ale_javascript_eslint_suppress_missing_config *ale-options.javascript_eslint_suppress_missing_config*
*g:ale_javascript_eslint_suppress_missing_config* *g:ale_javascript_eslint_suppress_missing_config*
*b:ale_javascript_eslint_suppress_missing_config* *b:ale_javascript_eslint_suppress_missing_config*
javascript_eslint_suppress_missing_config
g:ale_javascript_eslint_suppress_missing_config
Type: |Number| Type: |Number|
Default: `0` Default: `0`
@@ -116,17 +125,21 @@ fecs *ale-javascript-fecs*
And the configuration file is located at `./fecsrc`, see http://fecs.baidu.com And the configuration file is located at `./fecsrc`, see http://fecs.baidu.com
for more options. for more options.
*ale-options.javascript_fecs_executable*
g:ale_javascript_fecs_executable *g:ale_javascript_fecs_executable* *g:ale_javascript_fecs_executable*
*b:ale_javascript_fecs_executable* *b:ale_javascript_fecs_executable*
javascript_fecs_executable
g:ale_javascript_fecs_executable
Type: |String| Type: |String|
Default: `'fecs'` Default: `'fecs'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.javascript_fecs_use_global*
g:ale_javascript_fecs_use_global *g:ale_javascript_fecs_use_global* *g:ale_javascript_fecs_use_global*
*b:ale_javascript_fecs_use_global* *b:ale_javascript_fecs_use_global*
javascript_fecs_use_global
g:ale_javascript_fecs_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -136,16 +149,21 @@ g:ale_javascript_fecs_use_global *g:ale_javascript_fecs_use_global*
=============================================================================== ===============================================================================
flow *ale-javascript-flow* flow *ale-javascript-flow*
g:ale_javascript_flow_executable *g:ale_javascript_flow_executable* *ale-options.javascript_flow_executable*
*g:ale_javascript_flow_executable*
*b:ale_javascript_flow_executable* *b:ale_javascript_flow_executable*
javascript_flow_executable
g:ale_javascript_flow_executable
Type: |String| Type: |String|
Default: `'flow'` Default: `'flow'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.javascript_flow_use_home_config*
g:ale_javascript_flow_use_home_config *g:ale_javascript_flow_use_home_config* *g:ale_javascript_flow_use_home_config*
*b:ale_javascript_flow_use_home_config* *b:ale_javascript_flow_use_home_config*
javascript_flow_use_home_config
g:ale_javascript_flow_use_home_config
Type: |Number| Type: |Number|
Default: `0` Default: `0`
@@ -154,18 +172,21 @@ g:ale_javascript_flow_use_home_config *g:ale_javascript_flow_use_home_config*
configuration files by default, as doing so can lead to Vim consuming all of configuration files by default, as doing so can lead to Vim consuming all of
your RAM and CPU power. your RAM and CPU power.
*ale-options.javascript_flow_use_global*
g:ale_javascript_flow_use_global *g:ale_javascript_flow_use_global* *g:ale_javascript_flow_use_global*
*b:ale_javascript_flow_use_global* *b:ale_javascript_flow_use_global*
javascript_flow_use_global
g:ale_javascript_flow_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.javascript_flow_use_respect_pragma*
g:ale_javascript_flow_use_respect_pragma
*g:ale_javascript_flow_use_respect_pragma* *g:ale_javascript_flow_use_respect_pragma*
*b:ale_javascript_flow_use_respect_pragma* *b:ale_javascript_flow_use_respect_pragma*
javascript_flow_use_respect_pragma
g:ale_javascript_flow_use_respect_pragma
Type: |Number| Type: |Number|
Default: `1` Default: `1`
@@ -177,8 +198,11 @@ g:ale_javascript_flow_use_respect_pragma
=============================================================================== ===============================================================================
importjs *ale-javascript-importjs* importjs *ale-javascript-importjs*
g:ale_javascript_importjs_executable *g:ale_javascript_importjs_executable* *ale-options.javascript_importjs_executable*
*g:ale_javascript_importjs_executable*
*b:ale_javascript_importjs_executable* *b:ale_javascript_importjs_executable*
javascript_importjs_executable
g:ale_javascript_importjs_executable
Type: |String| Type: |String|
Default: `'importjs'` Default: `'importjs'`
@@ -186,16 +210,21 @@ g:ale_javascript_importjs_executable *g:ale_javascript_importjs_executable*
=============================================================================== ===============================================================================
jscs *ale-javascript-jscs* jscs *ale-javascript-jscs*
g:ale_javascript_jscs_executable *g:ale_javascript_jscs_executable* *ale-options.javascript_jscs_executable*
*g:ale_javascript_jscs_executable*
*b:ale_javascript_jscs_executable* *b:ale_javascript_jscs_executable*
javascript_jscs_executable
g:ale_javascript_jscs_executable
Type: |String| Type: |String|
Default: `'jscs'` Default: `'jscs'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.javascript_jscs_use_global*
g:ale_javascript_jscs_use_global *g:ale_javascript_jscs_use_global* *g:ale_javascript_jscs_use_global*
*b:ale_javascript_jscs_use_global* *b:ale_javascript_jscs_use_global*
javascript_jscs_use_global
g:ale_javascript_jscs_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -205,16 +234,21 @@ g:ale_javascript_jscs_use_global *g:ale_javascript_jscs_use_global*
=============================================================================== ===============================================================================
jshint *ale-javascript-jshint* jshint *ale-javascript-jshint*
g:ale_javascript_jshint_executable *g:ale_javascript_jshint_executable* *ale-options.javascript_jshint_executable*
*g:ale_javascript_jshint_executable*
*b:ale_javascript_jshint_executable* *b:ale_javascript_jshint_executable*
javascript_jshint_executable
g:ale_javascript_jshint_executable
Type: |String| Type: |String|
Default: `'jshint'` Default: `'jshint'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.javascript_jshint_use_global*
g:ale_javascript_jshint_use_global *g:ale_javascript_jshint_use_global* *g:ale_javascript_jshint_use_global*
*b:ale_javascript_jshint_use_global* *b:ale_javascript_jshint_use_global*
javascript_jshint_use_global
g:ale_javascript_jshint_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -224,24 +258,31 @@ g:ale_javascript_jshint_use_global *g:ale_javascript_jshint_use_global*
=============================================================================== ===============================================================================
prettier *ale-javascript-prettier* prettier *ale-javascript-prettier*
g:ale_javascript_prettier_executable *g:ale_javascript_prettier_executable* *ale-options.javascript_prettier_executable*
*g:ale_javascript_prettier_executable*
*b:ale_javascript_prettier_executable* *b:ale_javascript_prettier_executable*
javascript_prettier_executable
g:ale_javascript_prettier_executable
Type: |String| Type: |String|
Default: `'prettier'` Default: `'prettier'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.javascript_prettier_options*
g:ale_javascript_prettier_options *g:ale_javascript_prettier_options* *g:ale_javascript_prettier_options*
*b:ale_javascript_prettier_options* *b:ale_javascript_prettier_options*
javascript_prettier_options
g:ale_javascript_prettier_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to prettier. This variable can be set to pass additional options to prettier.
*ale-options.javascript_prettier_use_global*
g:ale_javascript_prettier_use_global *g:ale_javascript_prettier_use_global* *g:ale_javascript_prettier_use_global*
*b:ale_javascript_prettier_use_global* *b:ale_javascript_prettier_use_global*
javascript_prettier_use_global
g:ale_javascript_prettier_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -251,27 +292,32 @@ g:ale_javascript_prettier_use_global *g:ale_javascript_prettier_use_global*
=============================================================================== ===============================================================================
prettier-eslint *ale-javascript-prettier-eslint* prettier-eslint *ale-javascript-prettier-eslint*
g:ale_javascript_prettier_eslint_executable *ale-options.javascript_prettier_eslint_executable*
*g:ale_javascript_prettier_eslint_executable* *g:ale_javascript_prettier_eslint_executable*
*b:ale_javascript_prettier_eslint_executable* *b:ale_javascript_prettier_eslint_executable*
javascript_prettier_eslint_executable
g:ale_javascript_prettier_eslint_executable
Type: |String| Type: |String|
Default: `'prettier-eslint'` Default: `'prettier-eslint'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.javascript_prettier_eslint_options*
g:ale_javascript_prettier_eslint_options
*g:ale_javascript_prettier_eslint_options* *g:ale_javascript_prettier_eslint_options*
*b:ale_javascript_prettier_eslint_options* *b:ale_javascript_prettier_eslint_options*
javascript_prettier_eslint_options
g:ale_javascript_prettier_eslint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to prettier-eslint. This variable can be set to pass additional options to prettier-eslint.
g:ale_javascript_prettier_eslint_use_global *ale-options.javascript_prettier_eslint_use_global*
*g:ale_javascript_prettier_eslint_use_global* *g:ale_javascript_prettier_eslint_use_global*
*b:ale_javascript_prettier_eslint_use_global* *b:ale_javascript_prettier_eslint_use_global*
javascript_prettier_eslint_use_global
g:ale_javascript_prettier_eslint_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -282,56 +328,67 @@ g:ale_javascript_prettier_eslint_use_global
prettier-standard *ale-javascript-prettier-standard* prettier-standard *ale-javascript-prettier-standard*
g:ale_javascript_prettier_standard_executable *ale-options.javascript_prettier_standard_executable*
*g:ale_javascript_prettier_standard_executable* *g:ale_javascript_prettier_standard_executable*
*b:ale_javascript_prettier_standard_executable* *b:ale_javascript_prettier_standard_executable*
javascript_prettier_standard_executable
g:ale_javascript_prettier_standard_executable
Type: |String| Type: |String|
Default: `'prettier-standard'` Default: `'prettier-standard'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
g:ale_javascript_prettier_standard_options *ale-options.javascript_prettier_standard_options*
*g:ale_javascript_prettier_standard_options* *g:ale_javascript_prettier_standard_options*
*b:ale_javascript_prettier_standard_options* *b:ale_javascript_prettier_standard_options*
javascript_prettier_standard_options
g:ale_javascript_prettier_standard_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to prettier-standard. This variable can be set to pass additional options to prettier-standard.
g:ale_javascript_prettier_standard_use_global *ale-options.javascript_prettier_standard_use_global*
*g:ale_javascript_prettier_standard_use_global* *g:ale_javascript_prettier_standard_use_global*
*b:ale_javascript_prettier_standard_use_global* *b:ale_javascript_prettier_standard_use_global*
javascript_prettier_standard_use_global
g:ale_javascript_prettier_standard_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
=============================================================================== ===============================================================================
standard *ale-javascript-standard* standard *ale-javascript-standard*
g:ale_javascript_standard_executable *g:ale_javascript_standard_executable* *ale-options.javascript_standard_executable*
*g:ale_javascript_standard_executable*
*b:ale_javascript_standard_executable* *b:ale_javascript_standard_executable*
javascript_standard_executable
g:ale_javascript_standard_executable
Type: |String| Type: |String|
Default: `'standard'` Default: `'standard'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.javascript_standard_options*
g:ale_javascript_standard_options *g:ale_javascript_standard_options* *g:ale_javascript_standard_options*
*b:ale_javascript_standard_options* *b:ale_javascript_standard_options*
javascript_standard_options
g:ale_javascript_standard_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to standard. This variable can be set to pass additional options to standard.
*ale-options.javascript_standard_use_global*
g:ale_javascript_standard_use_global *g:ale_javascript_standard_use_global* *g:ale_javascript_standard_use_global*
*b:ale_javascript_standard_use_global* *b:ale_javascript_standard_use_global*
javascript_standard_use_global
g:ale_javascript_standard_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -341,24 +398,31 @@ g:ale_javascript_standard_use_global *g:ale_javascript_standard_use_global*
=============================================================================== ===============================================================================
xo *ale-javascript-xo* xo *ale-javascript-xo*
g:ale_javascript_xo_executable *g:ale_javascript_xo_executable* *ale-options.javascript_xo_executable*
*g:ale_javascript_xo_executable*
*b:ale_javascript_xo_executable* *b:ale_javascript_xo_executable*
javascript_xo_executable
g:ale_javascript_xo_executable
Type: |String| Type: |String|
Default: `'xo'` Default: `'xo'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.javascript_xo_options*
g:ale_javascript_xo_options *g:ale_javascript_xo_options* *g:ale_javascript_xo_options*
*b:ale_javascript_xo_options* *b:ale_javascript_xo_options*
javascript_xo_options
g:ale_javascript_xo_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to xo. This variable can be set to pass additional options to xo.
*ale-options.javascript_xo_use_global*
g:ale_javascript_xo_use_global *g:ale_javascript_xo_use_global* *g:ale_javascript_xo_use_global*
*b:ale_javascript_xo_use_global* *b:ale_javascript_xo_use_global*
javascript_xo_use_global
g:ale_javascript_xo_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
+60 -25
View File
@@ -57,26 +57,34 @@ You can install it using npm:
< <
ALE provides fixjson integration as a fixer. See |ale-fix|. ALE provides fixjson integration as a fixer. See |ale-fix|.
g:ale_json_fixjson_executable *g:ale_json_fixjson_executable* -------------------------------------------------------------------------------
Options
*ale-options.json_fixjson_executable*
*g:ale_json_fixjson_executable*
*b:ale_json_fixjson_executable* *b:ale_json_fixjson_executable*
json_fixjson_executable
g:ale_json_fixjson_executable
Type: |String| Type: |String|
Default: `'fixjson'` Default: `'fixjson'`
The executable that will be run for fixjson. The executable that will be run for fixjson.
g:ale_json_fixjson_options *g:ale_json_fixjson_options* *ale-options.json_fixjson_options*
*g:ale_json_fixjson_options*
*b:ale_json_fixjson_options* *b:ale_json_fixjson_options*
json_fixjson_options
g:ale_json_fixjson_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can add extra options to the command executed for running This variable can add extra options to the command executed for running
fixjson. fixjson.
g:ale_json_fixjson_use_global *g:ale_json_fixjson_use_global* *ale-options.json_fixjson_use_global*
*g:ale_json_fixjson_use_global*
*b:ale_json_fixjson_use_global* *b:ale_json_fixjson_use_global*
json_fixjson_use_global
g:ale_json_fixjson_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -88,18 +96,22 @@ pytool *ale-json-pytool*
Use python's json.tool module to reformat json. Use python's json.tool module to reformat json.
g:ale_json_pytool_executable *g:ale_json_pytool_executable* *ale-options.json_pytool_executable*
*g:ale_json_pytool_executable*
*b:ale_json_pytool_executable* *b:ale_json_pytool_executable*
json_pytool_executable
g:ale_json_pytool_executable
Type: |String| Type: |String|
Default: `'python'` Default: `'python'`
The python executable that run to use its json.tool module. This fixer The python executable that run to use its json.tool module. This fixer
requires python 3, which includes the json module. requires python 3, which includes the json module.
g:ale_json_pytool_options *g:ale_json_pytool_options* *ale-options.json_pytool_options*
*g:ale_json_pytool_options*
*b:ale_json_pytool_options* *b:ale_json_pytool_options*
json_pytool_options
g:ale_json_pytool_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -108,9 +120,11 @@ g:ale_json_pytool_options *g:ale_json_pytool_options*
< See docs for all options: < See docs for all options:
https://docs.python.org/3/library/json.html#module-json.tool https://docs.python.org/3/library/json.html#module-json.tool
g:ale_json_pytool_use_global *g:ale_json_pytool_use_global* *ale-options.json_pytool_use_global*
*g:ale_json_pytool_use_global*
*b:ale_json_pytool_use_global* *b:ale_json_pytool_use_global*
json_pytool_use_global
g:ale_json_pytool_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -120,17 +134,21 @@ g:ale_json_pytool_use_global *g:ale_json_pytool_use_global*
=============================================================================== ===============================================================================
jsonlint *ale-json-jsonlint* jsonlint *ale-json-jsonlint*
g:ale_json_jsonlint_executable *g:ale_json_jsonlint_executable* *ale-options.json_jsonlint_executable*
*g:ale_json_jsonlint_executable*
*b:ale_json_jsonlint_executable* *b:ale_json_jsonlint_executable*
json_jsonlint_executable
g:ale_json_jsonlint_executable
Type: |String| Type: |String|
Default: `'jsonlint'` Default: `'jsonlint'`
The executable that will be run for jsonlint. The executable that will be run for jsonlint.
g:ale_json_jsonlint_use_global *g:ale_json_jsonlint_use_global* *ale-options.json_jsonlint_use_global*
*b:ale_json_jsonlint_use_global* *g:ale_json_jsonlint_use_global*
*b:ale_json_jsonlint_use_global*
json_jsonlint_use_global
g:ale_json_jsonlint_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -140,23 +158,32 @@ g:ale_json_jsonlint_use_global *g:ale_json_jsonlint_use_global*
=============================================================================== ===============================================================================
jq *ale-json-jq* jq *ale-json-jq*
g:ale_json_jq_executable *g:ale_json_jq_executable* *ale-options.json_jq_executable*
*g:ale_json_jq_executable*
*b:ale_json_jq_executable* *b:ale_json_jq_executable*
json_jq_executable
g:ale_json_jq_executable
Type: |String| Type: |String|
Default: `'jq'` Default: `'jq'`
This option can be changed to change the path for `jq`. This option can be changed to change the path for `jq`.
g:ale_json_jq_options *g:ale_json_jq_options* *ale-options.json_jq_options*
*g:ale_json_jq_options*
*b:ale_json_jq_options* *b:ale_json_jq_options*
json_jq_options
g:ale_json_jq_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This option can be changed to pass extra options to `jq`. This option can be changed to pass extra options to `jq`.
g:ale_json_jq_filters *g:ale_json_jq_filters* *ale-options.json_jq_filters*
*g:ale_json_jq_filters*
*b:ale_json_jq_filters* *b:ale_json_jq_filters*
json_jq_filters
g:ale_json_jq_filters
Type: |String| Type: |String|
Default: `'.'` Default: `'.'`
@@ -174,8 +201,9 @@ spectral *ale-json-spectral*
Website: https://github.com/stoplightio/spectral Website: https://github.com/stoplightio/spectral
Installation
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Installation
Install spectral either globally or locally: > Install spectral either globally or locally: >
@@ -183,30 +211,37 @@ Install spectral either globally or locally: >
npm install @stoplight/spectral # local npm install @stoplight/spectral # local
< <
Options
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Options
g:ale_json_spectral_executable *g:ale_json_spectral_executable* *ale-options.json_spectral_executable*
*g:ale_json_spectral_executable*
*b:ale_json_spectral_executable* *b:ale_json_spectral_executable*
json_spectral_executable
g:ale_json_spectral_executable
Type: |String| Type: |String|
Default: `'spectral'` Default: `'spectral'`
This variable can be set to change the path to spectral. This variable can be set to change the path to spectral.
g:ale_json_spectral_use_global *g:ale_json_spectral_use_global* *ale-options.json_spectral_use_global*
*g:ale_json_spectral_use_global*
*b:ale_json_spectral_use_global* *b:ale_json_spectral_use_global*
json_spectral_use_global
g:ale_json_spectral_use_global
Type: |String| Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
=============================================================================== ===============================================================================
vscodejson *ale-json-vscode* vscodejson *ale-json-vscode*
Website: https://github.com/hrsh7th/vscode-langservers-extracted Website: https://github.com/hrsh7th/vscode-langservers-extracted
Installation
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Installation
Install VSCode json language server either globally or locally: > Install VSCode json language server either globally or locally: >
+18 -7
View File
@@ -5,16 +5,21 @@ ALE Jsonnet Integration *ale-jsonnet-options*
=============================================================================== ===============================================================================
jsonnetfmt *ale-jsonnet-jsonnetfmt* jsonnetfmt *ale-jsonnet-jsonnetfmt*
g:ale_jsonnet_jsonnetfmt_executable *g:ale_jsonnet_jsonnetfmt_executable* *ale-options.jsonnet_jsonnetfmt_executable*
*g:ale_jsonnet_jsonnetfmt_executable*
*b:ale_jsonnet_jsonnetfmt_executable* *b:ale_jsonnet_jsonnetfmt_executable*
jsonnet_jsonnetfmt_executable
g:ale_jsonnet_jsonnetfmt_executable
Type: |String| Type: |String|
Default: `'jsonnetfmt'` Default: `'jsonnetfmt'`
This option can be changed to change the path for `jsonnetfmt`. This option can be changed to change the path for `jsonnetfmt`.
*ale-options.jsonnet_jsonnetfmt_options*
g:ale_jsonnet_jsonnetfmt_options *g:ale_jsonnet_jsonnetfmt_options* *g:ale_jsonnet_jsonnetfmt_options*
*b:ale_jsonnet_jsonnetfmt_options* *b:ale_jsonnet_jsonnetfmt_options*
jsonnet_jsonnetfmt_options
g:ale_jsonnet_jsonnetfmt_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -24,20 +29,26 @@ g:ale_jsonnet_jsonnetfmt_options *g:ale_jsonnet_jsonnetfmt_options*
=============================================================================== ===============================================================================
jsonnet-lint *ale-jsonnet-jsonnet-lint* jsonnet-lint *ale-jsonnet-jsonnet-lint*
g:ale_jsonnet_jsonnet_lint_executable *g:ale_jsonnet_jsonnet_lint_executable* *ale-options.jsonnet_jsonnet_lint_executable*
*g:ale_jsonnet_jsonnet_lint_executable*
*b:ale_jsonnet_jsonnet_lint_executable* *b:ale_jsonnet_jsonnet_lint_executable*
jsonnet_jsonnet_lint_executable
g:ale_jsonnet_jsonnet_lint_executable
Type: |String| Type: |String|
Default: `'jsonnet-lint'` Default: `'jsonnet-lint'`
This option can be changed to change the path for `jsonnet-lint`. This option can be changed to change the path for `jsonnet-lint`.
*ale-options.jsonnet_jsonnet_lint_options*
g:ale_jsonnet_jsonnet_lint_options *g:ale_jsonnet_jsonnet_lint_options* *g:ale_jsonnet_jsonnet_lint_options*
*b:ale_jsonnet_jsonnet_lint_options* *b:ale_jsonnet_jsonnet_lint_options*
jsonnet_jsonnet_lint_options
g:ale_jsonnet_jsonnet_lint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This option can be changed to pass extra options to `jsonnet-lint`. This option can be changed to pass extra options to `jsonnet-lint`.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+6 -3
View File
@@ -1,20 +1,23 @@
=============================================================================== ===============================================================================
ALE Julia Integration *ale-julia-options* ALE Julia Integration *ale-julia-options*
=============================================================================== ===============================================================================
languageserver *ale-julia-languageserver* languageserver *ale-julia-languageserver*
To enable Julia LSP linter you need to install the LanguageServer.jl package To enable Julia LSP linter you need to install the LanguageServer.jl package
within julia. within julia.
g:ale_julia_executable *g:ale_julia_executable* *ale-options.julia_executable*
*g:ale_julia_executable*
*b:ale_julia_executable* *b:ale_julia_executable*
julia_executable
g:ale_julia_executable
Type: |String| Type: |String|
Default: `'julia'` Default: `'julia'`
Path to the julia exetuable. Path to the julia exetuable.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+62 -18
View File
@@ -15,47 +15,75 @@ Integration Information
=============================================================================== ===============================================================================
kotlinc *ale-kotlin-kotlinc* kotlinc *ale-kotlin-kotlinc*
g:ale_kotlin_kotlinc_options *g:ale_kotlin_kotlinc_options* *ale-options.kotlin_kotlinc_options*
*g:ale_kotlin_kotlinc_options*
*b:ale_kotlin_kotlinc_options*
kotlin_kotlinc_options
g:ale_kotlin_kotlinc_options
Type: |String| Type: |String|
Default: `''` Default: `''`
Additional options to pass to the kotlin compiler Additional options to pass to the kotlin compiler
g:ale_kotlin_kotlinc_enable_config *g:ale_kotlin_kotlinc_enable_config* *ale-options.kotlin_kotlinc_enable_config*
*g:ale_kotlin_kotlinc_enable_config*
*b:ale_kotlin_kotlinc_enable_config*
kotlin_kotlinc_enable_config
g:ale_kotlin_kotlinc_enable_config
Type: |Number| Type: |Number|
Default: `0` Default: `0`
Setting this variable to `1` tells the linter to load a configuration file. Setting this variable to `1` tells the linter to load a configuration file.
This should be set in your vimrc This should be set in your vimrc
g:ale_kotlin_kotlinc_config_file *g:ale_kotlin_kotlinc_config_file* *ale-options.kotlin_kotlinc_config_file*
*g:ale_kotlin_kotlinc_config_file*
*b:ale_kotlin_kotlinc_config_file*
kotlin_kotlinc_config_file
g:ale_kotlin_kotlinc_config_file
Type: |String| Type: |String|
Default: `'.ale_kotlin_kotlinc_config'` Default: `'.ale_kotlin_kotlinc_config'`
Filename of the configuration file. This should be set in your vimrc Filename of the configuration file. This should be set in your vimrc
g:ale_kotlin_kotlinc_classpath *g:ale_kotlin_kotlinc_classpath* *ale-options.kotlin_kotlinc_classpath*
*g:ale_kotlin_kotlinc_classpath*
*b:ale_kotlin_kotlinc_classpath*
kotlin_kotlinc_classpath
g:ale_kotlin_kotlinc_classpath
Type: |String| Type: |String|
Default: `''` Default: `''`
A string containing the paths (separated by the appropriate path separator) A string containing the paths (separated by the appropriate path separator)
of the source directories. of the source directories.
g:ale_kotlin_kotlinc_sourcepath *g:ale_kotlin_kotlinc_sourcepath* *ale-options.kotlin_kotlinc_sourcepath*
*g:ale_kotlin_kotlinc_sourcepath*
*b:ale_kotlin_kotlinc_sourcepath*
kotlin_kotlinc_sourcepath
g:ale_kotlin_kotlinc_sourcepath
Type: |String| Type: |String|
Default: `''` Default: `''`
A string containing the paths (separated by space) of the source A string containing the paths (separated by space) of the source
directories. directories.
g:ale_kotlin_kotlinc_use_module_file *g:ale_kotlin_kotlinc_use_module_file* *ale-options.kotlin_kotlinc_use_module_file*
*g:ale_kotlin_kotlinc_use_module_file*
*b:ale_kotlin_kotlinc_use_module_file*
kotlin_kotlinc_use_module_file
g:ale_kotlin_kotlinc_use_module_file
Type: |Number| Type: |Number|
Default: `0` Default: `0`
This option indicates whether the linter should use a module file. It is off This option indicates whether the linter should use a module file. It is off
by default. by default.
g:ale_kotlin_kotlinc_module_filename *g:ale_kotlin_kotlinc_module_filename* *ale-options.kotlin_kotlinc_module_filename*
*g:ale_kotlin_kotlinc_module_filename*
*b:ale_kotlin_kotlinc_module_filename*
kotlin_kotlinc_module_filename
g:ale_kotlin_kotlinc_module_filename
Type: |String| Type: |String|
Default: `'module.xml'` Default: `'module.xml'`
@@ -66,7 +94,11 @@ g:ale_kotlin_kotlinc_module_filename *g:ale_kotlin_kotlinc_module_filename*
=============================================================================== ===============================================================================
ktlint *ale-kotlin-ktlint* ktlint *ale-kotlin-ktlint*
g:ale_kotlin_ktlint_executable *g:ale_kotlin_ktlint_executable* *ale-options.kotlin_ktlint_executable*
*g:ale_kotlin_ktlint_executable*
*b:ale_kotlin_ktlint_executable*
kotlin_ktlint_executable
g:ale_kotlin_ktlint_executable
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -77,29 +109,41 @@ g:ale_kotlin_ktlint_executable *g:ale_kotlin_ktlint_executable*
bet will be to download the ktlint jar and set this option to something bet will be to download the ktlint jar and set this option to something
similar to `'java -jar /path/to/ktlint.jar'` similar to `'java -jar /path/to/ktlint.jar'`
g:ale_kotlin_ktlint_rulesets *g:ale_kotlin_ktlint_rulesets* *ale-options.kotlin_ktlint_rulesets*
Type: |List| of |String|s *g:ale_kotlin_ktlint_rulesets*
*b:ale_kotlin_ktlint_rulesets*
kotlin_ktlint_rulesets
g:ale_kotlin_ktlint_rulesets
Type: |List|
Default: `[]` Default: `[]`
This list should contain paths to ruleset jars and/or strings of maven This list should contain paths to ruleset jars and/or strings of maven
artifact triples. Example: artifact triples. Example: >
>
let g:ale_kotlin_ktlint_rulesets = ['/path/to/custom-ruleset.jar', let g:ale_kotlin_ktlint_rulesets = ['/path/to/custom-ruleset.jar',
'com.ktlint.rulesets:mycustomrule:1.0.0'] 'com.ktlint.rulesets:mycustomrule:1.0.0']
<
g:ale_kotlin_ktlint_options *g:ale_kotlin_ktlint_options* *ale-options.kotlin_ktlint_options*
*g:ale_kotlin_ktlint_options*
*b:ale_kotlin_ktlint_options*
kotlin_ktlint_options
g:ale_kotlin_ktlint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
Additional options to pass to ktlint for both linting and fixing. Example: Options to pass to ktlint for both linting and fixing. For example: >
>
let g:ale_kotlin_ktlint_options = '--android'
let g:ale_kotlin_ktlint_options = '--android'
<
=============================================================================== ===============================================================================
languageserver *ale-kotlin-languageserver* languageserver *ale-kotlin-languageserver*
g:ale_kotlin_languageserver_executable *g:ale_kotlin_languageserver_executable* *ale-options.kotlin_languageserver_executable*
*g:ale_kotlin_languageserver_executable*
*b:ale_kotlin_languageserver_executable*
kotlin_languageserver_executable
g:ale_kotlin_languageserver_executable
Type: |String| Type: |String|
Default: `''` Default: `''`
+24 -10
View File
@@ -5,24 +5,31 @@ ALE Less Integration *ale-less-options*
=============================================================================== ===============================================================================
lessc *ale-less-lessc* lessc *ale-less-lessc*
g:ale_less_lessc_executable *g:ale_less_lessc_executable* *ale-options.less_lessc_executable*
*g:ale_less_lessc_executable*
*b:ale_less_lessc_executable* *b:ale_less_lessc_executable*
less_lessc_executable
g:ale_less_lessc_executable
Type: |String| Type: |String|
Default: `'lessc'` Default: `'lessc'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.less_lessc_options*
g:ale_less_lessc_options *g:ale_less_lessc_options* *g:ale_less_lessc_options*
*b:ale_less_lessc_options* *b:ale_less_lessc_options*
less_lessc_options
g:ale_less_lessc_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to lessc. This variable can be set to pass additional options to lessc.
*ale-options.less_lessc_use_global*
g:ale_less_lessc_use_global *g:ale_less_lessc_use_global* *g:ale_less_lessc_use_global*
*b:ale_less_lessc_use_global* *b:ale_less_lessc_use_global*
less_lessc_use_global
g:ale_less_lessc_use_global
Type: |String| Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -38,24 +45,31 @@ See |ale-javascript-prettier| for information about the available options.
=============================================================================== ===============================================================================
stylelint *ale-less-stylelint* stylelint *ale-less-stylelint*
g:ale_less_stylelint_executable *g:ale_less_stylelint_executable* *ale-options.less_stylelint_executable*
*g:ale_less_stylelint_executable*
*b:ale_less_stylelint_executable* *b:ale_less_stylelint_executable*
less_stylelint_executable
g:ale_less_stylelint_executable
Type: |String| Type: |String|
Default: `'stylelint'` Default: `'stylelint'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.less_stylelint_options*
g:ale_less_stylelint_options *g:ale_less_stylelint_options* *g:ale_less_stylelint_options*
*b:ale_less_stylelint_options* *b:ale_less_stylelint_options*
less_stylelint_options
g:ale_less_stylelint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to stylelint. This variable can be set to pass additional options to stylelint.
*ale-options.less_stylelint_use_global*
g:ale_less_stylelint_use_global *g:ale_less_stylelint_use_global* *g:ale_less_stylelint_use_global*
*b:ale_less_stylelint_use_global* *b:ale_less_stylelint_use_global*
less_stylelint_use_global
g:ale_less_stylelint_use_global
Type: |String| Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
+4 -2
View File
@@ -5,9 +5,11 @@ ALE LLVM Integration *ale-llvm-options*
=============================================================================== ===============================================================================
llc *ale-llvm-llc* llc *ale-llvm-llc*
g:ale_llvm_llc_executable *g:ale_llvm_llc_executable* *ale-options.llvm_llc_executable*
*g:ale_llvm_llc_executable*
*b:ale_llvm_llc_executable* *b:ale_llvm_llc_executable*
llvm_llc_executable
g:ale_llvm_llc_executable
Type: |String| Type: |String|
Default: `"llc"` Default: `"llc"`
+52 -19
View File
@@ -11,16 +11,21 @@ See |ale-cspell-options|
=============================================================================== ===============================================================================
lua-format *ale-lua-lua-format* 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* *b:ale_lua_lua_format_executable*
lua_lua_format_executable
g:ale_lua_lua_format_executable
Type: |String| Type: |String|
Default: `'lua-format'` Default: `'lua-format'`
This variable can be changed to change the path to lua-format. This variable can be changed to change the path to lua-format.
*ale-options.lua_lua_format_options*
g:ale_lua_lua_format_options *g:ale_lua_lua_format_options* *g:ale_lua_lua_format_options*
*b:ale_lua_lua_format_options* *b:ale_lua_lua_format_options*
lua_lua_format_options
g:ale_lua_lua_format_options
Type: |String| Type: |String|
Default: `''` 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* lua-language-server *ale-lua-lua-language-server*
*ale-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* *b:ale_lua_language_server_executable*
lua_language_server_executable
g:ale_lua_language_server_executable
Type: |String| Type: |String|
Default: `'lua-language-server'` 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 If you have compiled the language server yourself in `/some/path`, the path
will be `'/some/path/bin/lua-language-server'`. will be `'/some/path/bin/lua-language-server'`.
*ale-options.lua_lua_language_server_config*
g:ale_lua_lua_language_server_config *g:ale_lua_lua_language_server_config* *g:ale_lua_lua_language_server_config*
*b: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| Type: |Dictionary|
Default: `{}` Default: `{}`
@@ -54,8 +64,11 @@ g:ale_lua_lua_language_server_config *g:ale_lua_lua_language_server_config*
=============================================================================== ===============================================================================
luac *ale-lua-luac* 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* *b:ale_lua_luac_executable*
lua_luac_executable
g:ale_lua_luac_executable
Type: |String| Type: |String|
Default: `'luac'` Default: `'luac'`
@@ -65,16 +78,21 @@ g:ale_lua_luac_executable *g:ale_lua_luac_executable*
=============================================================================== ===============================================================================
luacheck *ale-lua-luacheck* 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* *b:ale_lua_luacheck_executable*
lua_luacheck_executable
g:ale_lua_luacheck_executable
Type: |String| Type: |String|
Default: `'luacheck'` Default: `'luacheck'`
This variable can be changed to change the path to luacheck. This variable can be changed to change the path to luacheck.
*ale-options.lua_luacheck_options*
g:ale_lua_luacheck_options *g:ale_lua_luacheck_options* *g:ale_lua_luacheck_options*
*b:ale_lua_luacheck_options* *b:ale_lua_luacheck_options*
lua_luacheck_options
g:ale_lua_luacheck_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -84,16 +102,21 @@ g:ale_lua_luacheck_options *g:ale_lua_luacheck_options*
=============================================================================== ===============================================================================
luafmt *ale-lua-luafmt* 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* *b:ale_lua_luafmt_executable*
lua_luafmt_executable
g:ale_lua_luafmt_executable
Type: |String| Type: |String|
Default: `'luafmt'` Default: `'luafmt'`
This variable can be set to use a different executable for luafmt. This variable can be set to use a different executable for luafmt.
*ale-options.lua_luafmt_options*
g:ale_lua_luafmt_options *g:ale_lua_luafmt_options* *g:ale_lua_luafmt_options*
*b:ale_lua_luafmt_options* *b:ale_lua_luafmt_options*
lua_luafmt_options
g:ale_lua_luafmt_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -103,16 +126,21 @@ g:ale_lua_luafmt_options *g:ale_lua_luafmt_options*
=============================================================================== ===============================================================================
selene *ale-lua-selene* 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* *b:ale_lua_selene_executable*
lua_selene_executable
g:ale_lua_selene_executable
Type: |String| Type: |String|
Default: `'selene'` Default: `'selene'`
This variable can be set to use a different executable for selene. This variable can be set to use a different executable for selene.
*ale-options.lua_selene_options*
g:ale_lua_selene_options *g:ale_lua_selene_options* *g:ale_lua_selene_options*
*b:ale_lua_selene_options* *b:ale_lua_selene_options*
lua_selene_options
g:ale_lua_selene_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -122,16 +150,21 @@ g:ale_lua_selene_options *g:ale_lua_selene_options*
=============================================================================== ===============================================================================
stylua *ale-lua-stylua* 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* *b:ale_lua_stylua_executable*
lua_stylua_executable
g:ale_lua_stylua_executable
Type: |String| Type: |String|
Default: `'stylua'` Default: `'stylua'`
This variable can be set to use a different executable for stylua. This variable can be set to use a different executable for stylua.
*ale-options.lua_stylua_options*
g:ale_lua_stylua_options *g:ale_lua_stylua_options* *g:ale_lua_stylua_options*
*b:ale_lua_stylua_options* *b:ale_lua_stylua_options*
lua_stylua_options
g:ale_lua_stylua_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+5 -1
View File
@@ -5,8 +5,11 @@ ALE Make Integration *ale-make-options
=============================================================================== ===============================================================================
checkmake *ale-make-checkmake* checkmake *ale-make-checkmake*
g:ale_make_checkmake_config *g:ale_make_checkmake_config* *ale-options.make_checkmake_config*
*g:ale_make_checkmake_config*
*b:ale_make_checkmake_config* *b:ale_make_checkmake_config*
make_checkmake_config
g:ale_make_checkmake_config
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -14,5 +17,6 @@ g:ale_make_checkmake_config *g:ale_make_checkmake_config
if the value is empty, the checkmake command will not be invoked with the if the value is empty, the checkmake command will not be invoked with the
option. option.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+65 -26
View File
@@ -17,17 +17,22 @@ See |ale-dprint-options| and https://dprint.dev/plugins/markdown
=============================================================================== ===============================================================================
markdownlint *ale-markdown-markdownlint* markdownlint *ale-markdown-markdownlint*
g:ale_markdown_markdownlint_executable *g:ale_markdown_markdownlint_executable* *ale-options.markdown_markdownlint_executable*
*g:ale_markdown_markdownlint_executable*
*b:ale_markdown_markdownlint_executable* *b:ale_markdown_markdownlint_executable*
markdown_markdownlint_executable
g:ale_markdown_markdownlint_executable
Type: |String| Type: |String|
Default: `'markdownlint'` Default: `'markdownlint'`
Override the invoked `markdownlint` binary. You can use other binaries such as Override the invoked `markdownlint` binary. You can use other binaries such as
`markdownlint-cli2`. `markdownlint-cli2`.
*ale-options.markdown_markdownlint_options*
g:ale_markdown_markdownlint_options *g:ale_markdown_markdownlint_options* *g:ale_markdown_markdownlint_options*
*b:ale_markdown_markdownlint_options* *b:ale_markdown_markdownlint_options*
markdown_markdownlint_options
g:ale_markdown_markdownlint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -37,8 +42,11 @@ g:ale_markdown_markdownlint_options *g:ale_markdown_markdownlint_options*
=============================================================================== ===============================================================================
marksman *ale-markdown-marksman* marksman *ale-markdown-marksman*
g:ale_markdown_marksman_executable *g:ale_markdown_marksman_executable* *ale-options.markdown_marksman_executable*
*g:ale_markdown_marksman_executable*
*b:ale_markdown_marksman_executable* *b:ale_markdown_marksman_executable*
markdown_marksman_executable
g:ale_markdown_marksman_executable
Type: |String| Type: |String|
Default: `'marksman'` Default: `'marksman'`
@@ -48,17 +56,22 @@ g:ale_markdown_marksman_executable *g:ale_markdown_marksman_executable*
=============================================================================== ===============================================================================
mdl *ale-markdown-mdl* mdl *ale-markdown-mdl*
g:ale_markdown_mdl_executable *g:ale_markdown_mdl_executable* *ale-options.markdown_mdl_executable*
*g:ale_markdown_mdl_executable*
*b:ale_markdown_mdl_executable* *b:ale_markdown_mdl_executable*
markdown_mdl_executable
g:ale_markdown_mdl_executable
Type: |String| Type: |String|
Default: `'mdl'` Default: `'mdl'`
Override the invoked mdl binary. This is useful for running mdl from Override the invoked mdl binary. This is useful for running mdl from
binstubs or a bundle. binstubs or a bundle.
*ale-options.markdown_mdl_options*
g:ale_markdown_mdl_options *g:ale_markdown_mdl_options* *g:ale_markdown_mdl_options*
*b:ale_markdown_mdl_options* *b:ale_markdown_mdl_options*
markdown_mdl_options
g:ale_markdown_mdl_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -68,21 +81,27 @@ g:ale_markdown_mdl_options *g:ale_markdown_mdl_options*
=============================================================================== ===============================================================================
pandoc *ale-markdown-pandoc* pandoc *ale-markdown-pandoc*
g:ale_markdown_pandoc_executable *g:ale_markdown_pandoc_executable* *ale-options.markdown_pandoc_executable*
*g:ale_markdown_pandoc_executable*
*b:ale_markdown_pandoc_executable* *b:ale_markdown_pandoc_executable*
markdown_pandoc_executable
g:ale_markdown_pandoc_executable
Type: |String| Type: |String|
Default: `'pandoc'` Default: `'pandoc'`
This variable can be set to specify where to find the pandoc executable This variable can be set to specify where to find the pandoc executable
*ale-options.markdown_pandoc_options*
g:ale_markdown_pandoc_options *g:ale_markdown_pandoc_options* *g:ale_markdown_pandoc_options*
*b:ale_markdown_pandoc_options* *b:ale_markdown_pandoc_options*
markdown_pandoc_options
g:ale_markdown_pandoc_options
Type: |String| Type: |String|
Default: `'-f gfm -t gfm -s -'` Default: `'-f gfm -t gfm -s -'`
This variable can be set to change the default options passed to pandoc This variable can be set to change the default options passed to pandoc
=============================================================================== ===============================================================================
prettier *ale-markdown-prettier* prettier *ale-markdown-prettier*
@@ -92,8 +111,11 @@ See |ale-javascript-prettier| for information about the available options.
=============================================================================== ===============================================================================
pymarkdown *ale-markdown-pymarkdown* pymarkdown *ale-markdown-pymarkdown*
g:ale_markdown_pymarkdown_executable *g:ale_markdown_pymarkdown_executable* *ale-options.markdown_pymarkdown_executable*
*g:ale_markdown_pymarkdown_executable*
*b:ale_markdown_pymarkdown_executable* *b:ale_markdown_pymarkdown_executable*
markdown_pymarkdown_executable
g:ale_markdown_pymarkdown_executable
Type: |String| Type: |String|
Default: `'pymarkdown'` Default: `'pymarkdown'`
@@ -102,44 +124,54 @@ g:ale_markdown_pymarkdown_executable *g:ale_markdown_pymarkdown_executable
Set this to `'pipenv'` to invoke `'pipenv` `run` `pymarkdown'`. Set this to `'pipenv'` to invoke `'pipenv` `run` `pymarkdown'`.
Set this to `'poetry'` to invoke `'poetry` `run` `pymarkdown'`. Set this to `'poetry'` to invoke `'poetry` `run` `pymarkdown'`.
*ale-options.markdown_pymarkdown_options*
g:ale_markdown_pymarkdown_options *g:ale_markdown_pymarkdown_options* *g:ale_markdown_pymarkdown_options*
*b:ale_markdown_pymarkdown_options* *b:ale_markdown_pymarkdown_options*
markdown_pymarkdown_options
g:ale_markdown_pymarkdown_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to add command-line arguments to the This variable can be changed to add command-line arguments to the
pymarkdown invocation. pymarkdown invocation.
*ale-options.markdown_pymarkdown_use_global*
g:ale_markdown_pymarkdown_use_global *g:ale_markdown_pymarkdown_use_global* *g:ale_markdown_pymarkdown_use_global*
*b:ale_markdown_pymarkdown_use_global* *b:ale_markdown_pymarkdown_use_global*
markdown_pymarkdown_use_global
g:ale_markdown_pymarkdown_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.markdown_pymarkdown_auto_pipenv*
g:ale_markdown_pymarkdown_auto_pipenv *g:ale_markdown_pymarkdown_auto_pipenv* *g:ale_markdown_pymarkdown_auto_pipenv*
*b:ale_markdown_pymarkdown_auto_pipenv* *b:ale_markdown_pymarkdown_auto_pipenv*
markdown_pymarkdown_auto_pipenv
g:ale_markdown_pymarkdown_auto_pipenv
Type: |Number| Type: |Number|
Default: `0` Default: `0`
Detect whether the file is inside a pipenv, and set the executable to `pipenv` Detect whether the file is inside a pipenv, and set the executable to `pipenv`
if true. This is overridden by a manually-set executable. if true. This is overridden by a manually-set executable.
*ale-options.markdown_pymarkdown_auto_poetry*
g:ale_markdown_pymarkdown_auto_poetry *g:ale_markdown_pymarkdown_auto_poetry* *g:ale_markdown_pymarkdown_auto_poetry*
*b:ale_markdown_pymarkdown_auto_poetry* *b:ale_markdown_pymarkdown_auto_poetry*
markdown_pymarkdown_auto_poetry
g:ale_markdown_pymarkdown_auto_poetry
Type: |Number| Type: |Number|
Default: `0` Default: `0`
Detect whether the file is inside a poetry, and set the executable to `poetry` Detect whether the file is inside a poetry, and set the executable to `poetry`
if true. This is overridden by a manually-set executable. if true. This is overridden by a manually-set executable.
*ale-options.markdown_pymarkdown_auto_uv*
g:ale_markdown_pymarkdown_auto_uv *g:ale_markdown_pymarkdown_auto_uv* *g:ale_markdown_pymarkdown_auto_uv*
*b:ale_markdown_pymarkdown_auto_uv* *b:ale_markdown_pymarkdown_auto_uv*
markdown_pymarkdown_auto_uv
g:ale_markdown_pymarkdown_auto_uv
Type: |Number| Type: |Number|
Default: `0` Default: `0`
@@ -150,24 +182,31 @@ g:ale_markdown_pymarkdown_auto_uv *g:ale_markdown_pymarkdown_auto_uv
=============================================================================== ===============================================================================
remark-lint *ale-markdown-remark-lint* remark-lint *ale-markdown-remark-lint*
g:ale_markdown_remark_lint_executable *g:ale_markdown_remark_lint_executable* *ale-options.markdown_remark_lint_executable*
*g:ale_markdown_remark_lint_executable*
*b:ale_markdown_remark_lint_executable* *b:ale_markdown_remark_lint_executable*
markdown_remark_lint_executable
g:ale_markdown_remark_lint_executable
Type: |String| Type: |String|
Default: `'remark'` Default: `'remark'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.markdown_remark_lint_options*
g:ale_markdown_remark_lint_options *g:ale_markdown_remark_lint_options* *g:ale_markdown_remark_lint_options*
*b:ale_markdown_remark_lint_options* *b:ale_markdown_remark_lint_options*
markdown_remark_lint_options
g:ale_markdown_remark_lint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to remark-lint. This variable can be set to pass additional options to remark-lint.
*ale-options.markdown_remark_lint_use_global*
g:ale_markdown_remark_lint_use_global *g:ale_markdown_remark_lint_use_global* *g:ale_markdown_remark_lint_use_global*
*b:ale_markdown_remark_lint_use_global* *b:ale_markdown_remark_lint_use_global*
markdown_remark_lint_use_global
g:ale_markdown_remark_lint_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
+8 -4
View File
@@ -5,17 +5,21 @@ ALE Mercury Integration *ale-mercury-options*
=============================================================================== ===============================================================================
mmc *ale-mercury-mmc* mmc *ale-mercury-mmc*
*ale-options.mercury_mmc_executable*
g:ale_mercury_mmc_executable *g:ale_mercury_mmc_executable* *g:ale_mercury_mmc_executable*
*b:ale_mercury_mmc_executable* *b:ale_mercury_mmc_executable*
mercury_mmc_executable
g:ale_mercury_mmc_executable
Type: |String| Type: |String|
Default: `'mmc'` Default: `'mmc'`
This variable can be changed to use a different executable for mmc. This variable can be changed to use a different executable for mmc.
*ale-options.mercury_mmc_options*
g:ale_mercury_mmc_options *g:ale_mercury_mmc_options* *g:ale_mercury_mmc_options*
*b:ale_mercury_mmc_options* *b:ale_mercury_mmc_options*
mercury_mmc_options
g:ale_mercury_mmc_options
Type: |String| Type: |String|
Default: `'--make --output-compile-error-lines 100'` Default: `'--make --output-compile-error-lines 100'`
+8 -4
View File
@@ -5,17 +5,21 @@ ALE NASM Integration *ale-nasm-options*
=============================================================================== ===============================================================================
nasm *ale-nasm-nasm* nasm *ale-nasm-nasm*
g:ale_nasm_nasm_executable *g:ale_nasm_nasm_executable* *ale-options.nasm_nasm_executable*
*g:ale_nasm_nasm_executable*
*b:ale_nasm_nasm_executable* *b:ale_nasm_nasm_executable*
nasm_nasm_executable
g:ale_nasm_nasm_executable
Type: |String| Type: |String|
Default `'nasm'` Default `'nasm'`
This variable can be changed to use different executable for NASM. This variable can be changed to use different executable for NASM.
*ale-options.nasm_nasm_options*
g:ale_nasm_nasm_options *g:ale_nasm_nasm_options* *g:ale_nasm_nasm_options*
*b:ale_nasm_nasm_options* *b:ale_nasm_nasm_options*
nasm_nasm_options
g:ale_nasm_nasm_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+12 -7
View File
@@ -1,20 +1,25 @@
=============================================================================== ===============================================================================
ALE Nickel Integration *ale-nickel-options* ALE Nickel Integration *ale-nickel-options*
=============================================================================== ===============================================================================
nickel_format *ale-nickel-nickel-format* nickel_format *ale-nickel-nickel-format*
g:ale_nickel_nickel_format_executable *g:ale_nickel_nickel_format_executable* *ale-options.nickel_nickel_format_executable*
*b:ale_nickel_nickel_format_executable* *g:ale_nickel_nickel_format_executable*
*b:ale_nickel_nickel_format_executable*
nickel_nickel_format_executable
g:ale_nickel_nickel_format_executable
Type: |String| Type: |String|
Default: `'nickel'` Default: `'nickel'`
This option can be changed to change the path for `nickel`. This option can be changed to change the path for `nickel`.
*ale-options.nickel_nickel_format_options*
g:ale_nickel_nickel_format_options *g:ale_nickel_nickel_format_options* *g:ale_nickel_nickel_format_options*
*b:ale_nickel_nickel_format_options* *b:ale_nickel_nickel_format_options*
nickel_nickel_format_options
g:ale_nickel_nickel_format_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+12 -6
View File
@@ -12,8 +12,10 @@ nimcheck *ale-nim-nimcheck*
=============================================================================== ===============================================================================
nimlsp *ale-nim-nimlsp* nimlsp *ale-nim-nimlsp*
g:nim_nimlsp_nim_sources *g:nim_nimlsp_nim_sources* *ale-options.nim_nimlsp_nim_sources*
*g:ale_nim_nimlsp_nim_sources*
*b:ale_nim_nimlsp_nim_sources*
g:ale_nim_nimlsp_nim_sources
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -24,17 +26,21 @@ g:nim_nimlsp_nim_sources *g:nim_nimlsp_nim_sources*
=============================================================================== ===============================================================================
nimpretty *ale-nim-nimpretty* nimpretty *ale-nim-nimpretty*
*ale-options.nim_nimpretty_executable*
g:ale_nim_nimpretty_executable *g:ale_nim_nimpretty_executable* *g:ale_nim_nimpretty_executable*
*b:ale_nim_nimpretty_executable* *b:ale_nim_nimpretty_executable*
nim_nimpretty_executable
g:ale_nim_nimpretty_executable
Type: |String| Type: |String|
Default: `'nimpretty'` Default: `'nimpretty'`
This variable can be changed to use a different executable for nimpretty. This variable can be changed to use a different executable for nimpretty.
*ale-options.nim_nimpretty_options*
g:ale_nim_nimpretty_options *g:ale_nim_nimpretty_options* *g:ale_nim_nimpretty_options*
*b:ale_nim_nimpretty_options* *b:ale_nim_nimpretty_options*
nim_nimpretty_options
g:ale_nim_nimpretty_options
Type: |String| Type: |String|
Default: `'--maxLineLen:80'` Default: `'--maxLineLen:80'`
+48 -12
View File
@@ -5,15 +5,21 @@ ALE Nix Integration *ale-nix-options*
=============================================================================== ===============================================================================
alejandra *ale-nix-alejandra* alejandra *ale-nix-alejandra*
g:ale_nix_alejandra_executable *g:ale_nix_alejandra_executable* *ale-options.nix_alejandra_executable*
*g:ale_nix_alejandra_executable*
*b:ale_nix_alejandra_executable* *b:ale_nix_alejandra_executable*
nix_alejandra_executable
g:ale_nix_alejandra_executable
Type: |String| Type: |String|
Default: `'alejandra'` Default: `'alejandra'`
This variable sets the executable used for alejandra. This variable sets the executable used for alejandra.
g:ale_nix_alejandra_options *g:ale_nix_alejandra_options* *ale-options.nix_alejandra_options*
*g:ale_nix_alejandra_options*
*b:ale_nix_alejandra_options* *b:ale_nix_alejandra_options*
nix_alejandra_options
g:ale_nix_alejandra_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -23,15 +29,21 @@ g:ale_nix_alejandra_options *g:ale_nix_alejandra_options*
=============================================================================== ===============================================================================
nixfmt *ale-nix-nixfmt* nixfmt *ale-nix-nixfmt*
g:ale_nix_nixfmt_executable *g:ale_nix_nixfmt_executable* *ale-options.nix_nixfmt_executable*
*g:ale_nix_nixfmt_executable*
*b:ale_nix_nixfmt_executable* *b:ale_nix_nixfmt_executable*
nix_nixfmt_executable
g:ale_nix_nixfmt_executable
Type: |String| Type: |String|
Default: `'nixfmt'` Default: `'nixfmt'`
This variable sets the executable used for nixfmt. This variable sets the executable used for nixfmt.
g:ale_nix_nixfmt_options *g:ale_nix_nixfmt_options* *ale-options.nix_nixfmt_options*
*g:ale_nix_nixfmt_options*
*b:ale_nix_nixfmt_options* *b:ale_nix_nixfmt_options*
nix_nixfmt_options
g:ale_nix_nixfmt_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -41,15 +53,21 @@ g:ale_nix_nixfmt_options *g:ale_nix_nixfmt_options*
=============================================================================== ===============================================================================
nixpkgs-fmt *ale-nix-nixpkgs-fmt* nixpkgs-fmt *ale-nix-nixpkgs-fmt*
g:ale_nix_nixpkgsfmt_executable *g:ale_nix_nixpkgsfmt_executable* *ale-options.nix_nixpkgsfmt_executable*
*g:ale_nix_nixpkgsfmt_executable*
*b:ale_nix_nixpkgsfmt_executable* *b:ale_nix_nixpkgsfmt_executable*
nix_nixpkgsfmt_executable
g:ale_nix_nixpkgsfmt_executable
Type: |String| Type: |String|
Default: `'nixpkgs-fmt'` Default: `'nixpkgs-fmt'`
This variable sets executable used for nixpkgs-fmt. This variable sets executable used for nixpkgs-fmt.
g:ale_nix_nixpkgsfmt_options *g:ale_nix_nixpkgsfmt_options* *ale-options.nix_nixpkgsfmt_options*
*g:ale_nix_nixpkgsfmt_options*
*b:ale_nix_nixpkgsfmt_options* *b:ale_nix_nixpkgsfmt_options*
nix_nixpkgsfmt_options
g:ale_nix_nixpkgsfmt_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -60,32 +78,44 @@ g:ale_nix_nixpkgsfmt_options *g:ale_nix_nixpkgsfmt_options*
=============================================================================== ===============================================================================
statix *ale-nix-statix* statix *ale-nix-statix*
g:ale_nix_statix_check_executable *g:ale_nix_statix_check_executable* *ale-options.nix_statix_check_executable*
*g:ale_nix_statix_check_executable*
*b:ale_nix_statix_check_executable* *b:ale_nix_statix_check_executable*
nix_statix_check_executable
g:ale_nix_statix_check_executable
Type: |String| Type: |String|
Default: `'statix'` Default: `'statix'`
This variable sets the executable used for statix when running it as a This variable sets the executable used for statix when running it as a
linter. linter.
g:ale_nix_statix_check_options *g:ale_nix_statix_check_options* *ale-options.nix_statix_check_options*
*g:ale_nix_statix_check_options*
*b:ale_nix_statix_check_options* *b:ale_nix_statix_check_options*
nix_statix_check_options
g:ale_nix_statix_check_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be used to pass additional options to statix when running This variable can be used to pass additional options to statix when running
it as a linter. it as a linter.
g:ale_nix_statix_fix_executable *g:ale_nix_fix_check_executable* *ale-options.nix_statix_fix_executable*
*g:ale_nix_statix_fix_executable*
*b:ale_nix_fix_check_executable* *b:ale_nix_fix_check_executable*
nix_statix_fix_executable
g:ale_nix_statix_fix_executable
Type: |String| Type: |String|
Default: `'statix'` Default: `'statix'`
This variable sets the executable used for statix when running it as a This variable sets the executable used for statix when running it as a
fixer. fixer.
g:ale_nix_statix_fix_options *g:ale_nix_statix_fix_options* *ale-options.nix_statix_fix_options*
*g:ale_nix_statix_fix_options*
*b:ale_nix_statix_fix_options* *b:ale_nix_statix_fix_options*
nix_statix_fix_options
g:ale_nix_statix_fix_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -96,15 +126,21 @@ g:ale_nix_statix_fix_options *g:ale_nix_statix_fix_options*
=============================================================================== ===============================================================================
deadnix *ale-nix-deadnix* deadnix *ale-nix-deadnix*
g:ale_nix_deadnix_executable *g:ale_nix_deadnix_executable* *ale-options.nix_deadnix_executable*
*g:ale_nix_deadnix_executable*
*b:ale_nix_deadnix_executable* *b:ale_nix_deadnix_executable*
nix_deadnix_executable
g:ale_nix_deadnix_executable
Type: |String| Type: |String|
Default: `'deadnix'` Default: `'deadnix'`
This variable sets the executable used for deadnix. This variable sets the executable used for deadnix.
g:ale_nix_deadnix_options *g:ale_nix_deadnix_options* *ale-options.nix_deadnix_options*
*g:ale_nix_deadnix_options*
*b:ale_nix_deadnix_options* *b:ale_nix_deadnix_options*
nix_deadnix_options
g:ale_nix_deadnix_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+29 -15
View File
@@ -5,29 +5,35 @@ ALE Objective-C Integration *ale-objc-options*
=============================================================================== ===============================================================================
ccls *ale-objc-ccls* ccls *ale-objc-ccls*
g:ale_objc_ccls_executable *g:ale_objc_ccls_executable* *ale-options.objc_ccls_executable*
*g:ale_objc_ccls_executable*
*b:ale_objc_ccls_executable* *b:ale_objc_ccls_executable*
objc_ccls_executable
g:ale_objc_ccls_executable
Type: |String| Type: |String|
Default: `'ccls'` Default: `'ccls'`
This variable can be changed to use a different executable for ccls. This variable can be changed to use a different executable for ccls.
*ale-options.objc_ccls_init_options*
g:ale_objc_ccls_init_options *g:ale_objc_ccls_init_options* *g:ale_objc_ccls_init_options*
*b:ale_objc_ccls_init_options* *b:ale_objc_ccls_init_options*
objc_ccls_init_options
g:ale_objc_ccls_init_options
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
This variable can be changed to customize ccls initialization options. This variable can be changed to customize ccls initialization options.
Example: > Example: >
{
\ 'cacheDirectory': '/tmp/ccls', let g:ale_objc_ccls_init_options = {
\ 'cacheFormat': 'binary', \ 'cacheDirectory': '/tmp/ccls',
\ 'diagnostics': { \ 'cacheFormat': 'binary',
\ 'onOpen': 0, \ 'diagnostics': {
\ 'opChange': 1000, \ 'onOpen': 0,
\ }, \ 'opChange': 1000,
\ } \ },
\}
< <
Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
available options and explanations. available options and explanations.
@@ -36,8 +42,11 @@ g:ale_objc_ccls_init_options *g:ale_objc_ccls_init_options*
=============================================================================== ===============================================================================
clang *ale-objc-clang* clang *ale-objc-clang*
g:ale_objc_clang_options *g:ale_objc_clang_options* *ale-options.objc_clang_options*
*g:ale_objc_clang_options*
*b:ale_objc_clang_options* *b:ale_objc_clang_options*
objc_clang_options
g:ale_objc_clang_options
Type: |String| Type: |String|
Default: `'-std=c11 -Wall'` Default: `'-std=c11 -Wall'`
@@ -54,16 +63,21 @@ Note that the C options are also used for Objective-C.
=============================================================================== ===============================================================================
clangd *ale-objc-clangd* clangd *ale-objc-clangd*
g:ale_objc_clangd_executable *g:ale_objc_clangd_executable* *ale-options.objc_clangd_executable*
*g:ale_objc_clangd_executable*
*b:ale_objc_clangd_executable* *b:ale_objc_clangd_executable*
objc_clangd_executable
g:ale_objc_clangd_executable
Type: |String| Type: |String|
Default: `'clangd'` Default: `'clangd'`
This variable can be changed to use a different executable for clangd. This variable can be changed to use a different executable for clangd.
*ale-options.objc_clangd_options*
g:ale_objc_clangd_options *g:ale_objc_clangd_options* *g:ale_objc_clangd_options*
*b:ale_objc_clangd_options* *b:ale_objc_clangd_options*
objc_clangd_options
g:ale_objc_clangd_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+12 -4
View File
@@ -5,8 +5,11 @@ ALE Objective-C++ Integration *ale-objcpp-options*
=============================================================================== ===============================================================================
clang *ale-objcpp-clang* clang *ale-objcpp-clang*
g:ale_objcpp_clang_options *g:ale_objcpp_clang_options* *ale-options.objcpp_clang_options*
*g:ale_objcpp_clang_options*
*b:ale_objcpp_clang_options* *b:ale_objcpp_clang_options*
objcpp_clang_options
g:ale_objcpp_clang_options
Type: |String| Type: |String|
Default: `'-std=c++14 -Wall'` Default: `'-std=c++14 -Wall'`
@@ -16,16 +19,21 @@ g:ale_objcpp_clang_options *g:ale_objcpp_clang_options*
=============================================================================== ===============================================================================
clangd *ale-objcpp-clangd* clangd *ale-objcpp-clangd*
g:ale_objcpp_clangd_executable *g:ale_objcpp_clangd_executable* *ale-options.objcpp_clangd_executable*
*g:ale_objcpp_clangd_executable*
*b:ale_objcpp_clangd_executable* *b:ale_objcpp_clangd_executable*
objcpp_clangd_executable
g:ale_objcpp_clangd_executable
Type: |String| Type: |String|
Default: `'clangd'` Default: `'clangd'`
This variable can be changed to use a different executable for clangd. This variable can be changed to use a different executable for clangd.
*ale-options.objcpp_clangd_options*
g:ale_objcpp_clangd_options *g:ale_objcpp_clangd_options* *g:ale_objcpp_clangd_options*
*b:ale_objcpp_clangd_options* *b:ale_objcpp_clangd_options*
objcpp_clangd_options
g:ale_objcpp_clangd_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+44 -10
View File
@@ -8,20 +8,27 @@ dune *ale-ocaml-dune*
Dune is a build system for OCaml projects. The `dune format` command is Dune is a build system for OCaml projects. The `dune format` command is
supported for automatically formatting `dune` and `dune-project` files. supported for automatically formatting `dune` and `dune-project` files.
g:ale_ocaml_dune_executable *g:ale_ocaml_dune_executable* *ale-options.ocaml_dune_executable*
*g:ale_ocaml_dune_executable*
*b:ale_ocaml_dune_executable* *b:ale_ocaml_dune_executable*
ocaml_dune_executable
g:ale_ocaml_dune_executable
Type: |String| Type: |String|
Default: `'dune'` Default: `'dune'`
This variable can be set to pass the path to dune. This variable can be set to pass the path to dune.
g:ale_ocaml_dune_options *g:ale_ocaml_dune_options* *ale-options.ocaml_dune_options*
*g:ale_ocaml_dune_options*
*b:ale_ocaml_dune_options* *b:ale_ocaml_dune_options*
ocaml_dune_options
g:ale_ocaml_dune_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to the dune fixer. This variable can be set to pass additional options to the dune fixer.
=============================================================================== ===============================================================================
merlin *ale-ocaml-merlin* merlin *ale-ocaml-merlin*
@@ -30,6 +37,7 @@ merlin *ale-ocaml-merlin*
detailed instructions detailed instructions
(https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch). (https://github.com/the-lambda-church/merlin/wiki/vim-from-scratch).
=============================================================================== ===============================================================================
ocamllsp *ale-ocaml-ocamllsp* ocamllsp *ale-ocaml-ocamllsp*
@@ -37,8 +45,11 @@ ocamllsp *ale-ocaml-ocamllsp*
Server Protocol. See the installation instructions: Server Protocol. See the installation instructions:
https://github.com/ocaml/ocaml-lsp#installation https://github.com/ocaml/ocaml-lsp#installation
g:ale_ocaml_ocamllsp_use_opam *g:ale_ocaml_ocamllsp_use_opam* *ale-options.ocaml_ocamllsp_use_opam*
*g:ale_ocaml_ocamllsp_use_opam*
*b:ale_ocaml_ocamllsp_use_opam* *b:ale_ocaml_ocamllsp_use_opam*
ocaml_ocamllsp_use_opam
g:ale_ocaml_ocamllsp_use_opam
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_ocaml_ocamllsp_use_opam', 1)` Default: `get(g:, 'ale_ocaml_ocamllsp_use_opam', 1)`
@@ -53,57 +64,80 @@ ols *ale-ocaml-ols*
instructions: instructions:
https://github.com/freebroccolo/ocaml-language-server#installation https://github.com/freebroccolo/ocaml-language-server#installation
g:ale_ocaml_ols_executable *g:ale_ocaml_ols_executable* *ale-options.ocaml_ols_executable*
*g:ale_ocaml_ols_executable*
*b:ale_ocaml_ols_executable* *b:ale_ocaml_ols_executable*
ocaml_ols_executable
g:ale_ocaml_ols_executable
Type: |String| Type: |String|
Default: `'ocaml-language-server'` Default: `'ocaml-language-server'`
This variable can be set to change the executable path for `ols`. This variable can be set to change the executable path for `ols`.
g:ale_ocaml_ols_use_global *g:ale_ocaml_ols_use_global* *ale-options.ocaml_ols_use_global*
*g:ale_ocaml_ols_use_global*
*b:ale_ocaml_ols_use_global* *b:ale_ocaml_ols_use_global*
ocaml_ols_use_global
g:ale_ocaml_ols_use_global
Type: |String| Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
This variable can be set to `1` to always use the globally installed This variable can be set to `1` to always use the globally installed
executable. See also |ale-integrations-local-executables|. executable. See also |ale-integrations-local-executables|.
=============================================================================== ===============================================================================
ocamlformat *ale-ocaml-ocamlformat* ocamlformat *ale-ocaml-ocamlformat*
g:ale_ocaml_ocamlformat_executable *g:ale_ocaml_ocamlformat_executable* *ale-options.ocaml_ocamlformat_executable*
*g:ale_ocaml_ocamlformat_executable*
*b:ale_ocaml_ocamlformat_executable* *b:ale_ocaml_ocamlformat_executable*
ocaml_ocamlformat_executable
g:ale_ocaml_ocamlformat_executable
Type: |String| Type: |String|
Default: `'ocamlformat'` Default: `'ocamlformat'`
This variable can be set to pass the path of the ocamlformat fixer. This variable can be set to pass the path of the ocamlformat fixer.
g:ale_ocaml_ocamlformat_options *g:ale_ocaml_ocamlformat_options* *ale-options.ocaml_ocamlformat_options*
*g:ale_ocaml_ocamlformat_options*
*b:ale_ocaml_ocamlformat_options* *b:ale_ocaml_ocamlformat_options*
ocaml_ocamlformat_options
g:ale_ocaml_ocamlformat_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to the ocamlformat fixer. This variable can be set to pass additional options to the ocamlformat fixer.
=============================================================================== ===============================================================================
ocp-indent *ale-ocaml-ocp-indent* ocp-indent *ale-ocaml-ocp-indent*
g:ale_ocaml_ocp_indent_executable *g:ale_ocaml_ocp_indent_executable* *ale-options.ocaml_ocp_indent_executable*
*g:ale_ocaml_ocp_indent_executable*
*b:ale_ocaml_ocp_indent_executable* *b:ale_ocaml_ocp_indent_executable*
ocaml_ocp_indent_executable
g:ale_ocaml_ocp_indent_executable
Type: |String| Type: |String|
Default: `ocp-indent` Default: `ocp-indent`
This variable can be set to pass the path of the ocp-indent. This variable can be set to pass the path of the ocp-indent.
g:ale_ocaml_ocp_indent_options *g:ale_ocaml_ocp_indent_options* *ale-options.ocaml_ocp_indent_options*
*g:ale_ocaml_ocp_indent_options*
*b:ale_ocaml_ocp_indent_options* *b:ale_ocaml_ocp_indent_options*
ocaml_ocp_indent_options
g:ale_ocaml_ocp_indent_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to the ocp-indent. This variable can be set to pass additional options to the ocp-indent.
g:ale_ocaml_ocp_indent_config *g:ale_ocaml_ocp_indent_config* *ale-options.ocaml_ocp_indent_config*
*g:ale_ocaml_ocp_indent_config*
*b:ale_ocaml_ocp_indent_config* *b:ale_ocaml_ocp_indent_config*
ocaml_ocp_indent_config
g:ale_ocaml_ocp_indent_config
Type: |String| Type: |String|
Default: `''` Default: `''`
+9 -8
View File
@@ -2,28 +2,29 @@
ALE Odin Integration *ale-odin-options* ALE Odin Integration *ale-odin-options*
*ale-integration-odin* *ale-integration-odin*
===============================================================================
Integration Information
Currently, the only supported linter for Odin is ols.
=============================================================================== ===============================================================================
ols *ale-odin-ols* ols *ale-odin-ols*
g:ale_odin_ols_executable *g:ale_odin_ols_executable* *ale-options.odin_ols_executable*
*g:ale_odin_ols_executable*
*b:ale_odin_ols_executable* *b:ale_odin_ols_executable*
odin_ols_executable
g:ale_odin_ols_executable
Type: |String| Type: |String|
Default: `'ols'` Default: `'ols'`
This variable can be modified to change the executable path for `ols`. This variable can be modified to change the executable path for `ols`.
*ale-options.odin_ols_config*
g:ale_odin_ols_config *g:ale_odin_ols_config* *g:ale_odin_ols_config*
*b:ale_odin_ols_config* *b:ale_odin_ols_config*
odin_ols_config
g:ale_odin_ols_config
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
Dictionary with configuration settings for ols. Dictionary with configuration settings for ols.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+14 -7
View File
@@ -1,22 +1,24 @@
=============================================================================== ===============================================================================
ALE OpenApi Integration *ale-openapi-options* ALE OpenApi Integration *ale-openapi-options*
=============================================================================== ===============================================================================
ibm_validator *ale-openapi-ibm-validator* ibm_validator *ale-openapi-ibm-validator*
Website: https://github.com/IBM/openapi-validator Website: https://github.com/IBM/openapi-validator
Installation
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Installation
Install ibm-openapi-validator either globally or locally: > Install ibm-openapi-validator either globally or locally: >
npm install ibm-openapi-validator -g # global npm install ibm-openapi-validator -g # global
npm install ibm-openapi-validator # local npm install ibm-openapi-validator # local
< <
Configuration
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Configuration
OpenAPI files can be written in YAML or JSON so in order for ALE plugins to OpenAPI files can be written in YAML or JSON so in order for ALE plugins to
work with these files we must set the buffer |filetype| to either |openapi.yaml| work with these files we must set the buffer |filetype| to either |openapi.yaml|
@@ -39,19 +41,24 @@ filetype to |openapi.yaml| or |openapi.json|:
https://github.com/hsanson/vim-openapi https://github.com/hsanson/vim-openapi
Options
-------------------------------------------------------------------------------
g:ale_openapi_ibm_validator_executable *g:ale_openapi_ibm_validator_executable* -------------------------------------------------------------------------------
Options
*ale-options.openapi_ibm_validator_executable*
*g:ale_openapi_ibm_validator_executable*
*b:ale_openapi_ibm_validator_executable* *b:ale_openapi_ibm_validator_executable*
openapi_ibm_validator_executable
g:ale_openapi_ibm_validator_executable
Type: |String| Type: |String|
Default: `'lint-openapi'` Default: `'lint-openapi'`
This variable can be set to change the path to lint-openapi. This variable can be set to change the path to lint-openapi.
*ale-options.openapi_ibm_validator_options*
g:ale_openapi_ibm_validator_options *g:ale_openapi_ibm_validator_options* *g:ale_openapi_ibm_validator_options*
*b:ale_openapi_ibm_validator_options* *b:ale_openapi_ibm_validator_options*
openapi_ibm_validator_options
g:ale_openapi_ibm_validator_options
Type: |String| Type: |String|
Default: `''` Default: `''`
+17 -6
View File
@@ -5,16 +5,21 @@ ALE OpenSCAD Integration *ale-openscad-options*
=============================================================================== ===============================================================================
sca2d *ale-openscad-sca2d* sca2d *ale-openscad-sca2d*
g:ale_openscad_sca2d_executable *g:ale_openscad_sca2d_executable* *ale-options.openscad_sca2d_executable*
*g:ale_openscad_sca2d_executable*
*b:ale_openscad_sca2d_executable* *b:ale_openscad_sca2d_executable*
openscad_sca2d_executable
g:ale_openscad_sca2d_executable
Type: |String| Type: |String|
Default: `'sca2d'` Default: `'sca2d'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.openscad_sca2d_options*
g:ale_openscad_sca2d_options *g:ale_openscad_sca2d_options* *g:ale_openscad_sca2d_options*
*b:ale_openscad_sca2d_options* *b:ale_openscad_sca2d_options*
openscad_sca2d_options
g:ale_openscad_sca2d_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -24,20 +29,26 @@ g:ale_openscad_sca2d_options *g:ale_openscad_sca2d_options*
=============================================================================== ===============================================================================
scadformat *ale-openscad-scadformat* scadformat *ale-openscad-scadformat*
g:ale_openscad_scadformat_executable *g:ale_openscad_scadformat_executable* *ale-options.openscad_scadformat_executable*
*g:ale_openscad_scadformat_executable*
*b:ale_openscad_scadformat_executable* *b:ale_openscad_scadformat_executable*
openscad_scadformat_executable
g:ale_openscad_scadformat_executable
Type: |String| Type: |String|
Default: `'scadformat'` Default: `'scadformat'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.openscad_scadformat_options*
g:ale_openscad_scadformat_options *g:ale_openscad_scadformat_options* *g:ale_openscad_scadformat_options*
*b:ale_openscad_scadformat_options* *b:ale_openscad_scadformat_options*
openscad_scadformat_options
g:ale_openscad_scadformat_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass options to scadformat. This variable can be set to pass options to scadformat.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+10 -4
View File
@@ -5,20 +5,26 @@ ALE Packer Integration *ale-packer-options*
=============================================================================== ===============================================================================
packer-fmt-fixer *ale-packer-fmt-fixer* packer-fmt-fixer *ale-packer-fmt-fixer*
g:ale_packer_fmt_executable *g:ale_packer_fmt_executable* *ale-options.packer_fmt_executable*
*g:ale_packer_fmt_executable*
*b:ale_packer_fmt_executable* *b:ale_packer_fmt_executable*
packer_fmt_executable
g:ale_packer_fmt_executable
Type: |String| Type: |String|
Default: `'packer'` Default: `'packer'`
This variable can be changed to use a different executable for packer. This variable can be changed to use a different executable for packer.
*ale-options.packer_fmt_options*
g:ale_packer_fmt_options *g:ale_packer_fmt_options* *g:ale_packer_fmt_options*
*b:ale_packer_fmt_options* *b:ale_packer_fmt_options*
packer_fmt_options
g:ale_packer_fmt_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to change command lines options for `packer fmt`
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+10 -4
View File
@@ -1,23 +1,29 @@
=============================================================================== ===============================================================================
ALE Pascal Integration *ale-pascal-options* ALE Pascal Integration *ale-pascal-options*
=============================================================================== ===============================================================================
ptop *ale-pascal-ptop* ptop *ale-pascal-ptop*
g:ale_pascal_ptop_executable *g:ale_pascal_ptop_executable* *ale-options.pascal_ptop_executable*
*g:ale_pascal_ptop_executable*
*b:ale_pascal_ptop_executable* *b:ale_pascal_ptop_executable*
pascal_ptop_executable
g:ale_pascal_ptop_executable
Type: |String| Type: |String|
Default: `'ptop'` Default: `'ptop'`
This variable can be changed to specify the ptop executable. This variable can be changed to specify the ptop executable.
*ale-options.pascal_ptop_options*
g:ale_pascal_ptop_options *g:ale_pascal_ptop_options* *g:ale_pascal_ptop_options*
*b:ale_pascal_ptop_options* *b:ale_pascal_ptop_options*
pascal_ptop_options
g:ale_pascal_ptop_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to the ptop fixer. This variable can be set to pass additional options to the ptop fixer.
=============================================================================== ===============================================================================
+34 -15
View File
@@ -13,16 +13,21 @@ See |g:ale_linters|.
=============================================================================== ===============================================================================
perl *ale-perl-perl* perl *ale-perl-perl*
g:ale_perl_perl_executable *g:ale_perl_perl_executable* *ale-options.perl_perl_executable*
*g:ale_perl_perl_executable*
*b:ale_perl_perl_executable* *b:ale_perl_perl_executable*
perl_perl_executable
g:ale_perl_perl_executable
Type: |String| Type: |String|
Default: `'perl'` Default: `'perl'`
This variable can be changed to modify the executable used for linting perl. This variable can be changed to modify the executable used for linting perl.
*ale-options.perl_perl_options*
g:ale_perl_perl_options *g:ale_perl_perl_options* *g:ale_perl_perl_options*
*b:ale_perl_perl_options* *b:ale_perl_perl_options*
perl_perl_options
g:ale_perl_perl_options
Type: |String| Type: |String|
Default: `'-c -Mwarnings -Ilib'` Default: `'-c -Mwarnings -Ilib'`
@@ -33,17 +38,22 @@ g:ale_perl_perl_options *g:ale_perl_perl_options*
=============================================================================== ===============================================================================
perlcritic *ale-perl-perlcritic* perlcritic *ale-perl-perlcritic*
g:ale_perl_perlcritic_executable *g:ale_perl_perlcritic_executable* *ale-options.perl_perlcritic_executable*
*b:ale_perl_perlcritic_executable* *g:ale_perl_perlcritic_executable*
*b:ale_perl_perlcritic_executable*
perl_perlcritic_executable
g:ale_perl_perlcritic_executable
Type: |String| Type: |String|
Default: `'perlcritic'` Default: `'perlcritic'`
This variable can be changed to modify the perlcritic executable used for This variable can be changed to modify the perlcritic executable used for
linting perl. linting perl.
*ale-options.perl_perlcritic_profile*
g:ale_perl_perlcritic_profile *g:ale_perl_perlcritic_profile* *g:ale_perl_perlcritic_profile*
*b:ale_perl_perlcritic_profile* *b:ale_perl_perlcritic_profile*
perl_perlcritic_profile
g:ale_perl_perlcritic_profile
Type: |String| Type: |String|
Default: `'.perlcriticrc'` Default: `'.perlcriticrc'`
@@ -59,33 +69,42 @@ g:ale_perl_perlcritic_profile *g:ale_perl_perlcritic_profile*
string and pass `'--no-profile'`to perlcritic via the string and pass `'--no-profile'`to perlcritic via the
|g:ale_perl_perlcritic_options| variable. |g:ale_perl_perlcritic_options| variable.
*ale-options.perl_perlcritic_options*
g:ale_perl_perlcritic_options *g:ale_perl_perlcritic_options* *g:ale_perl_perlcritic_options*
*b:ale_perl_perlcritic_options* *b:ale_perl_perlcritic_options*
perl_perlcritic_options
g:ale_perl_perlcritic_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to supply additional command-line arguments to This variable can be changed to supply additional command-line arguments to
the perlcritic invocation. the perlcritic invocation.
*ale-options.perl_perlcritic_showrules*
g:ale_perl_perlcritic_showrules *g:ale_perl_perlcritic_showrules* *g:ale_perl_perlcritic_showrules*
perl_perlcritic_showrules
g:ale_perl_perlcritic_showrules
Type: |Number| Type: |Number|
Default: `0` Default: `0`
Controls whether perlcritic rule names are shown after the error message. Controls whether perlcritic rule names are shown after the error message.
Defaults to off to reduce length of message. Defaults to off to reduce length of message.
=============================================================================== ===============================================================================
perltidy *ale-perl-perltidy* perltidy *ale-perl-perltidy*
g:ale_perl_perltidy_options *g:ale_perl_perltidy_options* *ale-options.perl_perltidy_options*
*g:ale_perl_perltidy_options*
*b:ale_perl_perltidy_options* *b:ale_perl_perltidy_options*
perl_perltidy_options
g:ale_perl_perltidy_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be changed to alter the command-line arguments to This variable can be changed to alter the command-line arguments to
the perltidy invocation. the perltidy invocation.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+9 -3
View File
@@ -22,22 +22,28 @@ See |g:ale_linters|.
=============================================================================== ===============================================================================
perl6 *ale-perl6-perl6* perl6 *ale-perl6-perl6*
g:ale_perl6_perl6_executable *g:ale_perl6_perl6_executable* *ale-options.perl6_perl6_executable*
*g:ale_perl6_perl6_executable*
*b:ale_perl6_perl6_executable* *b:ale_perl6_perl6_executable*
perl6_perl6_executable
g:ale_perl6_perl6_executable
Type: |String| Type: |String|
Default: `'perl6'` Default: `'perl6'`
This variable can be changed to modify the executable used for linting This variable can be changed to modify the executable used for linting
perl6. perl6.
*ale-options.perl6_perl6_options*
g:ale_perl6_perl6_options *g:ale_perl6_perl6_options* *g:ale_perl6_perl6_options*
*b:ale_perl6_perl6_options* *b:ale_perl6_perl6_options*
perl6_perl6_options
g:ale_perl6_perl6_options
Type: |String| Type: |String|
Default: `'-c -Ilib'` Default: `'-c -Ilib'`
This variable can be changed to alter the command-line arguments to the This variable can be changed to alter the command-line arguments to the
perl6 invocation. perl6 invocation.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+144 -60
View File
@@ -11,8 +11,11 @@ See |ale-cspell-options|
=============================================================================== ===============================================================================
langserver *ale-php-langserver* langserver *ale-php-langserver*
g:ale_php_langserver_executable *g:ale_php_langserver_executable* *ale-options.php_langserver_executable*
*g:ale_php_langserver_executable*
*b:ale_php_langserver_executable* *b:ale_php_langserver_executable*
php_langserver_executable
g:ale_php_langserver_executable
Type: |String| Type: |String|
Default: `'php-language-server.php'` Default: `'php-language-server.php'`
@@ -22,9 +25,11 @@ g:ale_php_langserver_executable *g:ale_php_langserver_executable*
See: |ale-integrations-local-executables| See: |ale-integrations-local-executables|
*ale-options.php_langserver_use_global*
g:ale_php_langserver_use_global *g:ale_php_langserver_use_global* *g:ale_php_langserver_use_global*
*b:ale_php_langserver_use_global* *b:ale_php_langserver_use_global*
php_langserver_use_global
g:ale_php_langserver_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -41,24 +46,31 @@ WARNING: please use the phan_client linter if you have an configuration file
for your project because the phan will look into your entirely project and for your project because the phan will look into your entirely project and
ale will display in the current buffer warnings that may belong to other file. ale will display in the current buffer warnings that may belong to other file.
g:ale_php_phan_minimum_severity *g:ale_php_phan_minimum_severity* *ale-options.php_phan_minimum_severity*
*g:ale_php_phan_minimum_severity*
*b:ale_php_phan_minimum_severity* *b:ale_php_phan_minimum_severity*
php_phan_minimum_severity
g:ale_php_phan_minimum_severity
Type: |Number| Type: |Number|
Default: `0` Default: `0`
This variable defines the minimum severity level. This variable defines the minimum severity level.
*ale-options.php_phan_executable*
g:ale_php_phan_executable *g:ale_php_phan_executable* *g:ale_php_phan_executable*
*b:ale_php_phan_executable* *b:ale_php_phan_executable*
php_phan_executable
g:ale_php_phan_executable
Type: |String| Type: |String|
Default: `'phan'` Default: `'phan'`
This variable sets executable used for phan or phan_client. This variable sets executable used for phan or phan_client.
*ale-options.php_phan_use_client*
g:ale_php_phan_use_client *g:ale_php_phan_use_client* *g:ale_php_phan_use_client*
*b:ale_php_phan_use_client* *b:ale_php_phan_use_client*
php_phan_use_client
g:ale_php_phan_use_client
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_php_phan_use_client', 0)` Default: `get(g:, 'ale_php_phan_use_client', 0)`
@@ -69,16 +81,21 @@ g:ale_php_phan_use_client *g:ale_php_phan_use_client*
=============================================================================== ===============================================================================
phpcbf *ale-php-phpcbf* phpcbf *ale-php-phpcbf*
g:ale_php_phpcbf_executable *g:ale_php_phpcbf_executable* *ale-options.php_phpcbf_executable*
*g:ale_php_phpcbf_executable*
*b:ale_php_phpcbf_executable* *b:ale_php_phpcbf_executable*
php_phpcbf_executable
g:ale_php_phpcbf_executable
Type: |String| Type: |String|
Default: `'phpcbf'` Default: `'phpcbf'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.php_phpcbf_standard*
g:ale_php_phpcbf_standard *g:ale_php_phpcbf_standard* *g:ale_php_phpcbf_standard*
*b:ale_php_phpcbf_standard* *b:ale_php_phpcbf_standard*
php_phpcbf_standard
g:ale_php_phpcbf_standard
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -86,17 +103,21 @@ g:ale_php_phpcbf_standard *g:ale_php_phpcbf_standard*
coding standard is specified, phpcbf will default to fixing against the coding standard is specified, phpcbf will default to fixing against the
PEAR coding standard, or the standard you have set as the default. PEAR coding standard, or the standard you have set as the default.
*ale-options.php_phpcbf_use_global*
g:ale_php_phpcbf_use_global *g:ale_php_phpcbf_use_global* *g:ale_php_phpcbf_use_global*
*b:ale_php_phpcbf_use_global* *b:ale_php_phpcbf_use_global*
php_phpcbf_use_global
g:ale_php_phpcbf_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.php_phpcbf_options*
g:ale_php_phpcbf_options *g:ale_php_phpcbf_options* *g:ale_php_phpcbf_options*
*b:ale_php_phpcbf_options* *b:ale_php_phpcbf_options*
php_phpcbf_options
g:ale_php_phpcbf_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -106,16 +127,21 @@ g:ale_php_phpcbf_options *g:ale_php_phpcbf_options*
=============================================================================== ===============================================================================
phpcs *ale-php-phpcs* phpcs *ale-php-phpcs*
g:ale_php_phpcs_executable *g:ale_php_phpcs_executable* *ale-options.php_phpcs_executable*
*g:ale_php_phpcs_executable*
*b:ale_php_phpcs_executable* *b:ale_php_phpcs_executable*
php_phpcs_executable
g:ale_php_phpcs_executable
Type: |String| Type: |String|
Default: `'phpcs'` Default: `'phpcs'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.php_phpcs_standard*
g:ale_php_phpcs_standard *g:ale_php_phpcs_standard* *g:ale_php_phpcs_standard*
*b:ale_php_phpcs_standard* *b:ale_php_phpcs_standard*
php_phpcs_standard
g:ale_php_phpcs_standard
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -123,17 +149,21 @@ g:ale_php_phpcs_standard *g:ale_php_phpcs_standard*
coding standard is specified, phpcs will default to checking against the coding standard is specified, phpcs will default to checking against the
PEAR coding standard, or the standard you have set as the default. PEAR coding standard, or the standard you have set as the default.
*ale-options.php_phpcs_use_global*
g:ale_php_phpcs_use_global *g:ale_php_phpcs_use_global* *g:ale_php_phpcs_use_global*
*b:ale_php_phpcs_use_global* *b:ale_php_phpcs_use_global*
php_phpcs_use_global
g:ale_php_phpcs_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.php_phpcs_options*
g:ale_php_phpcs_options *g:ale_php_phpcs_options* *g:ale_php_phpcs_options*
*b:ale_php_phpcs_options* *b:ale_php_phpcs_options*
php_phpcs_options
g:ale_php_phpcs_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -143,16 +173,21 @@ g:ale_php_phpcs_options *g:ale_php_phpcs_options*
=============================================================================== ===============================================================================
phpmd *ale-php-phpmd* phpmd *ale-php-phpmd*
g:ale_php_phpmd_executable *g:ale_php_phpmd_executable* *ale-options.php_phpmd_executable*
*g:ale_php_phpmd_executable*
*b:ale_php_phpmd_executable* *b:ale_php_phpmd_executable*
php_phpmd_executable
g:ale_php_phpmd_executable
Type: |String| Type: |String|
Default: `'phpmd'` Default: `'phpmd'`
This variable sets executable used for phpmd. This variable sets executable used for phpmd.
*ale-options.php_phpmd_ruleset*
g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset* *g:ale_php_phpmd_ruleset*
*b:ale_php_phpmd_ruleset* *b:ale_php_phpmd_ruleset*
php_phpmd_ruleset
g:ale_php_phpmd_ruleset
Type: |String| Type: |String|
Default: `'cleancode,codesize,controversial,design,naming,unusedcode'` Default: `'cleancode,codesize,controversial,design,naming,unusedcode'`
@@ -163,16 +198,21 @@ g:ale_php_phpmd_ruleset *g:ale_php_phpmd_ruleset*
=============================================================================== ===============================================================================
phpstan *ale-php-phpstan* phpstan *ale-php-phpstan*
g:ale_php_phpstan_executable *g:ale_php_phpstan_executable* *ale-options.php_phpstan_executable*
*g:ale_php_phpstan_executable*
*b:ale_php_phpstan_executable* *b:ale_php_phpstan_executable*
php_phpstan_executable
g:ale_php_phpstan_executable
Type: |String| Type: |String|
Default: `'phpstan'` Default: `'phpstan'`
This variable sets executable used for phpstan. This variable sets executable used for phpstan.
*ale-options.php_phpstan_level*
g:ale_php_phpstan_level *g:ale_php_phpstan_level* *g:ale_php_phpstan_level*
*b:ale_php_phpstan_level* *b:ale_php_phpstan_level*
php_phpstan_level
g:ale_php_phpstan_level
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -181,25 +221,31 @@ g:ale_php_phpstan_level *g:ale_php_phpstan_level*
the configuration file. If no configuration file can be detected, `'7'` will the configuration file. If no configuration file can be detected, `'7'` will
be used instead. be used instead.
*ale-options.php_phpstan_configuration*
g:ale_php_phpstan_configuration *g:ale_php_phpstan_configuration* *g:ale_php_phpstan_configuration*
*b:ale_php_phpstan_configuration* *b:ale_php_phpstan_configuration*
php_phpstan_configuration
g:ale_php_phpstan_configuration
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable sets path to phpstan configuration file. This variable sets path to phpstan configuration file.
*ale-options.php_phpstan_autoload*
g:ale_php_phpstan_autoload *g:ale_php_phpstan_autoload* *g:ale_php_phpstan_autoload*
*b:ale_php_phpstan_autoload* *b:ale_php_phpstan_autoload*
php_phpstan_autoload
g:ale_php_phpstan_autoload
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable sets path to phpstan autoload file. This variable sets path to phpstan autoload file.
*ale-options.php_phpstan_memory_limit*
g:ale_php_phpstan_memory_limit *g:ale_php_phpstan_memory-limit* *g:ale_php_phpstan_memory_limit*
*b:ale_php_phpstan_memory-limit* *b:ale_php_phpstan_memory-limit*
php_phpstan_memory_limit
g:ale_php_phpstan_memory_limit
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -210,24 +256,31 @@ g:ale_php_phpstan_memory_limit *g:ale_php_phpstan_memory-limit*
=============================================================================== ===============================================================================
psalm *ale-php-psalm* psalm *ale-php-psalm*
g:ale_php_psalm_executable *g:ale_php_psalm_executable* *ale-options.php_psalm_executable*
*g:ale_php_psalm_executable*
*b:ale_php_psalm_executable* *b:ale_php_psalm_executable*
php_psalm_executable
g:ale_php_psalm_executable
Type: |String| Type: |String|
Default: `'psalm'` Default: `'psalm'`
This variable sets the executable used for psalm. This variable sets the executable used for psalm.
*ale-options.php_psalm_options*
g:ale_php_psalm_options *g:ale_php_psalm_options* *g:ale_php_psalm_options*
*b:ale_php_psalm_options* *b:ale_php_psalm_options*
php_psalm_options
g:ale_php_psalm_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to psalm. This variable can be set to pass additional options to psalm.
*ale-options.php_psalm_use_global*
g:ale_php_psalm_use_global *g:ale_php_psalm_use_global* *g:ale_php_psalm_use_global*
*b:ale_php_psalm_use_global* *b:ale_php_psalm_use_global*
php_psalm_use_global
g:ale_php_psalm_use_global
Type: |Boolean| Type: |Boolean|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -237,24 +290,31 @@ g:ale_php_psalm_use_global *g:ale_php_psalm_use_global*
=============================================================================== ===============================================================================
php-cs-fixer *ale-php-php-cs-fixer* php-cs-fixer *ale-php-php-cs-fixer*
g:ale_php_cs_fixer_executable *g:ale_php_cs_fixer_executable* *ale-options.php_cs_fixer_executable*
*g:ale_php_cs_fixer_executable*
*b:ale_php_cs_fixer_executable* *b:ale_php_cs_fixer_executable*
php_cs_fixer_executable
g:ale_php_cs_fixer_executable
Type: |String| Type: |String|
Default: `'php-cs-fixer'` Default: `'php-cs-fixer'`
This variable sets executable used for php-cs-fixer. This variable sets executable used for php-cs-fixer.
*ale-options.php_cs_fixer_options*
g:ale_php_cs_fixer_options *g:ale_php_cs_fixer_options* *g:ale_php_cs_fixer_options*
*b:ale_php_cs_fixer_options* *b:ale_php_cs_fixer_options*
php_cs_fixer_options
g:ale_php_cs_fixer_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to php-cs-fixer. This variable can be set to pass additional options to php-cs-fixer.
*ale-options.php_cs_fixer_use_global*
g:ale_php_cs_fixer_use_global *g:ale_php_cs_fixer_use_global* *g:ale_php_cs_fixer_use_global*
*b:ale_php_cs_fixer_use_global* *b:ale_php_cs_fixer_use_global*
php_cs_fixer_use_global
g:ale_php_cs_fixer_use_global
Type: |Boolean| Type: |Boolean|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -264,8 +324,11 @@ g:ale_php_cs_fixer_use_global *g:ale_php_cs_fixer_use_global*
=============================================================================== ===============================================================================
php *ale-php-php* php *ale-php-php*
g:ale_php_php_executable *g:ale_php_php_executable* *ale-options.php_php_executable*
*g:ale_php_php_executable*
*b:ale_php_php_executable* *b:ale_php_php_executable*
php_php_executable
g:ale_php_php_executable
Type: |String| Type: |String|
Default: `'php'` Default: `'php'`
@@ -275,24 +338,31 @@ g:ale_php_php_executable *g:ale_php_php_executable*
=============================================================================== ===============================================================================
pint *ale-php-pint* pint *ale-php-pint*
g:ale_php_pint_executable *g:ale_php_pint_executable* *ale-options.php_pint_executable*
*g:ale_php_pint_executable*
*b:ale_php_pint_executable* *b:ale_php_pint_executable*
php_pint_executable
g:ale_php_pint_executable
Type: |String| Type: |String|
Default: `'pint'` Default: `'pint'`
This variable sets the executable used for pint. This variable sets the executable used for pint.
*ale-options.php_pint_options*
g:ale_php_pint_options *g:ale_php_pint_options* *g:ale_php_pint_options*
*b:ale_php_pint_options* *b:ale_php_pint_options*
php_pint_options
g:ale_php_pint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to pint. This variable can be set to pass additional options to pint.
*ale-options.php_pint_use_global*
g:ale_php_pint_use_global *g:ale_php_pint_use_global* *g:ale_php_pint_use_global*
*b:ale_php_pint_use_global* *b:ale_php_pint_use_global*
php_pint_use_global
g:ale_php_pint_use_global
Type: |Boolean| Type: |Boolean|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -302,24 +372,31 @@ g:ale_php_pint_use_global *g:ale_php_pint_use_global*
=============================================================================== ===============================================================================
tlint *ale-php-tlint* tlint *ale-php-tlint*
g:ale_php_tlint_executable *g:ale_php_tlint_executable* *ale-options.php_tlint_executable*
*g:ale_php_tlint_executable*
*b:ale_php_tlint_executable* *b:ale_php_tlint_executable*
php_tlint_executable
g:ale_php_tlint_executable
Type: |String| Type: |String|
Default: `'tlint'` Default: `'tlint'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.php_tlint_use_global*
g:ale_php_tlint_use_global *g:ale_php_tlint_use_global* *g:ale_php_tlint_use_global*
*b:ale_php_tlint_use_global* *b:ale_php_tlint_use_global*
php_tlint_use_global
g:ale_php_tlint_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.php_tlint_options*
g:ale_php_tlint_options *g:ale_php_tlint_options* *g:ale_php_tlint_options*
*b:ale_php_tlint_options* *b:ale_php_tlint_options*
php_tlint_options
g:ale_php_tlint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -329,8 +406,11 @@ g:ale_php_tlint_options *g:ale_php_tlint_options*
=============================================================================== ===============================================================================
intelephense *ale-php-intelephense* intelephense *ale-php-intelephense*
g:ale_php_intelephense_executable *g:ale_php_intelephense_executable* *ale-options.php_intelephense_executable*
*g:ale_php_intelephense_executable*
*b:ale_php_intelephense_executable* *b:ale_php_intelephense_executable*
php_intelephense_executable
g:ale_php_intelephense_executable
Type: |String| Type: |String|
Default: `'intelephense'` Default: `'intelephense'`
@@ -341,9 +421,11 @@ g:ale_php_intelephense_executable *g:ale_php_intelephense_executable*
See: |ale-integrations-local-executables| See: |ale-integrations-local-executables|
*ale-options.php_intelephense_use_global*
g:ale_php_intelephense_use_global *g:ale_php_intelephense_use_global* *g:ale_php_intelephense_use_global*
*b:ale_php_intelephense_use_global* *b:ale_php_intelephense_use_global*
php_intelephense_use_global
g:ale_php_intelephense_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -352,9 +434,11 @@ g:ale_php_intelephense_use_global *g:ale_php_intelephense_use_global*
See: |ale-integrations-local-executables| See: |ale-integrations-local-executables|
*ale-options.php_intelephense_config*
g:ale_php_intelephense_config *g:ale_php_intelephense_config* *g:ale_php_intelephense_config*
*b:ale_php_intelephense_config* *b:ale_php_intelephense_config*
php_intelephense_config
g:ale_php_intelephense_config
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
+8 -3
View File
@@ -5,16 +5,21 @@ ALE Pony Integration *ale-pony-options*
=============================================================================== ===============================================================================
ponyc *ale-pony-ponyc* ponyc *ale-pony-ponyc*
g:ale_pony_ponyc_executable *g:ale_pony_ponyc_executable* *ale-options.pony_ponyc_executable*
*g:ale_pony_ponyc_executable*
*b:ale_pony_ponyc_executable* *b:ale_pony_ponyc_executable*
pony_ponyc_executable
g:ale_pony_ponyc_executable
Type: |String| Type: |String|
Default: `'ponyc'` Default: `'ponyc'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.pony_ponyc_options*
g:ale_pony_ponyc_options *g:ale_pony_ponyc_options* *g:ale_pony_ponyc_options*
*b:ale_pony_ponyc_options* *b:ale_pony_ponyc_options*
pony_ponyc_options
g:ale_pony_ponyc_options
Type: |String| Type: |String|
Default: `'--pass paint'` Default: `'--pass paint'`
+23 -12
View File
@@ -11,8 +11,11 @@ See |ale-cspell-options|
=============================================================================== ===============================================================================
powershell *ale-powershell-powershell* powershell *ale-powershell-powershell*
g:ale_powershell_powershell_executable *g:ale_powershell_powershell_executable* *ale-options.powershell_powershell_executable*
*g:ale_powershell_powershell_executable*
*b:ale_powershell_powershell_executable* *b:ale_powershell_powershell_executable*
powershell_powershell_executable
g:ale_powershell_powershell_executable
Type: |String| Type: |String|
Default: `'pwsh'` Default: `'pwsh'`
@@ -26,15 +29,21 @@ g:ale_powershell_powershell_executable *g:ale_powershell_powershell_executable*
=============================================================================== ===============================================================================
psscriptanalyzer *ale-powershell-psscriptanalyzer* psscriptanalyzer *ale-powershell-psscriptanalyzer*
Installation
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
Installation
Install PSScriptAnalyzer by any means, so long as it can be automatically Install PSScriptAnalyzer by any means, so long as it can be automatically
imported in PowerShell. imported in PowerShell.
g:ale_powershell_psscriptanalyzer_executable
*g:ale_powershell_psscriptanalyzer_executable* -------------------------------------------------------------------------------
Options
*ale-options.powershell_psscriptanalyzer_executable*
*g:ale_powershell_psscriptanalyzer_executable*
*b:ale_powershell_psscriptanalyzer_executable* *b:ale_powershell_psscriptanalyzer_executable*
powershell_psscriptanalyzer_executable
g:ale_powershell_psscriptanalyzer_executable
Type: |String| Type: |String|
Default: `'pwsh'` Default: `'pwsh'`
@@ -45,27 +54,29 @@ g:ale_powershell_psscriptanalyzer_executable
let g:ale_powershell_psscriptanalyzer_executable = 'powershell.exe' let g:ale_powershell_psscriptanalyzer_executable = 'powershell.exe'
< <
g:ale_powershell_psscriptanalyzer_module *ale-options.powershell_psscriptanalyzer_module*
*g:ale_powershell_psscriptanalyzer_module* *g:ale_powershell_psscriptanalyzer_module*
*b:ale_powershell_psscriptanalyzer_module* *b:ale_powershell_psscriptanalyzer_module*
Type: |String powershell_psscriptanalyzer_module
g:ale_powershell_psscriptanalyzer_module
Type: |String|
Default: `'psscriptanalyzer'` Default: `'psscriptanalyzer'`
This variable sets the name of the psscriptanalyzer module. This variable sets the name of the psscriptanalyzer module.
for psscriptanalyzer invocation. for psscriptanalyzer invocation.
*ale-options.powershell_psscriptanalyzer_exclusions*
g:ale_powershell_psscriptanalyzer_exclusions *g:ale_powershell_psscriptanalyzer_exclusions*
*g:ale_powershell_psscriptanalyzer_exclusions*
*b:ale_powershell_psscriptanalyzer_exclusions* *b:ale_powershell_psscriptanalyzer_exclusions*
powershell_psscriptanalyzer_exclusions
g:ale_powershell_psscriptanalyzer_exclusions
Type: |String| Type: |String|
Default: `''` Default: `''`
Set this variable to exclude test(s) for psscriptanalyzer Set this variable to exclude test(s) for psscriptanalyzer
(-ExcludeRule option). To exclude more than one option, separate them with (-ExcludeRule option). To exclude more than one option, separate them with
commas. commas. >
>
" Suppress Write-Host and Global vars warnings " Suppress Write-Host and Global vars warnings
let g:ale_powershell_psscriptanalyzer_exclusions = let g:ale_powershell_psscriptanalyzer_exclusions =
\ 'PSAvoidUsingWriteHost,PSAvoidGlobalVars' \ 'PSAvoidUsingWriteHost,PSAvoidGlobalVars'
+20 -5
View File
@@ -5,15 +5,21 @@ ALE Prolog Integration *ale-prolog-options*
=============================================================================== ===============================================================================
swipl *ale-prolog-swipl* swipl *ale-prolog-swipl*
g:ale_prolog_swipl_executable *g:ale_prolog_swipl_executable* *ale-options.prolog_swipl_executable*
*g:ale_prolog_swipl_executable*
*b:ale_prolog_swipl_executable* *b:ale_prolog_swipl_executable*
prolog_swipl_executable
g:ale_prolog_swipl_executable
Type: |String| Type: |String|
Default: `'swipl'` Default: `'swipl'`
The executable that will be run for the `swipl` linter. The executable that will be run for the `swipl` linter.
g:ale_prolog_swipl_load *g:ale_prolog_swipl_load* *ale-options.prolog_swipl_load*
*g:ale_prolog_swipl_load*
*b:ale_prolog_swipl_load* *b:ale_prolog_swipl_load*
prolog_swipl_load
g:ale_prolog_swipl_load
Type: |String| Type: |String|
Default: `'current_prolog_flag(argv, [File]), load_files(File, [sandboxed(true)]), halt.'` Default: `'current_prolog_flag(argv, [File]), load_files(File, [sandboxed(true)]), halt.'`
@@ -25,8 +31,11 @@ g:ale_prolog_swipl_load *g:ale_prolog_swipl_load*
NOTE: `sandboxed(true)` prohibits executing some directives such as 'initialization main'. NOTE: `sandboxed(true)` prohibits executing some directives such as 'initialization main'.
g:ale_prolog_swipl_timeout *g:ale_prolog_swipl_timeout* *ale-options.prolog_swipl_timeout*
*g:ale_prolog_swipl_timeout*
*b:ale_prolog_swipl_timeout* *b:ale_prolog_swipl_timeout*
prolog_swipl_timeout
g:ale_prolog_swipl_timeout
Type: |Number| Type: |Number|
Default: `3` Default: `3`
@@ -34,8 +43,11 @@ g:ale_prolog_swipl_timeout *g:ale_prolog_swipl_timeout*
It is done by setting SIGALRM. It is done by setting SIGALRM.
See |g:ale_prolog_swipl_alarm| and |g:ale_prolog_swipl_alarm_handler|. See |g:ale_prolog_swipl_alarm| and |g:ale_prolog_swipl_alarm_handler|.
g:ale_prolog_swipl_alarm *g:ale_prolog_swipl_alarm* *ale-options.prolog_swipl_alarm*
*g:ale_prolog_swipl_alarm*
*b:ale_prolog_swipl_alarm* *b:ale_prolog_swipl_alarm*
prolog_swipl_alarm
g:ale_prolog_swipl_alarm
Type: |String| Type: |String|
Default: `'alarm(%t, (%h), _, [])'` Default: `'alarm(%t, (%h), _, [])'`
@@ -43,8 +55,11 @@ g:ale_prolog_swipl_alarm *g:ale_prolog_swipl_alarm*
`%t` is replaced by |g:ale_prolog_swipl_timeout|. `%t` is replaced by |g:ale_prolog_swipl_timeout|.
`%h` is replaced by |g:ale_prolog_swipl_alarm_handler|. `%h` is replaced by |g:ale_prolog_swipl_alarm_handler|.
g:ale_prolog_swipl_alarm_handler *g:ale_prolog_swipl_alarm_handler* *ale-options.prolog_swipl_alarm_handler*
*g:ale_prolog_swipl_alarm_handler*
*b:ale_prolog_swipl_alarm_handler* *b:ale_prolog_swipl_alarm_handler*
prolog_swipl_alarm_handler
g:ale_prolog_swipl_alarm_handler
Type: |String| Type: |String|
Default: `'writeln(user_error, "ERROR: Exceeded %t seconds, Please change g:prolog_swipl_timeout to modify the limit."), halt(1)'` Default: `'writeln(user_error, "ERROR: Exceeded %t seconds, Please change g:prolog_swipl_timeout to modify the limit."), halt(1)'`
+29 -19
View File
@@ -1,5 +1,5 @@
=============================================================================== ===============================================================================
ALE Proto Integration *ale-proto-options* ALE Proto Integration *ale-proto-options*
=============================================================================== ===============================================================================
@@ -10,23 +10,23 @@ To enable `.proto` file linting, update |g:ale_linters| as appropriate:
" Enable linter for .proto files " Enable linter for .proto files
let g:ale_linters = {'proto': ['buf-lint', 'protoc-gen-lint', 'protolint']} let g:ale_linters = {'proto': ['buf-lint', 'protoc-gen-lint', 'protolint']}
< <
To enable `.proto` file fixing, update |g:ale_fixers| as appropriate: To enable `.proto` file fixing, update |g:ale_fixers| as appropriate:
> >
" Enable linter for .proto files " Enable linter for .proto files
let b:ale_fixers = {'proto': ['buf-format', 'protolint']} let b:ale_fixers = {'proto': ['buf-format', 'protolint']}
< <
=============================================================================== ===============================================================================
buf-format *ale-proto-buf-format* buf-format *ale-proto-buf-format*
The formatter uses `buf`, a fully-featured Protobuf compiler that doesn't depend The formatter uses `buf`, a fully-featured Protobuf compiler that doesn't depend
on `protoc`. Make sure the `buf` binary is available in the system path, or on `protoc`. Make sure the `buf` binary is available in the system path, or
set ale_proto_buf_format_executable. set ale_proto_buf_format_executable.
g:ale_proto_buf_format_executable *g:ale_proto_buf_format_executable* *ale-options.proto_buf_format_executable*
*g:ale_proto_buf_format_executable*
proto_buf_format_executable
g:ale_proto_buf_format_executable
Type: |String| Type: |String|
Default: `'buf'` Default: `'buf'`
@@ -34,21 +34,25 @@ g:ale_proto_buf_format_executable *g:ale_proto_buf_format_executable*
=============================================================================== ===============================================================================
buf-lint *ale-proto-buf-lint* buf-lint *ale-proto-buf-lint*
The linter uses `buf`, a fully-featured Protobuf compiler that doesn't depend The linter uses `buf`, a fully-featured Protobuf compiler that doesn't depend
on `protoc`. Make sure the `buf` binary is available in the system path, or on `protoc`. Make sure the `buf` binary is available in the system path, or
set ale_proto_buf_lint_executable. set ale_proto_buf_lint_executable.
g:ale_proto_buf_lint_executable *g:ale_proto_buf_lint_executable* *ale-options.proto_buf_lint_executable*
*g:ale_proto_buf_lint_executable*
proto_buf_lint_executable
g:ale_proto_buf_lint_executable
Type: |String| Type: |String|
Default: `'buf'` Default: `'buf'`
This variable can be changed to modify the executable used for buf. This variable can be changed to modify the executable used for buf.
g:ale_proto_buf_lint_config *g:ale_proto_buf_lint_config* *ale-options.proto_buf_lint_config*
*g:ale_proto_buf_lint_config*
proto_buf_lint_config
g:ale_proto_buf_lint_config
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -66,13 +70,15 @@ Note that the C options are also used for Proto.
=============================================================================== ===============================================================================
protoc-gen-lint *ale-proto-protoc-gen-lint* protoc-gen-lint *ale-proto-protoc-gen-lint*
The linter is a plugin for the `protoc` binary. As long as the binary resides The linter is a plugin for the `protoc` binary. As long as the binary resides
in the system path, `protoc` will find it. in the system path, `protoc` will find it.
g:ale_proto_protoc_gen_lint_options *g:ale_proto_protoc_gen_lint_options* *ale-options.proto_protoc_gen_lint_options*
*g:ale_proto_protoc_gen_lint_options*
proto_protoc_gen_lint_options
g:ale_proto_protoc_gen_lint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -82,7 +88,7 @@ g:ale_proto_protoc_gen_lint_options *g:ale_proto_protoc_gen_lint_options*
=============================================================================== ===============================================================================
protolint *ale-proto-protolint* protolint *ale-proto-protolint*
The linter is a pluggable tool that doesn't depend on the `protoc` binary. The linter is a pluggable tool that doesn't depend on the `protoc` binary.
This supports both linting and fixing. This supports both linting and fixing.
@@ -90,15 +96,19 @@ protolint *ale-proto-protolint
ale_proto_protolint_executable. ale_proto_protolint_executable.
Note that the binary with v0.22.0 or above is supported. Note that the binary with v0.22.0 or above is supported.
g:ale_proto_protolint_executable *g:ale_proto_protolint_executable* *ale-options.proto_protolint_executable*
*g:ale_proto_protolint_executable*
proto_protolint_executable
g:ale_proto_protolint_executable
Type: |String| Type: |String|
Default: `'protolint'` Default: `'protolint'`
This variable can be changed to modify the executable used for protolint. This variable can be changed to modify the executable used for protolint.
g:ale_proto_protolint_config *g:ale_proto_protolint_config* *ale-options.proto_protolint_config*
*g:ale_proto_protolint_config*
proto_protolint_config
g:ale_proto_protolint_config
Type: |String| Type: |String|
Default: `''` Default: `''`
+12 -5
View File
@@ -16,24 +16,31 @@ filename automatically. Configuration files will be loaded in this order:
You might need to create a configuration file for your project to get You might need to create a configuration file for your project to get
meaningful results. meaningful results.
g:ale_pug_puglint_executable *g:ale_pug_puglint_executable* *ale-options.pug_puglint_executable*
*g:ale_pug_puglint_executable*
*b:ale_pug_puglint_executable* *b:ale_pug_puglint_executable*
pug_puglint_executable
g:ale_pug_puglint_executable
Type: |String| Type: |String|
Default: `'pug-lint'` Default: `'pug-lint'`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
*ale-options.pug_puglint_options*
g:ale_pug_puglint_options *g:ale_pug_puglint_options* *g:ale_pug_puglint_options*
*b:ale_pug_puglint_options* *b:ale_pug_puglint_options*
pug_puglint_options
g:ale_pug_puglint_options
Type: |String| Type: |String|
Default: `''` Default: `''`
This variable can be set to pass additional options to pug-lint. This variable can be set to pass additional options to pug-lint.
*ale-options.pug_puglint_use_global*
g:ale_pug_puglint_use_global *g:ale_pug_puglint_use_global* *g:ale_pug_puglint_use_global*
*b:ale_pug_puglint_use_global* *b:ale_pug_puglint_use_global*
pug_puglint_use_global
g:ale_pug_puglint_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
+21 -7
View File
@@ -5,16 +5,21 @@ ALE Puppet Integration *ale-puppet-options*
=============================================================================== ===============================================================================
puppet *ale-puppet-puppet* puppet *ale-puppet-puppet*
g:ale_puppet_puppet_executable *g:ale_puppet_puppet_executable* *ale-options.puppet_puppet_executable*
*g:ale_puppet_puppet_executable*
*b:ale_puppet_puppet_executable* *b:ale_puppet_puppet_executable*
puppet_puppet_executable
g:ale_puppet_puppet_executable
Type: |String| Type: |String|
Default: `'puppet'` Default: `'puppet'`
This variable can be changed to specify the executable used for puppet. This variable can be changed to specify the executable used for puppet.
*ale-options.puppet_puppet_options*
g:ale_puppet_puppet_options *g:ale_puppet_puppet_options* *g:ale_puppet_puppet_options*
*b:ale_puppet_puppet_options* *b:ale_puppet_puppet_options*
puppet_puppet_options
g:ale_puppet_puppet_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -25,16 +30,21 @@ g:ale_puppet_puppet_options *g:ale_puppet_puppet_options*
=============================================================================== ===============================================================================
puppetlint *ale-puppet-puppetlint* puppetlint *ale-puppet-puppetlint*
g:ale_puppet_puppetlint_executable *g:ale_puppet_puppetlint_executable* *ale-options.puppet_puppetlint_executable*
*g:ale_puppet_puppetlint_executable*
*b:ale_puppet_puppetlint_executable* *b:ale_puppet_puppetlint_executable*
puppet_puppetlint_executable
g:ale_puppet_puppetlint_executable
Type: |String| Type: |String|
Default: `'puppet-lint'` Default: `'puppet-lint'`
This variable can be changed to specify the executable used for puppet-lint. This variable can be changed to specify the executable used for puppet-lint.
*ale-options.puppet_puppetlint_options*
g:ale_puppet_puppetlint_options *g:ale_puppet_puppetlint_options* *g:ale_puppet_puppetlint_options*
*b:ale_puppet_puppetlint_options* *b:ale_puppet_puppetlint_options*
puppet_puppetlint_options
g:ale_puppet_puppetlint_options
Type: |String| Type: |String|
Default: `'--no-autoloader_layout-check'` Default: `'--no-autoloader_layout-check'`
@@ -45,13 +55,17 @@ g:ale_puppet_puppetlint_options *g:ale_puppet_puppetlint_options*
=============================================================================== ===============================================================================
puppet-languageserver *ale-puppet-languageserver* puppet-languageserver *ale-puppet-languageserver*
g:ale_puppet_languageserver_executable *g:ale_puppet_languageserver_executable* *ale-options.puppet_languageserver_executable*
*g:ale_puppet_languageserver_executable*
*b:ale_puppet_languageserver_executable* *b:ale_puppet_languageserver_executable*
puppet_languageserver_executable
g:ale_puppet_languageserver_executable
type: |String| type: |String|
Default: `'puppet-languageserver'` Default: `'puppet-languageserver'`
This variable can be used to specify the executable used for This variable can be used to specify the executable used for
puppet-languageserver. puppet-languageserver.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+40 -16
View File
@@ -8,46 +8,64 @@ purescript-language-server *ale-purescript-language-server*
PureScript Language Server PureScript Language Server
(https://github.com/nwolverson/purescript-language-server) (https://github.com/nwolverson/purescript-language-server)
g:ale_purescript_ls_executable g:ale_purescript_ls_executable *ale-options.purescript_ls_executable*
b:ale_purescript_ls_executable *g:ale_purescript_ls_executable*
*b:ale_purescript_ls_executable*
purescript_ls_executable
g:ale_purescript_ls_executable
Type: |String| Type: |String|
Default: `'purescript-language-server'` Default: `'purescript-language-server'`
PureScript language server executable. PureScript language server executable.
g:ale_purescript_ls_config g:ale_purescript_ls_config *ale-options.purescript_ls_config*
b:ale_purescript_ls_config *g:ale_purescript_ls_config*
*b:ale_purescript_ls_config*
purescript_ls_config
g:ale_purescript_ls_config
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
Dictionary containing configuration settings that will be passed to the Dictionary containing configuration settings that will be passed to the
language server. For example, with a spago project: language server. For example, with a spago project: >
{
\ 'purescript': { let g:ale_purescript_ls_config = {
\ 'addSpagoSources': v:true, \ 'purescript': {
\ 'addNpmPath': v:true, \ 'addSpagoSources': v:true,
\ 'buildCommand': 'spago --quiet build --purs-args --json-errors' \ 'addNpmPath': v:true,
\ } \ 'buildCommand': 'spago --quiet build --purs-args --json-errors',
\} \ },
\}
<
=============================================================================== ===============================================================================
purs-tidy *ale-purescript-tidy* purs-tidy *ale-purescript-tidy*
g:ale_purescript_tidy_executable *g:ale_purescript_tidy_executable* *ale-options.purescript_tidy_executable*
*g:ale_purescript_tidy_executable*
*b:ale_purescript_tidy_executable* *b:ale_purescript_tidy_executable*
purescript_tidy_executable
g:ale_purescript_tidy_executable
Type: |String| Type: |String|
Default: `'purs-tidy'` Default: `'purs-tidy'`
This variable can be changed to use a different executable for purs-tidy. This variable can be changed to use a different executable for purs-tidy.
g:ale_purescript_tidy_use_global *g:ale_purescript_tidy_use_global* *ale-options.purescript_tidy_use_global*
*g:ale_purescript_tidy_use_global*
*b:ale_purescript_tidy_use_global* *b:ale_purescript_tidy_use_global*
purescript_tidy_use_global
g:ale_purescript_tidy_use_global
Type: |Number| Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)` Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables| See |ale-integrations-local-executables|
g:ale_purescript_tidy_options *g:ale_purescript_tidy_options* *ale-options.purescript_tidy_options*
*g:ale_purescript_tidy_options*
*b:ale_purescript_tidy_options* *b:ale_purescript_tidy_options*
purescript_tidy_options
g:ale_purescript_tidy_options
Type: |String| Type: |String|
Default: `''` Default: `''`
@@ -56,14 +74,20 @@ g:ale_purescript_tidy_options *g:ale_purescript_tidy_options*
> >
let g:ale_purescript_options = '--indent 3' let g:ale_purescript_options = '--indent 3'
< <
=============================================================================== ===============================================================================
purty *ale-purescript-purty* purty *ale-purescript-purty*
g:ale_purescript_purty_executable *g:ale_purescript_purty_executable* *ale-options.purescript_purty_executable*
*g:ale_purescript_purty_executable*
*b:ale_purescript_purty_executable* *b:ale_purescript_purty_executable*
purescript_purty_executable
g:ale_purescript_purty_executable
Type: |String| Type: |String|
Default: `'purty'` Default: `'purty'`
This variable can be changed to use a different executable for purty. This variable can be changed to use a different executable for purty.
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+8 -3
View File
@@ -5,16 +5,21 @@ ALE Pyrex (Cython) Integration *ale-pyrex-options*
=============================================================================== ===============================================================================
cython *ale-pyrex-cython* cython *ale-pyrex-cython*
g:ale_pyrex_cython_executable *g:ale_pyrex_cython_executable* *ale-options.pyrex_cython_executable*
*g:ale_pyrex_cython_executable*
*b:ale_pyrex_cython_executable* *b:ale_pyrex_cython_executable*
pyrex_cython_executable
g:ale_pyrex_cython_executable
Type: |String| Type: |String|
Default: `'cython'` Default: `'cython'`
This variable can be changed to use a different executable for cython. This variable can be changed to use a different executable for cython.
*ale-options.pyrex_cython_options*
g:ale_pyrex_cython_options *g:ale_pyrex_cython_options* *g:ale_pyrex_cython_options*
*b:ale_pyrex_cython_options* *b:ale_pyrex_cython_options*
pyrex_cython_options
g:ale_pyrex_cython_options
Type: |String| Type: |String|
Default: `'--warning-extra --warning-errors'` Default: `'--warning-extra --warning-errors'`
+725 -346
View File
File diff suppressed because it is too large Load Diff
+4 -2
View File
@@ -5,8 +5,11 @@ ALE QML Integration *ale-qml-options*
=============================================================================== ===============================================================================
qmlfmt *ale-qml-qmlfmt* qmlfmt *ale-qml-qmlfmt*
g:ale_qml_qmlfmt_executable *g:ale_qml_qmlfmt_executable* *ale-options.qml_qmlfmt_executable*
*g:ale_qml_qmlfmt_executable*
*b:ale_qml_qmlfmt_executable* *b:ale_qml_qmlfmt_executable*
qml_qmlfmt_executable
g:ale_qml_qmlfmt_executable
Type: |String| Type: |String|
Default: `'qmlfmt'` Default: `'qmlfmt'`
@@ -15,4 +18,3 @@ g:ale_qml_qmlfmt_executable *g:ale_qml_qmlfmt_executable*
=============================================================================== ===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
+20 -7
View File
@@ -5,8 +5,11 @@ ALE R Integration *ale-r-options*
=============================================================================== ===============================================================================
languageserver *ale-r-languageserver* languageserver *ale-r-languageserver*
g:ale_r_languageserver_cmd *g:ale_r_languageserver_cmd* *ale-options.r_languageserver_cmd*
*g:ale_r_languageserver_cmd*
*b:ale_r_languageserver_cmd* *b:ale_r_languageserver_cmd*
r_languageserver_cmd
g:ale_r_languageserver_cmd
Type: |String| Type: |String|
Default: `'languageserver::run()'` Default: `'languageserver::run()'`
@@ -15,9 +18,11 @@ g:ale_r_languageserver_cmd *g:ale_r_languageserver_cmd*
See the languageserver documentation for more options. See the languageserver documentation for more options.
*ale-options.r_languageserver_config*
g:ale_r_languageserver_config *g:ale_r_languageserver_config* *g:ale_r_languageserver_config*
*b:ale_r_languageserver_config* *b:ale_r_languageserver_config*
r_languageserver_config
g:ale_r_languageserver_config
Type: |Dictionary| Type: |Dictionary|
Default: `{}` Default: `{}`
@@ -28,8 +33,11 @@ g:ale_r_languageserver_config *g:ale_r_languageserver_config*
=============================================================================== ===============================================================================
lintr *ale-r-lintr* lintr *ale-r-lintr*
g:ale_r_lintr_options *g:ale_r_lintr_options* *ale-options.r_lintr_options*
*g:ale_r_lintr_options*
*b:ale_r_lintr_options* *b:ale_r_lintr_options*
r_lintr_options
g:ale_r_lintr_options
Type: |String| Type: |String|
Default: `'lintr::with_defaults()'` Default: `'lintr::with_defaults()'`
@@ -38,9 +46,11 @@ g:ale_r_lintr_options *g:ale_r_lintr_options*
The value of this option will be run with `eval` for the `lintr::lint` The value of this option will be run with `eval` for the `lintr::lint`
options. Consult the lintr documentation for more information. options. Consult the lintr documentation for more information.
*ale-options.r_lintr_lint_package*
g:ale_r_lintr_lint_package *g:ale_r_lintr_lint_package* *g:ale_r_lintr_lint_package*
*b:ale_r_lintr_lint_package* *b:ale_r_lintr_lint_package*
r_lintr_lint_package
g:ale_r_lintr_lint_package
Type: |Number| Type: |Number|
Default: `0` Default: `0`
@@ -52,8 +62,11 @@ g:ale_r_lintr_lint_package *g:ale_r_lintr_lint_package*
=============================================================================== ===============================================================================
styler *ale-r-styler* styler *ale-r-styler*
g:ale_r_styler_options *g:ale_r_styler_options* *ale-options.r_styler_options*
*g:ale_r_styler_options*
*b:ale_r_styler_options* *b:ale_r_styler_options*
r_styler_options
g:ale_r_styler_options
Type: |String| Type: |String|
Default: `'styler::tidyverse_style'` Default: `'styler::tidyverse_style'`

Some files were not shown because too many files have changed in this diff Show More