Compare commits

...

27 Commits

Author SHA1 Message Date
w0rp
e1c8d665d6 #3600 Implement pull model with Neovim Client
Implement the diagnostics pull model with the LSP Neovim client. We
must handle messages a little different and tweak client capabilities
for pull diagnostics to work through the Neovim client.
2025-03-23 16:08:18 +00:00
w0rp
fe50a711cb Close #3600 - Implement pull diagnostics in VimL
Implement pull diagnostics in the VimL implementation so ALE is able
to track when servers are busy checking files. Only servers that
support this feature will return diagnostics these ways.
2025-03-23 16:07:46 +00:00
w0rp
19e1b5a9d3 Implement ale.queue for calling ale#Queue in Lua 2025-03-22 01:10:11 +00:00
w0rp
33a902f489 Implement ale.pad in Lua 2025-03-22 00:43:29 +00:00
w0rp
a1c57918ef Implement ale.get_filename_mappings in Lua 2025-03-22 00:35:53 +00:00
w0rp
1aae83497d Add ale.has to mirror ale#Has in Lua 2025-03-22 00:04:46 +00:00
w0rp
f4af0dc84b Add basic Lua ALE functions and test coverage
Ensure that basic ALE functions `ale.var`, `ale.escape`, and `ale.env`
are available in Lua. Cover all Lua code so far with busted tests,
fixing bugs where ALE variables can be set with Boolean values instead
of numbers. Document all functionality so far.
2025-03-21 23:37:35 +00:00
w0rp
7f43666fb3 Detect the Lua project root using .luarc.json 2025-03-21 12:07:10 +00:00
w0rp
bcd1a12949 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.
2025-03-20 21:52:13 +00:00
w0rp
53f036fe9f Support g:ale_shell with the Neovim LSP client 2025-03-20 21:45:19 +00:00
w0rp
3dfebe45c6 Add Neovim TCP connections to language servers
Support TCP connections to language servers through Neovim's built in
client. In all but what is currently the nightly builds of Neovim
connections via a hostname will fail, but connections via an IP address
should function. We will still enable the built in Neovim client by
default anyway, as LSP clients very rarely connect over TCP.
2025-03-20 21:45:19 +00:00
w0rp
964e0a2e39 Supply language_id values to Neovim LSP API
Change logic so ALE's LSP implementation and the Neovim LSP client
retrieve the language_id for language clients at roughly the same time
via the same means. This makes ALE inform the language server what the
language for the language is for clients.
2025-03-20 21:45:19 +00:00
w0rp
ee975196ff Fix tests for Neovim LSP integration 2025-03-20 21:45:19 +00:00
w0rp
3f7ea86ae1 Update documentation for Neovim LSP integration
Update documentation to advertise ALE's integration with Neovim's native
LSP client, and explain how functionality is integrated with ALE,
Neovim's native tools, and other plugins.
2025-03-20 21:45:18 +00:00
w0rp
dd8d7cb4b4 Clean up message handling for LSP integration
Now we ought to be able to handle any kind of response for any request
we send, clean up message handling so there are fewer changes to make
to LSP code to adjust for Neovim integration.
2025-03-20 21:45:18 +00:00
w0rp
8216ee4a65 Handle other LSP capabilities via ALE
Save capabilities from language servers ALE connects to via Neovim's LSP
client and handle responses to requests ALE sends to language servers.
This enables ALE to work with Neovim's language client for its commands
while also letting users directly use the connected clients for native
Neovim keybinds and so on.
2025-03-20 21:45:18 +00:00
w0rp
9a251b2865 Remove the log_level line from Lua code 2025-03-20 21:45:18 +00:00
w0rp
61a1fcc92f Handle Neovim LSP diagnostics via ALE's functions 2025-03-20 21:45:18 +00:00
w0rp
c9eb8f9d15 Start up language servers with Neovim's API
Get language servers starting and displaying diagnostics with Neovim's
API in Neovim 0.8 and up. With this set up, now ALE needs to take over
handling diagnostics returned by the language servers.
2025-03-20 21:45:18 +00:00
Horacio Sanson
7fcc0548b0 (feat) add support for kulala_fmt fixer (#4925)
Some checks failed
CI / build_image (push) Has been cancelled
CI / test_ale (--linters-only) (push) Has been cancelled
CI / test_ale (--neovim-07-only) (push) Has been cancelled
CI / test_ale (--neovim-08-only) (push) Has been cancelled
CI / test_ale (--vim-80-only) (push) Has been cancelled
CI / test_ale (--vim-90-only) (push) Has been cancelled
* (feat) add support for kulala_fmt fixer

Co-authored-by: w0rp <w0rp@users.noreply.github.com>
2025-03-18 12:40:52 +00:00
w0rp
9ce2c29df1 Simplfiy zlint configuration and tests 2025-03-18 12:33:58 +00:00
Enrique Miguel Mora Meza
59c996c5b8 Support for Zlint as Zig linter (#4923)
* feat: Add Zig zlint linter and handler for ALE
* docs: Add zlint documentation to ALE Zig integration guide
* docs: Updating docs for zlint support
* tests: Adding tests for checking zlint executable and command
* refactor: Move zlint configuration test to separate test file
2025-03-18 12:30:05 +00:00
w0rp
c4cedeea3f Remove unreliable yls test for now 2025-03-18 11:57:49 +00:00
w0rp
f3b6269388 Make yls tests work better locally 2025-03-18 11:38:47 +00:00
Adrian Vollmer
47f1f49655 Add linting support for all formats supported by djlint (#4920)
Some checks are pending
CI / build_image (push) Waiting to run
CI / test_ale (--linters-only) (push) Blocked by required conditions
CI / test_ale (--neovim-07-only) (push) Blocked by required conditions
CI / test_ale (--neovim-08-only) (push) Blocked by required conditions
CI / test_ale (--vim-80-only) (push) Blocked by required conditions
CI / test_ale (--vim-90-only) (push) Blocked by required conditions
* Refactor djlint linter code

This patch moves the code to the `autoload` directory, so it's available
when it's needed by a specific linter. This avoids redundant code when
another format supported by djlint is added.

* Add linting support for all formats supported by djlint

So far, the `djlint` linter in ALE only supported `html`, which is only
one of several file types supported by `djlint`.

This patch adds support for the following file types:

* gohtmltmpl
* handlebars
* htmlangular
* htmldjango
* jinja
* nunjucks

* Add djlint fixer for various HTML template formats

* Supported formats:
    - html
    - htmlangular
    - htmldjango
    - jinja
    - handlebars
    - nunjucks
    - gohtmltmpl

* Add doc entries

* Add vader tests

---------

Co-authored-by: Adrian Vollmer <computerfluesterer@protonmail.com>
2025-03-18 07:56:32 +09:00
Adrian Vollmer
fe6a91fb92 Add the typstyle formatter as a fixer for Typst (#4927)
Some checks are pending
CI / build_image (push) Waiting to run
CI / test_ale (--linters-only) (push) Blocked by required conditions
CI / test_ale (--neovim-07-only) (push) Blocked by required conditions
CI / test_ale (--neovim-08-only) (push) Blocked by required conditions
CI / test_ale (--vim-80-only) (push) Blocked by required conditions
CI / test_ale (--vim-90-only) (push) Blocked by required conditions
Co-authored-by: Adrian Vollmer <computerfluesterer@protonmail.com>
2025-03-17 21:10:24 +09:00
K4YT3X
995d78435a fix(golangci-lint): incorrect filename concat preventing errors from being displayed (#4926)
Some checks failed
CI / build_image (push) Has been cancelled
CI / test_ale (--linters-only) (push) Has been cancelled
CI / test_ale (--neovim-07-only) (push) Has been cancelled
CI / test_ale (--neovim-08-only) (push) Has been cancelled
CI / test_ale (--vim-80-only) (push) Has been cancelled
CI / test_ale (--vim-90-only) (push) Has been cancelled
Signed-off-by: k4yt3x <i@k4yt3x.com>
2025-03-16 09:56:27 +09:00
219 changed files with 8375 additions and 2944 deletions

View File

@@ -30,6 +30,7 @@ jobs:
- '--vim-90-only'
- '--neovim-07-only'
- '--neovim-08-only'
- '--lua-only'
- '--linters-only'
steps:
- uses: actions/checkout@v4

19
.luarc.json Normal file
View File

@@ -0,0 +1,19 @@
{
"$schema": "https://raw.githubusercontent.com/LuaLS/vscode-lua/master/setting/schema.json",
"diagnostics.globals": [
"vim"
],
"workspace.ignoreDir": [
"test"
],
"workspace.library": [
"/usr/share/nvim/runtime/lua"
],
"runtime.pathStrict": true,
"runtime.path": [
"lua/?.lua",
"lua/?/init.lua"
],
"runtime.version": "LuaJIT",
"hint.enable": false
}

View File

@@ -2,12 +2,10 @@ ARG TESTBED_VIM_VERSION=24
FROM testbed/vim:${TESTBED_VIM_VERSION}
RUN install_vim -tag v8.0.0027 -build \
-tag v9.0.0297 -build \
-tag neovim:v0.7.0 -build \
-tag neovim:v0.8.0 -build
ENV PACKAGES="\
lua5.1 \
lua5.1-dev \
lua5.1-busted \
bash \
git \
python2 \
@@ -19,6 +17,11 @@ ENV PACKAGES="\
RUN apk --update add $PACKAGES && \
rm -rf /var/cache/apk/* /tmp/* /var/tmp/*
RUN install_vim -tag v8.0.0027 -build \
-tag v9.0.0297 -build \
-tag neovim:v0.7.0 -build \
-tag neovim:v0.8.0 -build
RUN pip install vim-vint==0.3.21
RUN git clone https://github.com/junegunn/vader.vim vader && \

View File

@@ -56,6 +56,7 @@ linting and fixing of code in Vim. ALE offers the following.
* Near-zero configuration with custom code for better defaults
* Highly customizable and well-documented (`:help ale-options`)
* Breaking changes for the plugin are extremely rare
* Integrates with Neovim's LSP client (0.8+) and diagnostics (0.7+)
* Support for older Vim and Neovim versions
* Windows support
* Well-integrated with other plugins
@@ -140,6 +141,12 @@ ALE offers some support for completion via hijacking of omnicompletion while you
type. All of ALE's completion information must come from Language Server
Protocol linters, or from `tsserver` for TypeScript.
When running ALE in Neovim 0.8+, ALE will integrate with Neovim's LSP client by
default, and any auto-completion plugin that uses the native LSP client will
work when ALE runs language servers.
[nvim-cmp](https://github.com/hrsh7th/nvim-cmp) is recommended as a
completion plugin worth trying in Neovim.
ALE integrates with [Deoplete](https://github.com/Shougo/deoplete.nvim) as a
completion source, named `'ale'`. You can configure Deoplete to only use ALE as
the source of completion information, or mix it with other sources.
@@ -186,7 +193,8 @@ LSP servers (e.g. eclipselsp). See `:help ale-completion` for more information.
ALE supports jumping to the definition of words under your cursor with the
`:ALEGoToDefinition` command using any enabled Language Server Protocol linters
and `tsserver`.
and `tsserver`. In Neovim 0.8+, you can also use Neovim's built in `gd` keybind
and more.
See `:help ale-go-to-definition` for more information.

View File

@@ -45,7 +45,7 @@ function! ale_linters#go#golangci_lint#Handler(buffer, lines) abort
endif
call add(l:output, {
\ 'filename': ale#path#GetAbsPath(l:dir, l:match['Pos']['Filename']),
\ 'filename': ale#path#GetAbsPath(l:dir, fnamemodify(l:match['Pos']['Filename'], ':t')),
\ 'lnum': l:match['Pos']['Line'] + 0,
\ 'col': l:match['Pos']['Column'] + 0,
\ 'type': l:msg_type,

View File

@@ -0,0 +1,12 @@
" Author: Adrian Vollmer <computerfluesterer@protonmail.com>
" Description: djlint for Django HTML template files
call ale#Set('html_djlint_executable', 'djlint')
call ale#Set('html_djlint_options', '')
call ale#linter#Define('gohtmltmpl', {
\ 'name': 'djlint',
\ 'executable': function('ale#handlers#djlint#GetExecutable'),
\ 'command': function('ale#handlers#djlint#GetCommand'),
\ 'callback': 'ale#handlers#djlint#Handle',
\})

View File

@@ -0,0 +1,12 @@
" Author: Adrian Vollmer <computerfluesterer@protonmail.com>
" Description: djlint for Django HTML template files
call ale#Set('html_djlint_executable', 'djlint')
call ale#Set('html_djlint_options', '')
call ale#linter#Define('handlebars', {
\ 'name': 'djlint',
\ 'executable': function('ale#handlers#djlint#GetExecutable'),
\ 'command': function('ale#handlers#djlint#GetCommand'),
\ 'callback': 'ale#handlers#djlint#Handle',
\})

View File

@@ -4,45 +4,11 @@
call ale#Set('html_djlint_executable', 'djlint')
call ale#Set('html_djlint_options', '')
function! ale_linters#html#djlint#GetExecutable(buffer) abort
return ale#Var(a:buffer, 'html_djlint_executable')
endfunction
function! ale_linters#html#djlint#GetCommand(buffer) abort
let l:executable = ale_linters#html#djlint#GetExecutable(a:buffer)
let l:options = ale#Var(a:buffer, 'html_djlint_options')
return ale#Escape(l:executable)
\ . (!empty(l:options) ? ' ' . l:options : '') . ' %s'
endfunction
function! ale_linters#html#djlint#Handle(buffer, lines) abort
let l:output = []
let l:pattern = '\v^([A-Z]\d+) (\d+):(\d+) (.*)$'
let l:i = 0
for l:match in ale#util#GetMatches(a:lines, l:pattern)
let l:i += 1
let l:item = {
\ 'lnum': l:match[2] + 0,
\ 'col': l:match[3] + 0,
\ 'vcol': 1,
\ 'text': l:match[4],
\ 'code': l:match[1],
\ 'type': 'W',
\}
call add(l:output, l:item)
endfor
return l:output
endfunction
call ale#linter#Define('html', {
\ 'name': 'djlint',
\ 'executable': function('ale_linters#html#djlint#GetExecutable'),
\ 'command': function('ale_linters#html#djlint#GetCommand'),
\ 'callback': 'ale_linters#html#djlint#Handle',
\ 'executable': function('ale#handlers#djlint#GetExecutable'),
\ 'command': function('ale#handlers#djlint#GetCommand'),
\ 'callback': 'ale#handlers#djlint#Handle',
\})
" vim:ts=4:sw=4:et:

View File

@@ -0,0 +1,12 @@
" Author: Adrian Vollmer <computerfluesterer@protonmail.com>
" Description: djlint for Django HTML template files
call ale#Set('html_djlint_executable', 'djlint')
call ale#Set('html_djlint_options', '')
call ale#linter#Define('htmlangular', {
\ 'name': 'djlint',
\ 'executable': function('ale#handlers#djlint#GetExecutable'),
\ 'command': function('ale#handlers#djlint#GetCommand'),
\ 'callback': 'ale#handlers#djlint#Handle',
\})

View File

@@ -0,0 +1,12 @@
" Author: Adrian Vollmer <computerfluesterer@protonmail.com>
" Description: djlint for Django HTML template files
call ale#Set('html_djlint_executable', 'djlint')
call ale#Set('html_djlint_options', '')
call ale#linter#Define('htmldjango', {
\ 'name': 'djlint',
\ 'executable': function('ale#handlers#djlint#GetExecutable'),
\ 'command': function('ale#handlers#djlint#GetCommand'),
\ 'callback': 'ale#handlers#djlint#Handle',
\})

View File

@@ -0,0 +1,12 @@
" Author: Adrian Vollmer <computerfluesterer@protonmail.com>
" Description: djlint for Django HTML template files
call ale#Set('html_djlint_executable', 'djlint')
call ale#Set('html_djlint_options', '')
call ale#linter#Define('jinja', {
\ 'name': 'djlint',
\ 'executable': function('ale#handlers#djlint#GetExecutable'),
\ 'command': function('ale#handlers#djlint#GetCommand'),
\ 'callback': 'ale#handlers#djlint#Handle',
\})

View File

@@ -0,0 +1,12 @@
" Author: Adrian Vollmer <computerfluesterer@protonmail.com>
" Description: djlint for Django HTML template files
call ale#Set('html_djlint_executable', 'djlint')
call ale#Set('html_djlint_options', '')
call ale#linter#Define('nunjucks', {
\ 'name': 'djlint',
\ 'executable': function('ale#handlers#djlint#GetExecutable'),
\ 'command': function('ale#handlers#djlint#GetCommand'),
\ 'callback': 'ale#handlers#djlint#Handle',
\})

View File

@@ -63,7 +63,7 @@ function! ale_linters#python#flake8#GetCwd(buffer) abort
endif
if (l:change_directory is# 'project' && empty(l:cwd))
\|| l:change_directory is# 1
\|| l:change_directory
\|| l:change_directory is# 'file'
let l:cwd = '%s:h'
endif

View File

@@ -63,7 +63,7 @@ function! ale_linters#python#flakehell#GetCwd(buffer) abort
endif
if (l:change_directory is# 'project' && empty(l:cwd))
\|| l:change_directory is# 1
\|| l:change_directory
\|| l:change_directory is# 'file'
let l:cwd = '%s:h'
endif

View File

@@ -82,7 +82,7 @@ function! ale_linters#python#pylint#Handle(buffer, lines) abort
continue
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
else
let l:code_out = l:match[4]

30
ale_linters/zig/zlint.vim Normal file
View File

@@ -0,0 +1,30 @@
" Author: Don Isaac
" Description: A linter for the Zig programming language
call ale#Set('zig_zlint_executable', 'zlint')
function! ale_linters#zig#zlint#Handle(buffer, lines) abort
" GitHub Actions format: ::severity file=file,line=line,col=col,title=code::message
let l:pattern = '::\([a-z]\+\) file=\([^,]\+\),line=\(\d\+\),col=\(\d\+\),title=\([^:]\+\)::\(.*\)'
let l:output = []
for l:match in ale#util#GetMatches(a:lines, l:pattern)
call add(l:output, {
\ 'filename': l:match[2],
\ 'lnum': str2nr(l:match[3]),
\ 'col': str2nr(l:match[4]),
\ 'text': l:match[6],
\ 'type': l:match[1] =~? 'error\|fail' ? 'E' : 'W',
\ 'code': l:match[5],
\})
endfor
return l:output
endfunction
call ale#linter#Define('zig', {
\ 'name': 'zlint',
\ 'executable': {b -> ale#Var(b, "zig_zlint_executable")},
\ 'command': '%e %s -f gh',
\ 'callback': 'ale_linters#zig#zlint#Handle',
\})

View File

@@ -205,7 +205,10 @@ endfunction
function! ale#assert#LSPLanguage(expected_language) abort
let l:buffer = bufnr('')
let l:linter = s:GetLinter()
let l:language = ale#linter#GetLanguage(l:buffer, l:linter)
let l:Language = l:linter.language
let l:language = type(l:Language) is v:t_func
\ ? l:Language(l:buffer)
\ : l:Language
AssertEqual a:expected_language, l:language
endfunction

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_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_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 s:timer_id = -1
@@ -394,6 +394,7 @@ function! ale#completion#Show(result) abort
if g:ale_enabled
\&& (
\ l:text_changed is# '1'
\ || g:ale_lint_on_text_changed is v:true
\ || l:text_changed is# 'always'
\ || l:text_changed is# 'normal'
\ || l:text_changed is# 'insert'
@@ -510,7 +511,7 @@ function! ale#completion#ParseTSServerCompletionEntryDetails(response) abort
\ 'icase': 1,
\ 'menu': join(l:displayParts, ''),
\ 'dup': get(l:info, 'additional_edits_only', 0)
\ || g:ale_completion_autoimport,
\ || (g:ale_completion_autoimport + 0),
\ 'info': join(l:documentationParts, ''),
\}
" 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,
\ 'menu': l:detail,
\ '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 : ''),
\}
" 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)
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(
\ l:buffer,
\ b:ale_completion_info.line,
\ b:ale_completion_info.column,
\ 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
" Send a message saying the buffer has changed first, otherwise

View File

@@ -4,7 +4,7 @@
let s:go_to_definition_map = {}
" 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')
" Used to get the definition map in tests.

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
" 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
endif
@@ -259,7 +259,7 @@ function! ale#engine#SendResultsToNeovimDiagnostics(buffer, loclist) abort
" Keep the Lua surface area really small in the VimL part of ALE,
" and just require the diagnostics.lua module on demand.
let l:SendDiagnostics = luaeval('require("ale.diagnostics").sendAleResultsToDiagnostics')
let l:SendDiagnostics = luaeval('require("ale.diagnostics").send')
call l:SendDiagnostics(a:buffer, a:loclist)
endfunction

View File

@@ -173,7 +173,9 @@ function! ale#events#Init() abort
autocmd BufWritePost * call ale#events#SaveEvent(str2nr(expand('<abuf>')))
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'))
elseif l:text_changed is? 'normal'
autocmd TextChanged * call ale#Queue(ale#Var(str2nr(expand('<abuf>')), 'lint_delay'))

View File

@@ -98,6 +98,11 @@ let s:default_registry = {
\ 'suggested_filetypes': ['dhall'],
\ 'description': 'Standard code formatter for the Dhall language and removing dead code',
\ },
\ 'djlint': {
\ 'function': 'ale#fixers#djlint#Fix',
\ 'suggested_filetypes': ['html', 'htmldjango', 'htmlangular', 'jinja', 'handlebars', 'nunjucks', 'gohtmltmpl'],
\ 'description': 'Fix HTML templates with `djlint --reformat`.',
\ },
\ 'dune': {
\ 'function': 'ale#fixers#dune#Fix',
\ 'suggested_filetypes': ['dune'],
@@ -124,6 +129,11 @@ let s:default_registry = {
\ 'suggested_filetypes': ['hurl'],
\ 'description': 'Fix hurl files with hurlfmt.',
\ },
\ 'kulala_fmt': {
\ 'function': 'ale#fixers#kulala_fmt#Fix',
\ 'suggested_filetypes': ['http', 'rest'],
\ 'description': 'Fix http and rest files with kulala_fmt.',
\ },
\ 'tidy': {
\ 'function': 'ale#fixers#tidy#Fix',
\ 'suggested_filetypes': ['html'],
@@ -707,6 +717,11 @@ let s:default_registry = {
\ 'suggested_filetypes': ['clojure'],
\ 'description': 'formatter and linter for clojure files',
\ },
\ 'typstyle': {
\ 'function': 'ale#fixers#typstyle#Fix',
\ 'suggested_filetypes': ['typst'],
\ 'description': 'A formatter for Typst files',
\ },
\}
" Reset the function registry to the default entries.

View File

@@ -0,0 +1,48 @@
" Author: Adrian Vollmer (computerfluesterer@protonmail.com)
" Description: HTML template formatter using `djlint --reformat`
call ale#Set('html_djlint_executable', 'djlint')
call ale#Set('html_djlint_use_global', get(g:, 'ale_use_global_executables', 0))
call ale#Set('html_djlint_options', '')
function! ale#fixers#djlint#Fix(buffer) abort
let l:executable = ale#python#FindExecutable(
\ a:buffer,
\ 'html_djlint',
\ ['djlint']
\)
let l:options = ale#Var(a:buffer, 'html_djlint_options')
let l:profile = ''
let l:filetypes = split(getbufvar(a:buffer, '&filetype'), '\.')
" Append the --profile flag depending on the current filetype (unless it's
" already set in g:html_djlint_options).
if match(l:options, '--profile') == -1
let l:djlint_profiles = {
\ 'html': 'html',
\ 'htmldjango': 'django',
\ 'jinja': 'jinja',
\ 'nunjucks': 'nunjucks',
\ 'handlebars': 'handlebars',
\ 'gohtmltmpl': 'golang',
\ 'htmlangular': 'angular',
\}
for l:filetype in l:filetypes
if has_key(l:djlint_profiles, l:filetype)
let l:profile = l:djlint_profiles[l:filetype]
break
endif
endfor
endif
if !empty(l:profile)
let l:options = (!empty(l:options) ? l:options . ' ' : '') . '--profile ' . l:profile
endif
return {
\ 'command': ale#Escape(l:executable) . ' --reformat ' . l:options . ' -',
\}
endfunction

View File

@@ -0,0 +1,11 @@
" Author: hsanson <hsanson@gmail.com>
" Description: kulala_fmt fixer for http and rest files.
call ale#Set('http_kulala_fmt_executable', 'kulala-fmt')
function! ale#fixers#kulala_fmt#Fix(buffer) abort
return {
\ 'command': ale#Escape(ale#Var(a:buffer, 'http_kulala_fmt_executable')) . ' format %t > /dev/null',
\ 'read_temporary_file': 1
\ }
endfunction

View File

@@ -0,0 +1,20 @@
" Author: Adrian Vollmer (computerfluesterer@protonmail.com)
" Description: Typst formatter using typstyle
call ale#Set('typst_typstyle_executable', 'typstyle')
call ale#Set('typst_typstyle_use_global', get(g:, 'ale_use_global_executables', 0))
call ale#Set('typst_typstyle_options', '')
function! ale#fixers#typstyle#Fix(buffer) abort
let l:executable = ale#path#FindExecutable(
\ a:buffer,
\ 'typst_typstyle',
\ ['typstyle']
\)
let l:options = ale#Var(a:buffer, 'typst_typstyle_options')
return {
\ 'command': ale#Escape(l:executable) . ' ' . l:options,
\}
endfunction

View File

@@ -0,0 +1,64 @@
" Author: Vivian De Smedt <vds2212@gmail.com>, Adrian Vollmer <computerfluesterer@protonmail.com>
" Description: Adds support for djlint
"
function! ale#handlers#djlint#GetExecutable(buffer) abort
return ale#Var(a:buffer, 'html_djlint_executable')
endfunction
function! ale#handlers#djlint#GetCommand(buffer) abort
let l:executable = ale#handlers#djlint#GetExecutable(a:buffer)
let l:options = ale#Var(a:buffer, 'html_djlint_options')
let l:profile = ''
let l:filetypes = split(getbufvar(a:buffer, '&filetype'), '\.')
" Append the --profile flag depending on the current filetype (unless it's
" already set in g:html_djlint_options).
if match(l:options, '--profile') == -1
let l:djlint_profiles = {
\ 'html': 'html',
\ 'htmldjango': 'django',
\ 'jinja': 'jinja',
\ 'nunjucks': 'nunjucks',
\ 'handlebars': 'handlebars',
\ 'gohtmltmpl': 'golang',
\ 'htmlangular': 'angular',
\}
for l:filetype in l:filetypes
if has_key(l:djlint_profiles, l:filetype)
let l:profile = l:djlint_profiles[l:filetype]
break
endif
endfor
endif
if !empty(l:profile)
let l:options = (!empty(l:options) ? l:options . ' ' : '') . '--profile ' . l:profile
endif
return ale#Escape(l:executable)
\ . (!empty(l:options) ? ' ' . l:options : '') . ' %s'
endfunction
function! ale#handlers#djlint#Handle(buffer, lines) abort
let l:output = []
let l:pattern = '\v^([A-Z]\d+) (\d+):(\d+) (.*)$'
let l:i = 0
for l:match in ale#util#GetMatches(a:lines, l:pattern)
let l:i += 1
let l:item = {
\ 'lnum': l:match[2] + 0,
\ 'col': l:match[3] + 0,
\ 'vcol': 1,
\ 'text': l:match[4],
\ 'code': l:match[1],
\ 'type': 'W',
\}
call add(l:output, l:item)
endfor
return l:output
endfunction

View File

@@ -446,9 +446,3 @@ function! ale#linter#GetAddress(buffer, linter) abort
return type(l:Address) is v:t_func ? l:Address(a:buffer) : l:Address
endfunction
function! ale#linter#GetLanguage(buffer, linter) abort
let l:Language = a:linter.language
return type(l:Language) is v:t_func ? l:Language(a:buffer) : l:Language
endfunction

View File

@@ -2,11 +2,11 @@
" Description: Manages the loclist and quickfix lists
" 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
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
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
let g:ale_list_window_size = get(g:, 'ale_list_window_size', 10)
" A string format for the loclist messages.

View File

@@ -5,9 +5,10 @@
let s:connections = get(s:, 'connections', {})
let g:ale_lsp_next_message_id = 1
" Given an id, which can be an executable or address, and a project path,
" Given an id, which can be an executable or address, a project path,
" and a language string or (bufnr) -> string function
" create a new connection if needed. Return a unique ID for the connection.
function! ale#lsp#Register(executable_or_address, project, init_options) abort
function! ale#lsp#Register(executable_or_address, project, language, init_options) abort
let l:conn_id = a:executable_or_address . ':' . a:project
if !has_key(s:connections, l:conn_id)
@@ -28,6 +29,7 @@ function! ale#lsp#Register(executable_or_address, project, init_options) abort
\ 'is_tsserver': 0,
\ 'data': '',
\ 'root': a:project,
\ 'language': a:language,
\ 'open_documents': {},
\ 'initialized': 0,
\ 'init_request_id': 0,
@@ -45,6 +47,7 @@ function! ale#lsp#Register(executable_or_address, project, init_options) abort
\ 'definition': 0,
\ 'typeDefinition': 0,
\ 'implementation': 0,
\ 'pull_model': 0,
\ 'symbol_search': 0,
\ 'code_actions': 0,
\ 'did_save': 0,
@@ -195,101 +198,114 @@ endfunction
" Update capabilities from the server, so we know which features the server
" supports.
function! s:UpdateCapabilities(conn, capabilities) abort
function! ale#lsp#UpdateCapabilities(conn_id, capabilities) abort
let l:conn = get(s:connections, a:conn_id, {})
if empty(l:conn)
return
endif
if type(a:capabilities) isnot v:t_dict
return
endif
if get(a:capabilities, 'hoverProvider') is v:true
let a:conn.capabilities.hover = 1
let l:conn.capabilities.hover = 1
endif
if type(get(a:capabilities, 'hoverProvider')) is v:t_dict
let a:conn.capabilities.hover = 1
let l:conn.capabilities.hover = 1
endif
if get(a:capabilities, 'referencesProvider') is v:true
let a:conn.capabilities.references = 1
let l:conn.capabilities.references = 1
endif
if type(get(a:capabilities, 'referencesProvider')) is v:t_dict
let a:conn.capabilities.references = 1
let l:conn.capabilities.references = 1
endif
if get(a:capabilities, 'renameProvider') is v:true
let a:conn.capabilities.rename = 1
let l:conn.capabilities.rename = 1
endif
if type(get(a:capabilities, 'renameProvider')) is v:t_dict
let a:conn.capabilities.rename = 1
let l:conn.capabilities.rename = 1
endif
if get(a:capabilities, 'codeActionProvider') is v:true
let a:conn.capabilities.code_actions = 1
let l:conn.capabilities.code_actions = 1
endif
if type(get(a:capabilities, 'codeActionProvider')) is v:t_dict
let a:conn.capabilities.code_actions = 1
let l:conn.capabilities.code_actions = 1
endif
if !empty(get(a:capabilities, 'completionProvider'))
let a:conn.capabilities.completion = 1
let l:conn.capabilities.completion = 1
endif
if type(get(a:capabilities, 'completionProvider')) is v:t_dict
let l:chars = get(a:capabilities.completionProvider, 'triggerCharacters')
if type(l:chars) is v:t_list
let a:conn.capabilities.completion_trigger_characters = l:chars
let l:conn.capabilities.completion_trigger_characters = l:chars
endif
endif
if get(a:capabilities, 'definitionProvider') is v:true
let a:conn.capabilities.definition = 1
let l:conn.capabilities.definition = 1
endif
if type(get(a:capabilities, 'definitionProvider')) is v:t_dict
let a:conn.capabilities.definition = 1
let l:conn.capabilities.definition = 1
endif
if get(a:capabilities, 'typeDefinitionProvider') is v:true
let a:conn.capabilities.typeDefinition = 1
let l:conn.capabilities.typeDefinition = 1
endif
if type(get(a:capabilities, 'typeDefinitionProvider')) is v:t_dict
let a:conn.capabilities.typeDefinition = 1
let l:conn.capabilities.typeDefinition = 1
endif
if get(a:capabilities, 'implementationProvider') is v:true
let a:conn.capabilities.implementation = 1
let l:conn.capabilities.implementation = 1
endif
if type(get(a:capabilities, 'implementationProvider')) is v:t_dict
let a:conn.capabilities.implementation = 1
let l:conn.capabilities.implementation = 1
endif
" Check if the language server supports pull model diagnostics.
if type(get(a:capabilities, 'diagnosticProvider')) is v:t_dict
if type(get(a:capabilities.diagnosticProvider, 'interFileDependencies')) is v:t_bool
let l:conn.capabilities.pull_model = 1
endif
endif
if get(a:capabilities, 'workspaceSymbolProvider') is v:true
let a:conn.capabilities.symbol_search = 1
let l:conn.capabilities.symbol_search = 1
endif
if type(get(a:capabilities, 'workspaceSymbolProvider')) is v:t_dict
let a:conn.capabilities.symbol_search = 1
let l:conn.capabilities.symbol_search = 1
endif
if type(get(a:capabilities, 'textDocumentSync')) is v:t_dict
let l:syncOptions = get(a:capabilities, 'textDocumentSync')
if get(l:syncOptions, 'save') is v:true
let a:conn.capabilities.did_save = 1
let l:conn.capabilities.did_save = 1
endif
if type(get(l:syncOptions, 'save')) is v:t_dict
let a:conn.capabilities.did_save = 1
let l:conn.capabilities.did_save = 1
let l:saveOptions = get(l:syncOptions, 'save')
if get(l:saveOptions, 'includeText') is v:true
let a:conn.capabilities.includeText = 1
let l:conn.capabilities.includeText = 1
endif
endif
endif
@@ -313,13 +329,30 @@ function! ale#lsp#UpdateConfig(conn_id, buffer, config) abort
return 1
endfunction
function! ale#lsp#CallInitCallbacks(conn_id) abort
let l:conn = get(s:connections, a:conn_id, {})
if !empty(l:conn)
" Ensure the connection is marked as initialized.
" For integration with Neovim's LSP tooling this ensures immediately
" call OnInit functions in Vim after the `on_init` callback is called.
let l:conn.initialized = 1
" Call capabilities callbacks queued for the project.
for l:Callback in l:conn.init_queue
call l:Callback()
endfor
let l:conn.init_queue = []
endif
endfunction
function! ale#lsp#HandleInitResponse(conn, response) abort
if get(a:response, 'method', '') is# 'initialize'
let a:conn.initialized = 1
elseif type(get(a:response, 'result')) is v:t_dict
\&& has_key(a:response.result, 'capabilities')
call s:UpdateCapabilities(a:conn, a:response.result.capabilities)
call ale#lsp#UpdateCapabilities(a:conn.id, a:response.result.capabilities)
let a:conn.initialized = 1
endif
@@ -331,12 +364,7 @@ function! ale#lsp#HandleInitResponse(conn, response) abort
" The initialized message must be sent before everything else.
call ale#lsp#Send(a:conn.id, ale#lsp#message#Initialized())
" Call capabilities callbacks queued for the project.
for l:Callback in a:conn.init_queue
call l:Callback()
endfor
let a:conn.init_queue = []
call ale#lsp#CallInitCallbacks(a:conn.id)
endfunction
function! ale#lsp#HandleMessage(conn_id, message) abort
@@ -375,6 +403,20 @@ function! ale#lsp#HandleMessage(conn_id, message) abort
endif
endfunction
" Handle a JSON response from a language server.
" This is called from Lua for integration with Neovim's LSP API.
function! ale#lsp#HandleResponse(conn_id, response) abort
let l:conn = get(s:connections, a:conn_id, {})
if empty(l:conn)
return
endif
for l:Callback in l:conn.callback_list
call ale#util#GetFunction(l:Callback)(a:conn_id, a:response)
endfor
endfunction
" Given a connection ID, mark it as a tsserver connection, so it will be
" handled that way.
function! ale#lsp#MarkConnectionAsTsserver(conn_id) abort
@@ -452,6 +494,10 @@ function! s:SendInitMessage(conn) abort
\ 'dynamicRegistration': v:false,
\ 'linkSupport': v:false,
\ },
\ 'diagnostic': {
\ 'dynamicRegistration': v:true,
\ 'relatedDocumentSupport': v:true,
\ },
\ 'publishDiagnostics': {
\ 'relatedInformation': v:true,
\ },
@@ -482,6 +528,29 @@ function! ale#lsp#StartProgram(conn_id, executable, command) abort
let l:conn = s:connections[a:conn_id]
let l:started = 0
if g:ale_use_neovim_lsp_api && !l:conn.is_tsserver
" For Windows from 'cmd /s/c "foo bar"' we need 'foo bar'
let l:lsp_cmd = has('win32') && type(a:command) is v:t_string
\ ? ['cmd', '/s/c/', a:command[10:-2]]
\ : a:command
" Always call lsp.start, which will either create or re-use a
" connection. We'll set `attach` to `false` so we can later use
" our OpenDocument function to attach the buffer separately.
let l:client_id = luaeval('require("ale.lsp").start(_A)', {
\ 'name': a:conn_id,
\ 'cmd': l:lsp_cmd,
\ 'root_dir': l:conn.root,
\ 'init_options': l:conn.init_options,
\})
if l:client_id > 0
let l:conn.client_id = l:client_id
endif
return l:client_id > 0
endif
if !has_key(l:conn, 'job_id') || !ale#job#HasOpenChannel(l:conn.job_id)
let l:options = {
\ 'mode': 'raw',
@@ -512,6 +581,21 @@ function! ale#lsp#StartProgram(conn_id, executable, command) abort
return l:job_id > 0
endfunction
" Split an address into [host, port].
" The port will either be a number or v:null.
function! ale#lsp#SplitAddress(address) abort
let l:port_match = matchlist(a:address, '\v:(\d+)$')
if !empty(l:port_match)
let l:host = a:address[:-len(l:port_match[1]) - 2]
let l:port = l:port_match[1] + 0
return [l:host, l:port ? l:port : v:null]
endif
return [a:address, v:null]
endfunction
" Connect to an LSP server via TCP.
"
" 1 will be returned if the connection is running, or 0 if the connection could
@@ -520,7 +604,23 @@ function! ale#lsp#ConnectToAddress(conn_id, address) abort
let l:conn = s:connections[a:conn_id]
let l:started = 0
if !has_key(l:conn, 'channel_id') || !ale#socket#IsOpen(l:conn.channel_id)
if g:ale_use_neovim_lsp_api && !l:conn.is_tsserver
let [l:host, l:port] = ale#lsp#SplitAddress(a:address)
let l:client_id = luaeval('require("ale.lsp").start(_A)', {
\ 'name': a:conn_id,
\ 'host': l:host,
\ 'port': l:port,
\ 'root_dir': l:conn.root,
\ 'init_options': l:conn.init_options,
\})
if l:client_id > 0
let l:conn.client_id = l:client_id
endif
return l:client_id > 0
elseif !has_key(l:conn, 'channel_id') || !ale#socket#IsOpen(l:conn.channel_id)
let l:channel_id = ale#socket#Open(a:address, {
\ 'callback': {_, mess -> ale#lsp#HandleMessage(a:conn_id, mess)},
\})
@@ -606,26 +706,53 @@ function! ale#lsp#Send(conn_id, message) abort
throw 'LSP server not initialized yet!'
endif
if g:ale_use_neovim_lsp_api
return luaeval('require("ale.lsp").send_message(_A)', {
\ 'client_id': l:conn.client_id,
\ 'is_notification': a:message[0] == 1 ? v:true : v:false,
\ 'method': a:message[1],
\ 'params': get(a:message, 2, v:null)
\})
endif
let [l:id, l:data] = ale#lsp#CreateMessageData(a:message)
call s:SendMessageData(l:conn, l:data)
return l:id == 0 ? -1 : l:id
endfunction
function! ale#lsp#GetLanguage(conn_id, buffer) abort
let l:conn = get(s:connections, a:conn_id, {})
let l:Language = get(l:conn, 'language')
if empty(l:Language)
return getbufvar(a:buffer, '&filetype')
endif
return type(l:Language) is v:t_func ? l:Language(a:buffer) : l:Language
endfunction
" Notify LSP servers or tsserver if a document is opened, if needed.
" If a document is opened, 1 will be returned, otherwise 0 will be returned.
function! ale#lsp#OpenDocument(conn_id, buffer, language_id) abort
function! ale#lsp#OpenDocument(conn_id, buffer) abort
let l:conn = get(s:connections, a:conn_id, {})
let l:opened = 0
if !empty(l:conn) && !has_key(l:conn.open_documents, a:buffer)
if l:conn.is_tsserver
let l:message = ale#lsp#tsserver_message#Open(a:buffer)
call ale#lsp#Send(a:conn_id, l:message)
elseif g:ale_use_neovim_lsp_api
call luaeval('require("ale.lsp").buf_attach(_A)', {
\ 'bufnr': a:buffer,
\ 'client_id': l:conn.client_id,
\})
else
let l:message = ale#lsp#message#DidOpen(a:buffer, a:language_id)
let l:language_id = ale#lsp#GetLanguage(a:conn_id, a:buffer)
let l:message = ale#lsp#message#DidOpen(a:buffer, l:language_id)
call ale#lsp#Send(a:conn_id, l:message)
endif
call ale#lsp#Send(a:conn_id, l:message)
let l:conn.open_documents[a:buffer] = getbufvar(a:buffer, 'changedtick')
let l:opened = 1
endif
@@ -649,11 +776,17 @@ function! ale#lsp#CloseDocument(buffer) abort
if l:conn.initialized && has_key(l:conn.open_documents, a:buffer)
if l:conn.is_tsserver
let l:message = ale#lsp#tsserver_message#Close(a:buffer)
call ale#lsp#Send(l:conn_id, l:message)
elseif g:ale_use_neovim_lsp_api
call luaeval('require("ale.lsp").buf_detach(_A)', {
\ 'bufnr': a:buffer,
\ 'client_id': l:conn.client_id,
\})
else
let l:message = ale#lsp#message#DidClose(a:buffer)
call ale#lsp#Send(l:conn_id, l:message)
endif
call ale#lsp#Send(l:conn_id, l:message)
call remove(l:conn.open_documents, a:buffer)
let l:closed = 1
endif

View File

@@ -200,6 +200,14 @@ function! ale#lsp#message#CodeAction(buffer, line, column, end_line, end_column,
\}]
endfunction
function! ale#lsp#message#Diagnostic(buffer) abort
return [0, 'textDocument/diagnostic', {
\ 'textDocument': {
\ 'uri': ale#util#ToURI(expand('#' . a:buffer . ':p')),
\ },
\}]
endfunction
function! ale#lsp#message#ExecuteCommand(command, arguments) abort
return [0, 'workspace/executeCommand', {
\ 'command': a:command,

View File

@@ -21,11 +21,11 @@ let s:SEVERITY_WARNING = 2
let s:SEVERITY_INFORMATION = 3
let s:SEVERITY_HINT = 4
" Parse the message for textDocument/publishDiagnostics
function! ale#lsp#response#ReadDiagnostics(response) abort
" Convert Diagnostic[] data from a language server to an ALE loclist.
function! ale#lsp#response#ReadDiagnostics(diagnostics) abort
let l:loclist = []
for l:diagnostic in a:response.params.diagnostics
for l:diagnostic in a:diagnostics
let l:severity = get(l:diagnostic, 'severity', 0)
let l:loclist_item = {
\ 'text': substitute(l:diagnostic.message, '\(\r\n\|\n\|\r\)', ' ', 'g'),

View File

@@ -23,6 +23,26 @@ function! ale#lsp_linter#SetLSPLinterMap(replacement_map) abort
let s:lsp_linter_map = a:replacement_map
endfunction
" A map for tracking URIs for diagnostic request IDs
if !has_key(s:, 'diagnostic_uri_map')
let s:diagnostic_uri_map = {}
endif
" For internal use only.
function! ale#lsp_linter#ClearDiagnosticURIMap() abort
let s:diagnostic_uri_map = {}
endfunction
" For internal use only.
function! ale#lsp_linter#GetDiagnosticURIMap() abort
return s:diagnostic_uri_map
endfunction
" Just for tests.
function! ale#lsp_linter#SetDiagnosticURIMap(replacement_map) abort
let s:diagnostic_uri_map = a:replacement_map
endfunction
" Get all enabled LSP linters.
" This list still includes linters ignored with `ale_linters_ignore`.
"
@@ -77,14 +97,17 @@ function! s:ShouldIgnoreDiagnostics(buffer, linter) abort
return 0
endfunction
function! s:HandleLSPDiagnostics(conn_id, response) abort
" Handle LSP diagnostics for a given URI.
" The special value 'unchanged' can be used for diagnostics to indicate
" that diagnostics haven't changed since we last checked.
function! ale#lsp_linter#HandleLSPDiagnostics(conn_id, uri, diagnostics) abort
let l:linter = get(s:lsp_linter_map, a:conn_id)
if empty(l:linter)
return
endif
let l:filename = ale#util#ToResource(a:response.params.uri)
let l:filename = ale#util#ToResource(a:uri)
let l:escaped_name = escape(
\ fnameescape(l:filename),
\ has('win32') ? '^' : '^,}]'
@@ -100,9 +123,12 @@ function! s:HandleLSPDiagnostics(conn_id, response) abort
return
endif
let l:loclist = ale#lsp#response#ReadDiagnostics(a:response)
call ale#engine#HandleLoclist(l:linter.name, l:buffer, l:loclist, 0)
if a:diagnostics is# 'unchanged'
call ale#engine#MarkLinterInactive(l:info, l:linter)
else
let l:loclist = ale#lsp#response#ReadDiagnostics(a:diagnostics)
call ale#engine#HandleLoclist(l:linter.name, l:buffer, l:loclist, 0)
endif
endfunction
function! s:HandleTSServerDiagnostics(response, error_type) abort
@@ -204,7 +230,17 @@ function! ale#lsp_linter#HandleLSPResponse(conn_id, response) abort
call s:HandleLSPErrorMessage(l:linter, a:response)
elseif l:method is# 'textDocument/publishDiagnostics'
call s:HandleLSPDiagnostics(a:conn_id, a:response)
let l:uri = a:response.params.uri
let l:diagnostics = a:response.params.diagnostics
call ale#lsp_linter#HandleLSPDiagnostics(a:conn_id, l:uri, l:diagnostics)
elseif has_key(s:diagnostic_uri_map, get(a:response, 'id'))
let l:uri = remove(s:diagnostic_uri_map, a:response.id)
let l:diagnostics = a:response.result.kind is# 'unchanged'
\ ? 'unchanged'
\ : a:response.result.items
call ale#lsp_linter#HandleLSPDiagnostics(a:conn_id, l:uri, l:diagnostics)
elseif l:method is# 'window/showMessage'
call ale#lsp_window#HandleShowMessage(
\ s:lsp_linter_map[a:conn_id].name,
@@ -219,7 +255,7 @@ function! ale#lsp_linter#HandleLSPResponse(conn_id, response) abort
call s:HandleTSServerDiagnostics(a:response, 'syntax')
elseif get(a:response, 'type', '') is# 'event'
\&& get(a:response, 'event', '') is# 'suggestionDiag'
\&& get(g:, 'ale_lsp_suggestions', '1') == 1
\&& get(g:, 'ale_lsp_suggestions')
call s:HandleTSServerDiagnostics(a:response, 'suggestion')
endif
endfunction
@@ -306,11 +342,10 @@ function! ale#lsp_linter#OnInit(linter, details, Callback) abort
let l:command = a:details.command
let l:config = ale#lsp_linter#GetConfig(l:buffer, a:linter)
let l:language_id = ale#linter#GetLanguage(l:buffer, a:linter)
call ale#lsp#UpdateConfig(l:conn_id, l:buffer, l:config)
if ale#lsp#OpenDocument(l:conn_id, l:buffer, l:language_id)
if ale#lsp#OpenDocument(l:conn_id, l:buffer)
if g:ale_history_enabled && !empty(l:command)
call ale#history#Add(l:buffer, 'started', l:conn_id, l:command)
endif
@@ -357,11 +392,21 @@ function! s:StartLSP(options, address, executable, command) abort
let l:init_options = ale#lsp_linter#GetOptions(l:buffer, l:linter)
if l:linter.lsp is# 'socket'
let l:conn_id = ale#lsp#Register(a:address, l:root, l:init_options)
let l:conn_id = ale#lsp#Register(
\ a:address,
\ l:root,
\ l:linter.language,
\ l:init_options
\)
let l:ready = ale#lsp#ConnectToAddress(l:conn_id, a:address)
let l:command = ''
else
let l:conn_id = ale#lsp#Register(a:executable, l:root, l:init_options)
let l:conn_id = ale#lsp#Register(
\ a:executable,
\ l:root,
\ l:linter.language,
\ l:init_options
\)
" tsserver behaves differently, so tell the LSP API that it is tsserver.
if l:linter.lsp is# 'tsserver'
@@ -511,17 +556,33 @@ function! s:CheckWithLSP(linter, details) abort
if l:notified
call ale#engine#MarkLinterActive(l:info, a:linter)
endif
else
elseif !g:ale_use_neovim_lsp_api
let l:notified = ale#lsp#NotifyForChanges(l:id, l:buffer)
endif
" If this was a file save event, also notify the server of that.
if a:linter.lsp isnot# 'tsserver'
\&& getbufvar(l:buffer, 'ale_save_event_fired', 0)
\&& ale#lsp#HasCapability(l:id, 'did_save')
let l:include_text = ale#lsp#HasCapability(l:id, 'includeText')
let l:save_message = ale#lsp#message#DidSave(l:buffer, l:include_text)
let l:notified = ale#lsp#Send(l:id, l:save_message) != 0
" If this was a file save event, also notify the server of that.
if getbufvar(l:buffer, 'ale_save_event_fired', 0)
\&& ale#lsp#HasCapability(l:id, 'did_save')
let l:include_text = ale#lsp#HasCapability(l:id, 'includeText')
let l:save_message = ale#lsp#message#DidSave(l:buffer, l:include_text)
let l:notified = ale#lsp#Send(l:id, l:save_message) != 0
endif
let l:diagnostic_request_id = 0
" If the document is updated and we can pull diagnostics, try to.
if ale#lsp#HasCapability(l:id, 'pull_model')
let l:diagnostic_message = ale#lsp#message#Diagnostic(l:buffer)
let l:diagnostic_request_id = ale#lsp#Send(l:id, l:diagnostic_message)
endif
" If we are going to pull diagnostics, then mark the linter as active,
" and remember the URI we sent the request for.
if l:diagnostic_request_id
call ale#engine#MarkLinterActive(l:info, a:linter)
let s:diagnostic_uri_map[l:diagnostic_request_id] =
\ l:diagnostic_message[2].textDocument.uri
endif
endif
endfunction

View File

@@ -4,6 +4,7 @@
" Find project root for a Lua language server.
function! ale#lua#FindProjectRoot(buffer) abort
let l:possible_project_roots = [
\ '.luarc.json',
\ '.git',
\ bufname(a:buffer),
\]

View File

@@ -17,8 +17,8 @@ function! ale#rename#ClearLSPData() abort
let s:rename_map = {}
endfunction
let g:ale_rename_tsserver_find_in_comments = get(g:, 'ale_rename_tsserver_find_in_comments')
let g:ale_rename_tsserver_find_in_strings = get(g:, 'ale_rename_tsserver_find_in_strings')
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', v:false)
function! s:message(message) abort
call ale#util#Execute('echom ' . string(a:message))

View File

@@ -7,7 +7,7 @@ scriptencoding utf8
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
" 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.
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)
@@ -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.
let g:ale_sign_offset = get(g:, 'ale_sign_offset', 1000000)
" 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_highlight_linenrs = get(g:, 'ale_sign_highlight_linenrs', 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', v:false)
let s:supports_sign_groups = has('nvim-0.4.2') || has('patch-8.1.614')

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_maxcolumn = get(g:, 'ale_virtualtext_maxcolumn', 0)
" 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:last_pos = get(s:, 'last_pos', [0, 0, 0])

View File

@@ -7,19 +7,25 @@ cspell *ale-ada-cspell*
See |ale-cspell-options|
===============================================================================
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*
ada_gcc_executable
g:ale_ada_gcc_executable
Type: |String|
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.
g:ale_ada_gcc_options *g:ale_ada_gcc_options*
*ale-options.ada_gcc_options*
*g:ale_ada_gcc_options*
*b:ale_ada_gcc_options*
ada_gcc_options
g:ale_ada_gcc_options
Type: |String|
Default: `'-gnatwa -gnatq'`
@@ -29,8 +35,11 @@ g:ale_ada_gcc_options *g:ale_ada_gcc_options*
===============================================================================
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*
ada_gnatpp_options
g:ale_ada_gnatpp_options
Type: |String|
Default: `''`
@@ -40,31 +49,38 @@ g:ale_ada_gnatpp_options *g:ale_ada_gnatpp_options*
===============================================================================
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*
ada_adals_executable
g:ale_ada_adals_executable
Type: |String|
Default: `'ada_language_server'`
This variable can be changed to use a different executable for Ada Language
Server.
g:ale_ada_adals_project *g:ale_ada_adals_project*
*ale-options.ada_adals_project*
*g:ale_ada_adals_project*
*b:ale_ada_adals_project*
ada_adals_project
g:ale_ada_adals_project
Type: |String|
Default: `'default.gpr'`
This variable can be changed to use a different GPR file for
Ada Language Server.
This variable can be changed to use a different GPR file for Ada Language
Server.
g:ale_ada_adals_encoding *g:ale_ada_adals_encoding*
*ale-options.ada_adals_encoding*
*g:ale_ada_adals_encoding*
*b:ale_ada_adals_encoding*
ada_adals_encoding
g:ale_ada_adals_encoding
Type: |String|
Default: `'utf-8'`
This variable can be changed to use a different file encoding for
Ada Language Server.
This variable can be changed to use a different file encoding for Ada
Language Server.
===============================================================================

View File

@@ -1,34 +1,43 @@
===============================================================================
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*
*b:ale_ansible_language_server*
*ale-options.ansible_language_server_executable*
*g:ale_ansible_language_server_executable*
*b:ale_ansible_language_server_executable*
ansible_language_server_executable
g:ale_ansible_language_server_executable
Type: |String|
Default: 'ansible-language-server'
Default: `'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*
Variable can be used to modify the executable used for Ansible language
server.
*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|
Default: '{}'
Default: `'{}'`
Configuration parameters sent to the language server on start. Refer to the
ansible language server configuration documentation for list of available
options: https://als.readthedocs.io/en/latest/settings/
===============================================================================
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*
ansible_ansible_lint_executable
g:ale_ansible_ansible_lint_executable
Type: |String|
Default: `'ansible-lint'`

View File

@@ -5,27 +5,33 @@ ALE APKBUILD Integration *ale-apkbuild-options*
===============================================================================
apkbuild-fixer *ale-apkbuild-apkbuild-fixer*
g:apkbuild_apkbuild_fixer_options *g:apkbuild_apkbuild_fixer_options*
*b:apkbuild_apkbuild_fixer_options*
*ale-options.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|
Default: `''`
This variable can be set to pass additional options to the apkbuild_fixer
fixer.
g:apkbuild_apkbuild_fixer_executable *g:apkbuild_apkbuild_fixer_executable*
*b:apkbuild_apkbuild_fixer_executable*
*ale-options.apkbuild_apkbuild_fixer_executable*
*g:ale_apkbuild_apkbuild_fixer_executable*
*b:ale_apkbuild_apkbuild_fixer_executable*
apkbuild_apkbuild_fixer_executable
g:ale_apkbuild_apkbuild_fixer_executable
Type: |String|
Default: `'apkbuild-fixer'`
This variable can be modified to change the executable path for
`apkbuild-fixer`.
g:apkbuild_apkbuild_fixer_lint_executable
*g:apkbuild_apkbuild_fixer_lint_executable*
*b:apkbuild_apkbuild_fixer_lint_executable*
*ale-options.apkbuild_apkbuild_fixer_lint_executable*
*g:ale_apkbuild_apkbuild_fixer_lint_executable*
*b:ale_apkbuild_apkbuild_fixer_lint_executable*
apkbuild_apkbuild_fixer_lint_executable
g:ale_apkbuild_apkbuild_fixer_lint_executable
Type: |String|
Default: `'apkbuild-fixer'`
@@ -36,26 +42,30 @@ g:apkbuild_apkbuild_fixer_lint_executable
===============================================================================
apkbuild-lint *ale-apkbuild-apkbuild-lint*
g:ale_apkbuild_apkbuild_lint_executable
*ale-options.apkbuild_apkbuild_lint_executable*
*g:ale_apkbuild_apkbuild_lint_executable*
*b:ale_apkbuild_apkbuild_lint_executable*
apkbuild_apkbuild_lint_executable
g:ale_apkbuild_apkbuild_lint_executable
Type: |String|
Default: `'apkbuild-lint'`
This variable can be set to change the path to apkbuild-lint
===============================================================================
secfixes-check *ale-apkbuild-secfixes-check*
g:ale_apkbuild_secfixes_check_executable
*ale-options.apkbuild_secfixes_check_executable*
*g:ale_apkbuild_secfixes_check_executable*
*b:ale_apkbuild_secfixes_check_executable*
apkbuild_secfixes_check_executable
g:ale_apkbuild_secfixes_check_executable
Type: |String|
Default: `'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:

View File

@@ -5,16 +5,21 @@ ALE ASM Integration *ale-asm-options*
===============================================================================
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*
asm_gcc_executable
g:ale_asm_gcc_executable
Type: |String|
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.
g:ale_asm_gcc_options *g:ale_asm_gcc_options*
*ale-options.asm_gcc_options*
*g:ale_asm_gcc_options*
*b:ale_asm_gcc_options*
asm_gcc_options
g:ale_asm_gcc_options
Type: |String|
Default: `'-Wall'`
@@ -24,16 +29,21 @@ g:ale_asm_gcc_options *g:ale_asm_gcc_options*
===============================================================================
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*
asm_llvm_mc_executable
g:ale_asm_llvm_mc_executable
Type: |String|
Default: `'llvm-mc'`
This variable can be changed to use a different executable for llvm-mc.
g:ale_asm_clang_options *g:ale_asm_llvm_mc_options*
*ale-options.asm_llvm_mc_options*
*g:ale_asm_llvm_mc_options*
*b:ale_asm_llvm_mc_options*
asm_llvm_mc_options
g:ale_asm_llvm_mc_options
Type: |String|
Default: `''`

View File

@@ -5,17 +5,21 @@ ALE AVRA Integration *ale-avra-options*
===============================================================================
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*
avra_avra_executable
g:ale_avra_avra_executable
Type: |String|
Default `'avra'`
This variable can be changed to use different executable for AVRA.
g:ale_avra_avra_options *g:ale_avra_avra_options*
*ale-options.avra_avra_options*
*g:ale_avra_avra_options*
*b:ale_avra_avra_options*
avra_avra_options
g:ale_avra_avra_options
Type: |String|
Default: `''`

View File

@@ -5,21 +5,27 @@ ALE Awk Integration *ale-awk-options*
===============================================================================
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*
awk_gawk_executable
g:ale_awk_gawk_executable
Type: |String|
Default: `'gawk'`
This variable sets executable used for gawk.
g:ale_awk_gawk_options *g:ale_awk_gawk_options*
*ale-options.awk_gawk_options*
*g:ale_awk_gawk_options*
*b:ale_awk_gawk_options*
awk_gawk_options
g:ale_awk_gawk_options
Type: |String|
Default: `''`
With this variable we are able to pass extra arguments for gawk
for invocation.
With this variable we are able to pass extra arguments for gawk for
invocation.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -4,25 +4,36 @@ ALE Bazel Integration *ale-bazel-options*
===============================================================================
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*
bazel_buildifier_executable
g:ale_bazel_buildifier_executable
Type: |String|
Default: `'buildifier'`
See |ale-integrations-local-executables|
g:ale_bazel_buildifier_options *g:ale_bazel_buildifier_options*
*ale-options.bazel_buildifier_options*
*g:ale_bazel_buildifier_options*
*b:ale_bazel_buildifier_options*
bazel_buildifier_options
g:ale_bazel_buildifier_options
Type: |String|
Default: `''`
This variable can be set to pass extra options to buildifier.
g:ale_bazel_buildifier_use_global *g:ale_bazel_buildifier_use_global*
*ale-options.bazel_buildifier_use_global*
*g:ale_bazel_buildifier_use_global*
*b:ale_bazel_buildifier_use_global*
bazel_buildifier_use_global
g:ale_bazel_buildifier_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -5,15 +5,22 @@ ALE BibTeX Integration *ale-bib-options*
===============================================================================
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|
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|
Default: `'-align-equals'`
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

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*
*b:ale_bicep_bicep_executable*
*ale-options.bicep_bicep_executable*
*g:ale_bicep_bicep_executable*
*b:ale_bicep_bicep_executable*
bicep_bicep_executable
g:ale_bicep_bicep_executable
Type: |String|
Default: `'bicep'`
This variable can be set to change the path to bicep.
g:ale_bicep_bicep_options *g:ale_bicep_bicep_options*
*b:ale_bicep_bicep_options*
*ale-options.bicep_bicep_options*
*g:ale_bicep_bicep_options*
*b:ale_bicep_bicep_options*
bicep_bicep_options
g:ale_bicep_bicep_options
Type: |String|
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*
*b:ale_bicep_az_bicep_executable*
*ale-options.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|
Default: `'az'`
This variable can be set to change the path to az_bicep.
g:ale_bicep_az_bicep_options *g:ale_bicep_az_bicep_options*
*b:ale_bicep_az_bicep_options*
*ale-options.bicep_az_bicep_options*
*g:ale_bicep_az_bicep_options*
*b:ale_bicep_az_bicep_options*
bicep_az_bicep_options
g:ale_bicep_az_bicep_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to az_bicep.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -5,22 +5,31 @@ ALE BitBake Integration *ale-bitbake-options*
===============================================================================
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|
Default: `'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|
Default: `''`
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|
Default: `'.oelint.cfg'`

View File

@@ -7,9 +7,11 @@ runs either `clang`, or `gcc`. See |ale-c-cc|.
===============================================================================
Global Options
g:ale_c_always_make *g:ale_c_always_make*
*ale-options.c_always_make*
*g:ale_c_always_make*
*b:ale_c_always_make*
c_always_make
g:ale_c_always_make
Type: |Number|
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
a BSD variant.
g:ale_c_build_dir_names *g:ale_c_build_dir_names*
*ale-options.c_build_dir_names*
*g:ale_c_build_dir_names*
*b:ale_c_build_dir_names*
c_build_dir_names
g:ale_c_build_dir_names
Type: |List|
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
LibTooling (namely here, clang-tidy)
g:ale_c_build_dir *g:ale_c_build_dir*
*ale-options.c_build_dir*
*g:ale_c_build_dir*
*b:ale_c_build_dir*
c_build_dir
g:ale_c_build_dir
Type: |String|
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|.
g:ale_c_parse_compile_commands *g:ale_c_parse_compile_commands*
*ale-options.c_parse_compile_commands*
*g:ale_c_parse_compile_commands*
*b:ale_c_parse_compile_commands*
c_parse_compile_commands
g:ale_c_parse_compile_commands
Type: |Number|
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
|g:ale_c_build_dir_names|.
g:ale_c_parse_makefile *g:ale_c_parse_makefile*
*ale-options.c_parse_makefile*
*g:ale_c_parse_makefile*
*b:ale_c_parse_makefile*
c_parse_makefile
g:ale_c_parse_makefile
Type: |Number|
Default: `0`
@@ -91,16 +99,21 @@ g:ale_c_parse_makefile *g:ale_c_parse_makefile*
===============================================================================
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*
c_astyle_executable
g:ale_c_astyle_executable
Type: |String|
Default: `'astyle'`
This variable can be changed to use a different executable for astyle.
g:ale_c_astyle_project_options *g:ale_c_astyle_project_options*
*ale-options.c_astyle_project_options*
*g:ale_c_astyle_project_options*
*b:ale_c_astyle_project_options*
c_astyle_project_options
g:ale_c_astyle_project_options
Type: |String|
Default: `''`
@@ -117,8 +130,11 @@ cc *ale-c-cc*
*ale-c-gcc*
*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*
c_cc_executable
g:ale_c_cc_executable
Type: |String|
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
default to checking C code with `gcc`.
g:ale_c_cc_options *g:ale_c_cc_options*
*ale-options.c_cc_options*
*g:ale_c_cc_options*
*b:ale_c_cc_options*
c_cc_options
g:ale_c_cc_options
Type: |String|
Default: `'-std=c11 -Wall'`
This variable can be changed to modify flags given to the C compiler.
g:ale_c_cc_use_header_lang_flag *g:ale_c_cc_use_header_lang_flag*
*ale-options.c_cc_use_header_lang_flag*
*g: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|
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'`
with Clang.
g:ale_c_cc_header_exts *g:ale_c_cc_header_exts*
*ale-options.c_cc_header_exts*
*g:ale_c_cc_header_exts*
*b:ale_c_cc_header_exts*
c_cc_header_exts
g:ale_c_cc_header_exts
Type: |List|
Default: `['h']`
@@ -174,29 +196,35 @@ g:ale_c_cc_header_exts *g:ale_c_cc_header_exts*
===============================================================================
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*
c_ccls_executable
g:ale_c_ccls_executable
Type: |String|
Default: `'ccls'`
This variable can be changed to use a different executable for ccls.
g:ale_c_ccls_init_options *g:ale_c_ccls_init_options*
*ale-options.c_ccls_init_options*
*g:ale_c_ccls_init_options*
*b:ale_c_ccls_init_options*
c_ccls_init_options
g:ale_c_ccls_init_options
Type: |Dictionary|
Default: `{}`
This variable can be changed to customize ccls initialization options.
Example: >
{
\ 'cacheDirectory': '/tmp/ccls',
\ 'cacheFormat': 'binary',
\ 'diagnostics': {
\ 'onOpen': 0,
\ 'opChange': 1000,
\ },
\ }
For example: >
let g:ale_c_ccls_init_options = {
\ 'cacheDirectory': '/tmp/ccls',
\ 'cacheFormat': 'binary',
\ 'diagnostics': {
\ 'onOpen': 0,
\ 'opChange': 1000,
\ },
\}
<
For all available options and explanations, visit
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|.
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*
c_clangcheck_executable
g:ale_c_clangcheck_executable
Type: |String|
Default: `'clang-check'`
This variable can be changed to use a different executable for clangcheck.
g:ale_c_clangcheck_options *g:ale_c_clangcheck_options*
*ale-options.c_clangcheck_options*
*g:ale_c_clangcheck_options*
*b:ale_c_clangcheck_options*
c_clangcheck_options
g:ale_c_clangcheck_options
Type: |String|
Default: `''`
@@ -236,16 +271,21 @@ g:ale_c_clangcheck_options *g:ale_c_clangcheck_options*
===============================================================================
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*
c_clangd_executable
g:ale_c_clangd_executable
Type: |String|
Default: `'clangd'`
This variable can be changed to use a different executable for clangd.
g:ale_c_clangd_options *g:ale_c_clangd_options*
*ale-options.c_clangd_options*
*g:ale_c_clangd_options*
*b:ale_c_clangd_options*
c_clangd_options
g:ale_c_clangd_options
Type: |String|
Default: `''`
@@ -255,24 +295,31 @@ g:ale_c_clangd_options *g:ale_c_clangd_options*
===============================================================================
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*
c_clangformat_executable
g:ale_c_clangformat_executable
Type: |String|
Default: `'clang-format'`
This variable can be changed to use a different executable for clang-format.
g:ale_c_clangformat_options *g:ale_c_clangformat_options*
*ale-options.c_clangformat_options*
*g:ale_c_clangformat_options*
*b:ale_c_clangformat_options*
c_clangformat_options
g:ale_c_clangformat_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clang-format.
g:ale_c_clangformat_style_option *g:ale_c_clangformat_style_option*
*ale-options.c_clangformat_style_option*
*g:ale_c_clangformat_style_option*
*b:ale_c_clangformat_style_option*
c_clangformat_style_option
g:ale_c_clangformat_style_option
Type: |String|
Default: `''`
@@ -281,19 +328,21 @@ g:ale_c_clangformat_style_option *g:ale_c_clangformat_style_option*
flag of clang-format.
Example: >
{
\ BasedOnStyle: Microsoft,
\ ColumnLimit: 80,
\ AllowShortBlocksOnASingleLine: Always,
\ AllowShortFunctionsOnASingleLine: Inline,
\ }
let g:ale_c_clangformat_style_option = {
\ 'BasedOnStyle': 'Microsoft',
\ 'ColumnLimit': 80,
\ 'AllowShortBlocksOnASingleLine': 'Always',
\ 'AllowShortFunctionsOnASingleLine': 'Inline',
\}
<
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_use_local_file *g:ale_c_clangformat_use_local_file*
*ale-options.c_clangformat_use_local_file*
*g: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|
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|.
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*
c_clangtidy_checks
g:ale_c_clangtidy_checks
Type: |List|
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:
http://clang.llvm.org/extra/clang-tidy/checks/list.html
g:ale_c_clangtidy_executable *g:ale_c_clangtidy_executable*
*ale-options.c_clangtidy_executable*
*g:ale_c_clangtidy_executable*
*b:ale_c_clangtidy_executable*
c_clangtidy_executable
g:ale_c_clangtidy_executable
Type: |String|
Default: `'clang-tidy'`
This variable can be changed to use a different executable for clangtidy.
g:ale_c_clangtidy_options *g:ale_c_clangtidy_options*
*ale-options.c_clangtidy_options*
*g:ale_c_clangtidy_options*
*b:ale_c_clangtidy_options*
c_clangtidy_options
g:ale_c_clangtidy_options
Type: |String|
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
of the |g:ale_c_build_dir_names| directories of the project tree.
g:ale_c_clangtidy_extra_options *g:ale_c_clangtidy_extra_options*
*ale-options.c_clangtidy_extra_options*
*g:ale_c_clangtidy_extra_options*
*b:ale_c_clangtidy_extra_options*
c_clangtidy_extra_options
g:ale_c_clangtidy_extra_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clang-tidy.
g:ale_c_clangtidy_fix_errors *g:ale_c_clangtidy_fix_errors*
*ale-options.c_clangtidy_fix_errors*
*g:ale_c_clangtidy_fix_errors*
*b:ale_c_clangtidy_fix_errors*
c_clangtidy_fix_errors
g:ale_c_clangtidy_fix_errors
Type: |Number|
Default: `1`
@@ -382,16 +444,21 @@ g:ale_c_clangtidy_fix_errors *g:ale_c_clangtidy_fix_errors*
===============================================================================
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*
c_cppcheck_executable
g:ale_c_cppcheck_executable
Type: |String|
Default: `'cppcheck'`
This variable can be changed to use a different executable for cppcheck.
g:ale_c_cppcheck_options *g:ale_c_cppcheck_options*
*ale-options.c_cppcheck_options*
*g:ale_c_cppcheck_options*
*b:ale_c_cppcheck_options*
c_cppcheck_options
g:ale_c_cppcheck_options
Type: |String|
Default: `'--enable=style'`
@@ -401,21 +468,26 @@ g:ale_c_cppcheck_options *g:ale_c_cppcheck_options*
===============================================================================
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*
c_cquery_executable
g:ale_c_cquery_executable
Type: |String|
Default: `'cquery'`
This variable can be changed to use a different executable for cquery.
g:ale_c_cquery_cache_directory *g:ale_c_cquery_cache_directory*
*ale-options.c_cquery_cache_directory*
*g:ale_c_cquery_cache_directory*
*b:ale_c_cquery_cache_directory*
c_cquery_cache_directory
g:ale_c_cquery_cache_directory
Type: |String|
Default: `'~/.cache/cquery'`
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*
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*
c_flawfinder_executable
g:ale_c_flawfinder_executable
Type: |String|
Default: `'flawfinder'`
This variable can be changed to use a different executable for flawfinder.
g:ale_c_flawfinder_minlevel *g:ale_c_flawfinder_minlevel*
*ale-options.c_flawfinder_minlevel*
*g:ale_c_flawfinder_minlevel*
*b:ale_c_flawfinder_minlevel*
c_flawfinder_minlevel
g:ale_c_flawfinder_minlevel
Type: |Number|
Default: `1`
This variable can be changed to ignore risks under the given risk threshold.
g:ale_c_flawfinder_options *g:ale-c-flawfinder*
*ale-options.c_flawfinder_options*
*g:ale_c_flawfinder_options*
*b:ale-c-flawfinder*
c_flawfinder_options
g:ale_c_flawfinder_options
Type: |String|
Default: `''`
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*
c_flawfinder_error_severity
g:ale_c_flawfinder_error_severity
Type: |Number|
Default: `6`
@@ -462,16 +544,21 @@ g:ale_c_flawfinder_error_severity *g:ale_c_flawfinder_error_severity*
===============================================================================
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*
c_uncrustify_executable
g:ale_c_uncrustify_executable
Type: |String|
Default: `'uncrustify'`
This variable can be changed to use a different executable for uncrustify.
g:ale_c_uncrustify_options *g:ale_c_uncrustify_options*
*ale-options.c_uncrustify_options*
*g:ale_c_uncrustify_options*
*b:ale_c_uncrustify_options*
c_uncrustify_options
g:ale_c_uncrustify_options
Type: |String|
Default: `''`

View File

@@ -4,26 +4,32 @@ ALE C3 Integration *ale-c3-options*
===============================================================================
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*
c3_c3lsp_executable
g:ale_c3_c3lsp_executable
Type: |String|
Default: `c3lsp`
This variable can be changed to set the path to c3lsp executable.
g:ale_c3_c3lsp_options *g:ale_c3_c3lsp_options*
*ale-options.c3_c3lsp_options*
*g:ale_c3_c3lsp_options*
*b:ale_c3_c3lsp_options*
c3_c3lsp_options
g:ale_c3_c3lsp_options
Type: |String|
Default: `''`
Add command line options to the c3lsp executable. This is useful to specify
the path to the C3 standard library with '-stdlib-path=<path>'.
g:ale_c3_c3lsp_init_options *g:ale_c3_c3lsp_init_options*
*ale-options.c3_c3lsp_init_options*
*g:ale_c3_c3lsp_init_options*
*b:ale_c3_c3lsp_init_options*
c3_c3lsp_init_options
g:ale_c3_c3lsp_init_options
Type: |Dictionary|
Default: `{}`

View File

@@ -5,9 +5,12 @@ ALE Cairo Integration *ale-cairo-options*
===============================================================================
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*
cairo_scarb_executable
g:ale_cairo_scarb_executable
Type: |String|
Default: `'scarb build'`
For Cairo1 projects using Scarb
@@ -18,13 +21,18 @@ g:ale_cairo_scarb_executable *g:ale_cairo_scarb_executable*
===============================================================================
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*
cairo_starknet_executable
g:ale_cairo_starknet_executable
Type: |String|
Default: `'starknet-compile'`
Overrides the starknet-compile binary after installing the cairo-language.
For more information read 'https://starknet.io/docs/quickstart.html'
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -5,16 +5,21 @@ ALE Chef Integration *ale-chef-options*
===============================================================================
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*
chef_cookstyle_options
g:ale_chef_cookstyle_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to cookstyle.
g:ale_chef_cookstyle_executable *g:ale_chef_cookstyle_executable*
*ale-options.chef_cookstyle_executable*
*g:ale_chef_cookstyle_executable*
*b:ale_chef_cookstyle_executable*
chef_cookstyle_executable
g:ale_chef_cookstyle_executable
Type: |String|
Default: `'cookstyle'`
@@ -25,16 +30,21 @@ g:ale_chef_cookstyle_executable *g:ale_chef_cookstyle_executable*
===============================================================================
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*
chef_foodcritic_options
g:ale_chef_foodcritic_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to foodcritic.
g:ale_chef_foodcritic_executable *g:ale_chef_foodcritic_executable*
*ale-options.chef_foodcritic_executable*
*g:ale_chef_foodcritic_executable*
*b:ale_chef_foodcritic_executable*
chef_foodcritic_executable
g:ale_chef_foodcritic_executable
Type: |String|
Default: `'foodcritic'`

View File

@@ -9,13 +9,20 @@ A minimal and opinionated linter for code that sparks joy.
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*
clojure_clj_kondo_options
g:ale_clojure_clj_kondo_options
Type: |String|
Default: `'--cache'`
This variable can be changed to modify options passed to clj-kondo.
===============================================================================
cljfmt *ale-clojure-cljfmt*
@@ -43,6 +50,6 @@ directory.
see https://github.com/candid82/joker#linter-mode for more information.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

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.
Website: https://github.com/awslabs/cfn-python-lint
Installation
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
Installation
Install cfn-python-lint using either pip or brew: >
`pip install cfn-lint`. If pip is not available, run
`python setup.py clean --all` then `python setup.py install`.
Homebrew (macOS):
`brew install cfn-lint`
pip 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
the buffer |filetype| to yaml.cloudformation.
This causes ALE to lint the file with linters configured for cloudformation and
yaml files.
To get cloudformation linter to work on only CloudFormation files we must set
the buffer |filetype| to `yaml.cloudformation`. This causes ALE to lint the
file with linters configured for cloudformation and 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:

View File

@@ -5,16 +5,21 @@ ALE CMake Integration *ale-cmake-options*
===============================================================================
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*
cmake_cmakelint_executable
g:ale_cmake_cmakelint_executable
Type: |String|
Default: `'cmakelint'`
This variable can be set to change the path the cmakelint.
g:ale_cmake_cmakelint_options *g:ale_cmake_cmakelint_options*
*ale-options.cmake_cmakelint_options*
*g:ale_cmake_cmakelint_options*
*b:ale_cmake_cmakelint_options*
cmake_cmakelint_options
g:ale_cmake_cmakelint_options
Type: |String|
Default: `''`
@@ -24,16 +29,21 @@ g:ale_cmake_cmakelint_options *g:ale_cmake_cmakelint_options*
===============================================================================
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*
cmake_cmake_lint_executable
g:ale_cmake_cmake_lint_executable
Type: |String|
Default: `'cmake-lint'`
This variable can be set to change the path the cmake-lint.
g:ale_cmake_cmake_lint_options *g:ale_cmake_cmake_lint_options*
*ale-options.cmake_cmake_lint_options*
*g:ale_cmake_cmake_lint_options*
*b:ale_cmake_cmake_lint_options*
cmake_cmake_lint_options
g:ale_cmake_cmake_lint_options
Type: |String|
Default: `''`
@@ -43,20 +53,26 @@ g:ale_cmake_cmake_lint_options *g:ale_cmake_cmake_lint_options*
===============================================================================
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*
cmake_cmakeformat_executable
g:ale_cmake_cmakeformat_executable
Type: |String|
Default: `'cmakeformat'`
This variable can be set to change the path the cmake-format.
g:ale_cmake_cmakeformat_options *g:ale_cmake_cmakeformat_options*
*ale-options.cmake_cmakeformat_options*
*g:ale_cmake_cmakeformat_options*
*b:ale_cmake_cmakeformat_options*
cmake_cmakeformat_options
g:ale_cmake_cmakeformat_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to cmake-format.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -20,16 +20,21 @@ The following C options also apply to some C++ linters too.
===============================================================================
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*
cpp_astyle_executable
g:ale_cpp_astyle_executable
Type: |String|
Default: `'astyle'`
This variable can be changed to use a different executable for astyle.
g:ale_cpp_astyle_project_options *g:ale_cpp_astyle_project_options*
*ale-options.cpp_astyle_project_options*
*g:ale_cpp_astyle_project_options*
*b:ale_cpp_astyle_project_options*
cpp_astyle_project_options
g:ale_cpp_astyle_project_options
Type: |String|
Default: `''`
@@ -46,8 +51,11 @@ cc *ale-cpp-cc*
*ale-cpp-gcc*
*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*
cpp_cc_executable
g:ale_cpp_cc_executable
Type: |String|
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
default to checking C++ code with `gcc`.
g:ale_cpp_cc_options *g:ale_cpp_cc_options*
*ale-options.cpp_cc_options*
*g:ale_cpp_cc_options*
*b:ale_cpp_cc_options*
cpp_cc_options
g:ale_cpp_cc_options
Type: |String|
Default: `'-std=c++14 -Wall'`
This variable can be changed to modify flags given to the C++ compiler.
g:ale_cpp_cc_use_header_lang_flag *g:ale_cpp_cc_use_header_lang_flag*
*ale-options.cpp_cc_use_header_lang_flag*
*g: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|
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
for header files.
- When set to `-1`, the default beviour is used, `'-x c++-header'` is used with
Clang and `'-x c++'` is used with other compilers.
- When set to `-1`, the default behavior is used, `'-x c++-header'` is used
with Clang and `'-x c++'` is used with other compilers.
- When set to `0`, the flag is deactivated, `'-x c++'` is always used
independently of the compiler.
- When set to `1`, the flag is activated, `'-x c++-header'` is always used
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'`
with Clang.
g:ale_cpp_cc_header_exts *g:ale_cpp_cc_header_exts*
*ale-options.cpp_cc_header_exts*
*g:ale_cpp_cc_header_exts*
*b:ale_cpp_cc_header_exts*
cpp_cc_header_exts
g:ale_cpp_cc_header_exts
Type: |List|
Default: `['h', 'hpp']`
@@ -103,29 +117,35 @@ g:ale_cpp_cc_header_exts *g:ale_cpp_cc_header_exts*
===============================================================================
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*
cpp_ccls_executable
g:ale_cpp_ccls_executable
Type: |String|
Default: `'ccls'`
This variable can be changed to use a different executable for ccls.
g:ale_cpp_ccls_init_options *g:ale_cpp_ccls_init_options*
*ale-options.cpp_ccls_init_options*
*g:ale_cpp_ccls_init_options*
*b:ale_cpp_ccls_init_options*
cpp_ccls_init_options
g:ale_cpp_ccls_init_options
Type: |Dictionary|
Default: `{}`
This variable can be changed to customize ccls initialization options.
Example: >
{
\ 'cacheDirectory': '/tmp/ccls',
\ 'cacheFormat': 'binary',
\ 'diagnostics': {
\ 'onOpen': 0,
\ 'opChange': 1000,
\ },
\ }
let g:ale_cpp_ccls_init_options = {
\ 'cacheDirectory': '/tmp/ccls',
\ 'cacheFormat': 'binary',
\ 'diagnostics': {
\ 'onOpen': 0,
\ 'opChange': 1000,
\ },
\}
<
Visit https://github.com/MaskRay/ccls/wiki/Initialization-options for all
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
`compile_commands.json` files can be used. It is recommended to use this
linter in combination with `compile_commands.json` files.
Therefore, `clang-check` linter reads the options |g:ale_c_build_dir| and
linter in combination with `compile_commands.json` files. Therefore,
`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
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*
cpp_clangcheck_executable
g:ale_cpp_clangcheck_executable
Type: |String|
Default: `'clang-check'`
This variable can be changed to use a different executable for clangcheck.
g:ale_cpp_clangcheck_options *g:ale_cpp_clangcheck_options*
*ale-options.cpp_clangcheck_options*
*g:ale_cpp_clangcheck_options*
*b:ale_cpp_clangcheck_options*
cpp_clangcheck_options
g:ale_cpp_clangcheck_options
Type: |String|
Default: `''`
@@ -165,16 +192,21 @@ g:ale_cpp_clangcheck_options *g:ale_cpp_clangcheck_options*
===============================================================================
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*
cpp_clangd_executable
g:ale_cpp_clangd_executable
Type: |String|
Default: `'clangd'`
This variable can be changed to use a different executable for clangd.
g:ale_cpp_clangd_options *g:ale_cpp_clangd_options*
*ale-options.cpp_clangd_options*
*g:ale_cpp_clangd_options*
*b:ale_cpp_clangd_options*
cpp_clangd_options
g:ale_cpp_clangd_options
Type: |String|
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|.
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*
cpp_clangtidy_checks
g:ale_cpp_clangtidy_checks
Type: |List|
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
option to an empty List.
g:ale_cpp_clangtidy_executable *g:ale_cpp_clangtidy_executable*
*ale-options.cpp_clangtidy_executable*
*g:ale_cpp_clangtidy_executable*
*b:ale_cpp_clangtidy_executable*
cpp_clangtidy_executable
g:ale_cpp_clangtidy_executable
Type: |String|
Default: `'clang-tidy'`
This variable can be changed to use a different executable for clangtidy.
g:ale_cpp_clangtidy_options *g:ale_cpp_clangtidy_options*
*ale-options.cpp_clangtidy_options*
*g:ale_cpp_clangtidy_options*
*b:ale_cpp_clangtidy_options*
cpp_clangtidy_options
g:ale_cpp_clangtidy_options
Type: |String|
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
of the |g:ale_c_build_dir_names| directories of the project tree.
g:ale_cpp_clangtidy_extra_options *g:ale_cpp_clangtidy_extra_options*
*ale-options.cpp_clangtidy_extra_options*
*g:ale_cpp_clangtidy_extra_options*
*b:ale_cpp_clangtidy_extra_options*
cpp_clangtidy_extra_options
g:ale_cpp_clangtidy_extra_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to clang-tidy.
g:ale_cpp_clangtidy_fix_errors *g:ale_cpp_clangtidy_fix_errors*
*ale-options.cpp_clangtidy_fix_errors*
*g:ale_cpp_clangtidy_fix_errors*
*b:ale_cpp_clangtidy_fix_errors*
cpp_clangtidy_fix_errors
g:ale_cpp_clangtidy_fix_errors
Type: |Number|
Default: `1`
@@ -257,16 +302,21 @@ g:ale_cpp_clangtidy_fix_errors *g:ale_cpp_clangtidy_fix_errors*
===============================================================================
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*
cpp_clazy_executable
g:ale_cpp_clazy_executable
Type: |String|
Default: `'clazy-standalone'`
This variable can be changed to use a different executable for clazy.
g:ale_cpp_clazy_checks *g:ale_cpp_clazy_checks*
*ale-options.cpp_clazy_checks*
*g:ale_cpp_clazy_checks*
*b:ale_cpp_clazy_checks*
cpp_clazy_checks
g:ale_cpp_clazy_checks
Type: |List|
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
option to an empty List.
g:ale_cpp_clazy_options *g:ale_cpp_clazy_options*
*ale-options.cpp_clazy_options*
*g:ale_cpp_clazy_options*
*b:ale_cpp_clazy_options*
cpp_clazy_options
g:ale_cpp_clazy_options
Type: |String|
Default: `''`
@@ -288,16 +340,21 @@ g:ale_cpp_clazy_options *g:ale_cpp_clazy_options*
===============================================================================
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*
cpp_cppcheck_executable
g:ale_cpp_cppcheck_executable
Type: |String|
Default: `'cppcheck'`
This variable can be changed to use a different executable for cppcheck.
g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options*
*ale-options.cpp_cppcheck_options*
*g:ale_cpp_cppcheck_options*
*b:ale_cpp_cppcheck_options*
cpp_cppcheck_options
g:ale_cpp_cppcheck_options
Type: |String|
Default: `'--enable=style'`
@@ -307,31 +364,41 @@ g:ale_cpp_cppcheck_options *g:ale_cpp_cppcheck_options*
===============================================================================
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*
cpp_cpplint_executable
g:ale_cpp_cpplint_executable
Type: |String|
Default: `'cpplint'`
This variable can be changed to use a different executable for cpplint.
g:ale_cpp_cpplint_options *g:ale_cpp_cpplint_options*
*ale-options.cpp_cpplint_options*
*g:ale_cpp_cpplint_options*
*b:ale_cpp_cpplint_options*
cpp_cpplint_options
g:ale_cpp_cpplint_options
Type: |String|
Default: `''`
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*
c_cpplint_executable
g:ale_c_cpplint_executable
Type: |String|
Default: `'cpplint'`
This variable can be changed to use a different executable for cpplint.
g:ale_c_cpplint_options *g:ale_c_cpplint_options*
*ale-options.c_cpplint_options*
*g:ale_c_cpplint_options*
*b:ale_c_cpplint_options*
c_cpplint_options
g:ale_c_cpplint_options
Type: |String|
Default: `''`
@@ -341,16 +408,21 @@ g:ale_c_cpplint_options *g:ale_c_cpplint_options*
===============================================================================
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*
cpp_cquery_executable
g:ale_cpp_cquery_executable
Type: |String|
Default: `'cquery'`
This variable can be changed to use a different executable for cquery.
g:ale_cpp_cquery_cache_directory *g:ale_cpp_cquery_cache_directory*
*ale-options.cpp_cquery_cache_directory*
*g:ale_cpp_cquery_cache_directory*
*b:ale_cpp_cquery_cache_directory*
cpp_cquery_cache_directory
g:ale_cpp_cquery_cache_directory
Type: |String|
Default: `'~/.cache/cquery'`
@@ -367,24 +439,31 @@ See |ale-cspell-options|
===============================================================================
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*
cpp_flawfinder_executable
g:ale_cpp_flawfinder_executable
Type: |String|
Default: `'flawfinder'`
This variable can be changed to use a different executable for flawfinder.
g:ale_cpp_flawfinder_minlevel *g:ale_cpp_flawfinder_minlevel*
*ale-options.cpp_flawfinder_minlevel*
*g:ale_cpp_flawfinder_minlevel*
*b:ale_cpp_flawfinder_minlevel*
cpp_flawfinder_minlevel
g:ale_cpp_flawfinder_minlevel
Type: |Number|
Default: `1`
This variable can be changed to ignore risks under the given risk threshold.
g:ale_cpp_flawfinder_options *g:ale-cpp-flawfinder*
*ale-options.cpp_flawfinder_options*
*g:ale_cpp_flawfinder_options*
*b:ale-cpp-flawfinder*
cpp_flawfinder_options
g:ale_cpp_flawfinder_options
Type: |String|
Default: `''`

View File

@@ -1,7 +1,6 @@
===============================================================================
ALE C# Integration *ale-cs-options*
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
@@ -16,34 +15,39 @@ Note that the C options are also used for C#.
===============================================================================
csc *ale-cs-csc*
The |ale-cs-csc| linter checks for semantic errors when files are opened or
saved.
The |ale-cs-csc| linter checks for semantic errors when files are opened or
saved.
See |ale-lint-file-linters| for more information on linters which do not
check for problems while you type.
See |ale-lint-file-linters| for more information on linters which do not check
for problems while you type.
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
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
all sub directories.
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
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 all
sub directories.
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
actively developed, and only receives maintenance updates. However, because
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.
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
actively developed, and only receives maintenance updates. However, because
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.
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.
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.
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
first before other errors will be shown.
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
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*
cs_csc_options
g:ale_cs_csc_options
Type: |String|
Default: `''`
@@ -55,9 +59,11 @@ g:ale_cs_csc_options *g:ale_cs_csc_options*
<
NOTE: the `/unsafe` option is always passed to `csc`.
g:ale_cs_csc_source *g:ale_cs_csc_source*
*ale-options.cs_csc_source*
*g:ale_cs_csc_source*
*b:ale_cs_csc_source*
cs_csc_source
g:ale_cs_csc_source
Type: |String|
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
directory sub trees which shall not be searched for *.cs files.
g:ale_cs_csc_assembly_path *g:ale_cs_csc_assembly_path*
*ale-options.cs_csc_assembly_path*
*g:ale_cs_csc_assembly_path*
*b:ale_cs_csc_assembly_path*
cs_csc_assembly_path
g:ale_cs_csc_assembly_path
Type: |List|
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:`
flag.
g:ale_cs_csc_assemblies *g:ale_cs_csc_assemblies*
*ale-options.cs_csc_assemblies*
*g:ale_cs_csc_assemblies*
*b:ale_cs_csc_assemblies*
cs_csc_assemblies
g:ale_cs_csc_assemblies
Type: |List|
Default: `[]`
@@ -90,11 +100,11 @@ g:ale_cs_csc_assemblies *g:ale_cs_csc_assemblies*
For example: >
" Compile C# programs with the Unity engine DLL file on Mac.
let g:ale_cs_mcsc_assemblies = [
\ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll',
\ 'path-to-unityproject/obj/Debug',
\]
" Compile C# programs with the Unity engine DLL file on Mac.
let g:ale_cs_mcsc_assemblies = [
\ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll',
\ 'path-to-unityproject/obj/Debug',
\]
<
===============================================================================
@@ -106,8 +116,9 @@ See |ale-cspell-options|
===============================================================================
dotnet-format *ale-cs-dotnet-format*
Installation
-------------------------------------------------------------------------------
Installation
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
@@ -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
Options
-------------------------------------------------------------------------------
g:ale_cs_dotnet_format_executable *g:ale_cs_dotnet_format_executable*
Options
*ale-options.cs_dotnet_format_executable*
*g:ale_cs_dotnet_format_executable*
*b:ale_cs_dotnet_format_executable*
cs_dotnet_format_executable
g:ale_cs_dotnet_format_executable
Type: |String|
Default: `'dotnet'`
This variable can be set to specify an absolute path to the
`dotnet` executable (or to specify an alternate executable).
g:ale_cs_dotnet_format_options *g:ale_cs_dotnet_format_options*
*ale-options.cs_dotnet_format_options*
*g:ale_cs_dotnet_format_options*
*b:ale_cs_dotnet_format_options*
cs_dotnet_format_options
g:ale_cs_dotnet_format_options
Type: |String|
Default: `''`
@@ -139,15 +154,19 @@ g:ale_cs_dotnet_format_options *g:ale_cs_dotnet_format_options*
===============================================================================
mcs *ale-cs-mcs*
The `mcs` linter looks only for syntax errors while you type. See
|ale-cs-mcsc| for the separately configured linter for checking for semantic
errors.
The `mcs` linter looks only for syntax errors while you type. See
|ale-cs-mcsc| for the separately configured linter for checking for semantic
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*
Type: String
cs_mcs_options
g:ale_cs_mcs_options
Type: |String|
Default: `''`
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*
The mcsc linter checks for semantic errors when files are opened or saved
See |ale-lint-file-linters| for more information on linters which do not
check for problems while you type.
The mcsc linter checks for semantic errors when files are opened or saved See
|ale-lint-file-linters| for more information on linters which do not check for
problems while you type.
The mcsc linter uses the mono mcs compiler to generate a temporary module
target file (-t:module). The module includes including all '*.cs' files
contained in the directory tree rooted at the path defined by the
|g:ale_cs_mcsc_source| or |b:ale_cs_mcsc_source| variable.
variable and all sub directories.
The mcsc linter uses the mono mcs compiler to generate a temporary module
target file (-t:module). The module includes including all '*.cs' files
contained in the directory tree rooted at the path defined by the
|g:ale_cs_mcsc_source| or |b:ale_cs_mcsc_source| variable. variable and all
sub directories.
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.
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.
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
first before other errors will be shown.
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
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*
cs_mcsc_options
g:ale_cs_mcsc_options
Type: |String|
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: >
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`.
g:ale_cs_mcsc_source *g:ale_cs_mcsc_source*
*ale-options.cs_mcsc_source*
*g:ale_cs_mcsc_source*
*b:ale_cs_mcsc_source*
cs_mcsc_source
g:ale_cs_mcsc_source
Type: |String|
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
directory sub trees which shall not be searched for *.cs files.
g:ale_cs_mcsc_assembly_path *g:ale_cs_mcsc_assembly_path*
*ale-options.cs_mcsc_assembly_path*
*g:ale_cs_mcsc_assembly_path*
*b:ale_cs_mcsc_assembly_path*
cs_mcsc_assembly_path
g:ale_cs_mcsc_assembly_path
Type: |List|
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:`
flag.
g:ale_cs_mcsc_assemblies *g:ale_cs_mcsc_assemblies*
*ale-options.cs_mcsc_assemblies*
*g:ale_cs_mcsc_assemblies*
*b:ale_cs_mcsc_assemblies*
cs_mcsc_assemblies
g:ale_cs_mcsc_assemblies
Type: |List|
Default: `[]`
@@ -226,11 +256,11 @@ g:ale_cs_mcsc_assemblies *g:ale_cs_mcsc_assemblies*
For example: >
" Compile C# programs with the Unity engine DLL file on Mac.
let g:ale_cs_mcsc_assemblies = [
\ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll',
\ 'path-to-unityproject/obj/Debug',
\]
" Compile C# programs with the Unity engine DLL file on Mac.
let g:ale_cs_mcsc_assemblies = [
\ '/Applications/Unity/Unity.app/Contents/Frameworks/Managed/UnityEngine.dll',
\ 'path-to-unityproject/obj/Debug',
\]
<
===============================================================================

View File

@@ -11,24 +11,31 @@ See |ale-cspell-options|
===============================================================================
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*
css_css_beautify_executable
g:ale_css_css_beautify_executable
Type: |String|
Default: `'css-beautify'`
See |ale-integrations-local-executables|
g:ale_css_css_beautify_options *g:ale_css_css_beautify_options*
*ale-options.css_css_beautify_options*
*g:ale_css_css_beautify_options*
*b:ale_css_css_beautify_options*
css_css_beautify_options
g:ale_css_css_beautify_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to css-beautify.
g:ale_css_css_beautify_use_global *g:ale_css_css_beautify_use_global*
*ale-options.css_css_beautify_use_global*
*g: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|
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*
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*
css_stylelint_executable
g:ale_css_stylelint_executable
Type: |String|
Default: `'stylelint'`
See |ale-integrations-local-executables|
g:ale_css_stylelint_options *g:ale_css_stylelint_options*
*ale-options.css_stylelint_options*
*g:ale_css_stylelint_options*
*b:ale_css_stylelint_options*
css_stylelint_options
g:ale_css_stylelint_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to stylelint.
g:ale_css_stylelint_use_global *g:ale_css_stylelint_use_global*
*ale-options.css_stylelint_use_global*
*g:ale_css_stylelint_use_global*
*b:ale_css_stylelint_use_global*
css_stylelint_use_global
g:ale_css_stylelint_use_global
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -81,8 +95,9 @@ vscodecss *ale-css-vscode*
Website: https://github.com/hrsh7th/vscode-langservers-extracted
Installation
-------------------------------------------------------------------------------
Installation
Install VSCode css language server either globally or locally: >

View File

@@ -12,16 +12,21 @@ Note that the C options are also used for CUDA.
===============================================================================
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*
cuda_clangd_executable
g:ale_cuda_clangd_executable
Type: |String|
Default: `'clangd'`
This variable can be changed to use a different executable for clangd.
g:ale_cuda_clangd_options *g:ale_cuda_clangd_options*
*ale-options.cuda_clangd_options*
*g:ale_cuda_clangd_options*
*b:ale_cuda_clangd_options*
cuda_clangd_options
g:ale_cuda_clangd_options
Type: |String|
Default: `''`
@@ -31,17 +36,22 @@ g:ale_cuda_clangd_options *g:ale_cuda_clangd_options*
===============================================================================
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*
cuda_nvcc_executable
g:ale_cuda_nvcc_executable
Type: |String|
Default: `'nvcc'`
This variable can be changed to use a different executable for nvcc.
Currently only nvcc 8.0 is supported.
g:ale_cuda_nvcc_options *g:ale_cuda_nvcc_options*
*ale-options.cuda_nvcc_options*
*g:ale_cuda_nvcc_options*
*b:ale_cuda_nvcc_options*
cuda_nvcc_options
g:ale_cuda_nvcc_options
Type: |String|
Default: `'-std=c++11'`

View File

@@ -1,25 +1,32 @@
===============================================================================
ALE D Integration *ale-d-options*
===============================================================================
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*
d_dfmt_options
g:ale_d_dfmt_options
Type: |String|
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*
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*
d_dls_executable
g:ale_d_dls_executable
Type: |String|
Default: `dls`
See |ale-integrations-local-executables|
See |ale-integrations-local-executables|
===============================================================================

View File

@@ -5,12 +5,16 @@ ALE Dafny Integration *ale-dafny-options*
===============================================================================
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*
dafny_dafny_timelimit
g:ale_dafny_dafny_timelimit
Type: |Number|
Default: `10`
This variable sets the `/timeLimit` used for dafny.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -5,8 +5,9 @@ ALE Dart Integration *ale-dart-options*
===============================================================================
analysis_server *ale-dart-analysis_server*
Installation
-------------------------------------------------------------------------------
Installation
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'
<
Options
-------------------------------------------------------------------------------
g:ale_dart_analysis_server_executable *g:ale_dart_analysis_server_executable*
Options
*ale-options.dart_analysis_server_executable*
*g:ale_dart_analysis_server_executable*
*b:ale_dart_analysis_server_executable*
dart_analysis_server_executable
g:ale_dart_analysis_server_executable
Type: |String|
Default: `'dart'`
This variable can be set to change the path of dart.
g:ale_dart_analysis_server_enable_language_server
*ale-options.dart_analysis_server_enable_language_server*
*g: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|
Default: `1`
@@ -43,8 +47,9 @@ g:ale_dart_analysis_server_enable_language_server
===============================================================================
dart-analyze *ale-dart-analyze*
Installation
-------------------------------------------------------------------------------
Installation
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.
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*
dart_analyze_executable
g:ale_dart_analyze_executable
Type: |String|
Default: `'dart'`
@@ -70,30 +78,36 @@ g:ale_dart_analyze_executable *g:ale_dart_analyze_executable*
===============================================================================
dart-format *ale-dart-format*
Installation
-------------------------------------------------------------------------------
Installation
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.
let g:ale_dart_format_executable = '/usr/lib/dart/bin/dart'
>
<
Options
-------------------------------------------------------------------------------
g:ale_dart_format_executable *g:ale_dart_format_executable*
Options
*ale-options.dart_format_executable*
*g:ale_dart_format_executable*
*b:ale_dart_format_executable*
dart_format_executable
g:ale_dart_format_executable
Type: |String|
Default: `'dart'`
This variable can be set to specify an absolute path to the
format executable (or to specify an alternate executable).
g:ale_dart_format_options *g:ale_dart_format_options*
*ale-options.dart_format_options*
*g:ale_dart_format_options*
*b:ale_dart_format_options*
dart_format_options
g:ale_dart_format_options
Type: |String|
Default: `''`
@@ -103,35 +117,41 @@ g:ale_dart_format_options *g:ale_dart_format_options*
===============================================================================
dartfmt *ale-dart-dartfmt*
Installation
-------------------------------------------------------------------------------
Installation
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.
let g:ale_dart_dartfmt_executable = '/usr/lib/dart/bin/dartfmt'
>
<
Options
-------------------------------------------------------------------------------
g:ale_dart_dartfmt_executable *g:ale_dart_dartfmt_executable*
Options
*ale-options.dart_dartfmt_executable*
*g:ale_dart_dartfmt_executable*
*b:ale_dart_dartfmt_executable*
dart_dartfmt_executable
g:ale_dart_dartfmt_executable
Type: |String|
Default: `''`
This variable can be set to specify an absolute path to the
dartfmt executable (or to specify an alternate executable).
g:ale_dart_dartfmt_options *g:ale_dart_dartfmt_options*
*ale-options.dart_dartfmt_options*
*g:ale_dart_dartfmt_options*
*b:ale_dart_dartfmt_options*
dart_dartfmt_options
g:ale_dart_dartfmt_options
Type: |String|
Default: `''`
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:

View File

@@ -8,14 +8,19 @@ desktop-file-validate *ale-desktop-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*
*b:ale_desktop_desktop_file_validate_options*
desktop_desktop_file_validate_options
g:ale_desktop_desktop_file_validate_options
Type: |String|
Default: `''`
This variable can be changed to set options for `desktop-file-validate`,
such as `'--warn-kde'`.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -17,6 +17,7 @@ CONTENTS *ale-development-contents*
5. Contributing.........................|ale-development-contributing|
5.1. Preparing a Release..............|ale-development-release|
===============================================================================
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
development.
===============================================================================
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
for comedy value.
===============================================================================
3. Coding Standards *ale-coding-standards*
@@ -147,6 +150,7 @@ Apply the following rules when writing Bash scripts.
See: https://github.com/koalaman/shellcheck
* 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*
@@ -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
doc tags on the right margin.
===============================================================================
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.
`AssertLSPAddress address` - Check the address to an LSP server.
===============================================================================
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
`AssertFixerNotExecuted` - Check that fixers will not be executed.
===============================================================================
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
give you results much more quickly.
===============================================================================
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
to appear by `USERNAME <RANDOM_NUMBER+USERNAME@users.noreply.github.com>` .
===============================================================================
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
preference of w0rp.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -1,13 +1,21 @@
===============================================================================
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*
dhall_executable
g:ale_dhall_executable
Type: |String|
Default: `'dhall'`
g:ale_dhall_options *g:ale_dhall_options*
*ale-options.dhall_options*
*g:ale_dhall_options*
*b:ale_dhall_options*
dhall_options
g:ale_dhall_options
Type: |String|
Default: `''`
@@ -20,18 +28,18 @@ g:ale_dhall_options *g:ale_dhall_options*
===============================================================================
dhall-format *ale-dhall-format*
Dhall
(https://dhall-lang.org/)
===============================================================================
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*
dhall_freeze_options
g:ale_dhall_freeze_options
Type: |String|
Default: `''`
@@ -44,9 +52,6 @@ g:ale_dhall_freeze_options *g:ale_dhall_freeze_options*
===============================================================================
dhall-lint *ale-dhall-lint*
Dhall
(https://dhall-lang.org/)
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -5,19 +5,22 @@ ALE Dockerfile Integration *ale-dockerfile-options*
===============================================================================
dockerfile_lint *ale-dockerfile-dockerfile_lint*
g:ale_dockerfile_dockerfile_lint_executable
*ale-options.dockerfile_dockerfile_lint_executable*
*g:ale_dockerfile_dockerfile_lint_executable*
*b:ale_dockerfile_dockerfile_lint_executable*
dockerfile_dockerfile_lint_executable
g:ale_dockerfile_dockerfile_lint_executable
Type: |String|
Default: `'dockerfile_lint'`
This variable can be changed to specify the executable used to run
dockerfile_lint.
g:ale_dockerfile_dockerfile_lint_options
*ale-options.dockerfile_dockerfile_lint_options*
*g:ale_dockerfile_dockerfile_lint_options*
*b:ale_dockerfile_dockerfile_lint_options*
dockerfile_dockerfile_lint_options
g:ale_dockerfile_dockerfile_lint_options
Type: |String|
Default: `''`
@@ -28,9 +31,11 @@ g:ale_dockerfile_dockerfile_lint_options
===============================================================================
dockerlinter *ale-dockerfile-dockerlinter*
g:ale_dockerfile_dockerlinter_executable
*ale-options.dockerfile_dockerlinter_executable*
*g:ale_dockerfile_dockerlinter_executable*
*b:ale_dockerfile_dockerlinter_executable*
dockerfile_dockerlinter_executable
g:ale_dockerfile_dockerlinter_executable
Type: |String|
Default: `'dockerlinter'`
@@ -38,17 +43,17 @@ g:ale_dockerfile_dockerlinter_executable
dockerlinter.
g:ale_dockerfile_dockerlinter_options
*ale-options.dockerfile_dockerlinter_options*
*g:ale_dockerfile_dockerlinter_options*
*b:ale_dockerfile_dockerlinter_options*
dockerfile_dockerlinter_options
g:ale_dockerfile_dockerlinter_options
Type: |String|
Default: `''`
This variable can be changed to add additional command-line arguments to
the dockerfile lint invocation - like custom rule file definitions.
dockerlinter
===============================================================================
dprint *ale-dockerfile-dprint*
@@ -59,11 +64,16 @@ See |ale-dprint-options| and https://dprint.dev/plugins/dockerfile
===============================================================================
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*
dockerfile_hadolint_options
g:ale_dockerfile_hadolint_options
Type: |String|
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
(see below).
g:ale_dockerfile_hadolint_use_docker *g:ale_dockerfile_hadolint_use_docker*
*ale-options.dockerfile_hadolint_use_docker*
*g:ale_dockerfile_hadolint_use_docker*
*b:ale_dockerfile_hadolint_use_docker*
dockerfile_hadolint_use_docker
g:ale_dockerfile_hadolint_use_docker
Type: |String|
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
docker to lint evolves.
g:ale_dockerfile_hadolint_image *g:ale_dockerfile_hadolint_image*
*ale-options.dockerfile_hadolint_image*
*g:ale_dockerfile_hadolint_image*
*b:ale_dockerfile_hadolint_image*
dockerfile_hadolint_image
g:ale_dockerfile_hadolint_image
Type: |String|
Default: `'hadolint/hadolint'`
This variable controls the docker image used to run hadolint. The default
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/
===============================================================================

View File

@@ -8,9 +8,11 @@ mix *ale-elixir-mix*
The `mix` linter is disabled by default, as it can be too expensive to run.
See `:help g:ale_linters`
g:ale_elixir_mix_options *g:ale_elixir_mix_options*
*ale-options.elixir_mix_options*
*g:ale_elixir_mix_options*
*b:ale_elixir_mix_options*
elixir_mix_options
g:ale_elixir_mix_options
Type: |String|
Default: `'mix'`
@@ -21,8 +23,11 @@ g:ale_elixir_mix_options *g:ale_elixir_mix_options*
===============================================================================
mix_format *ale-elixir-mix-format*
g:ale_elixir_mix_format_options *g:ale_elixir_mix_format_options*
*ale-options.elixir_mix_format_options*
*g:ale_elixir_mix_format_options*
*b:ale_elixir_mix_format_options*
elixir_mix_format_options
g:ale_elixir_mix_format_options
Type: |String|
Default: `''`
@@ -52,26 +57,33 @@ elixir-ls *ale-elixir-elixir-ls*
Elixir Language Server (https://github.com/JakeBecker/elixir-ls)
g:ale_elixir_elixir_ls_release *g:ale_elixir_elixir_ls_release*
*ale-options.elixir_elixir_ls_release*
*g:ale_elixir_elixir_ls_release*
*b:ale_elixir_elixir_ls_release*
elixir_elixir_ls_release
g:ale_elixir_elixir_ls_release
Type: |String|
Default: `'elixir-ls'`
Location of the elixir-ls release directory. This directory must contain
the language server scripts (language_server.sh and language_server.bat).
g:ale_elixir_elixir_ls_config *g:ale_elixir_elixir_ls_config*
*ale-options.elixir_elixir_ls_config*
*g:ale_elixir_elixir_ls_config*
*b:ale_elixir_elixir_ls_config*
elixir_elixir_ls_config
g:ale_elixir_elixir_ls_config
Type: |Dictionary|
Default: `{}`
Dictionary containing configuration settings that will be passed to the
language server. For example, to disable Dialyzer: >
{
\ 'elixirLS': {
\ 'dialyzerEnabled': v:false,
\ },
\ }
let g:ale_elixir_elixir_ls_config = {
\ 'elixirLS': {
\ 'dialyzerEnabled': v:false,
\ },
\}
<
Consult the ElixirLS documentation for more information about settings.
@@ -81,17 +93,22 @@ credo *ale-elixir-credo*
Credo (https://github.com/rrrene/credo)
g:ale_elixir_credo_strict *g:ale_elixir_credo_strict*
*ale-options.elixir_credo_strict*
*g:ale_elixir_credo_strict*
*b:ale_elixir_credo_strict*
elixir_credo_strict
g:ale_elixir_credo_strict
Type: |Integer|
Default: `0`
Tells credo to run in strict mode or suggest mode. Set variable to 1 to
enable --strict mode.
g:ale_elixir_credo_config_file *g:ale_elixir_credo_config_file*
*ale-options.elixir_credo_config_file*
*g:ale_elixir_credo_config_file*
*b:ale_elixir_credo_config_file*
elixir_credo_config_file
g:ale_elixir_credo_config_file
Type: |String|
Default: `''`
@@ -109,8 +126,11 @@ lexical *ale-elixir-lexical*
Lexical (https://github.com/lexical-lsp/lexical)
g:ale_elixir_lexical_release *g:ale_elixir_lexical_release*
*ale-options.elixir_lexical_release*
*g:ale_elixir_lexical_release*
*b:ale_elixir_lexical_release*
elixir_lexical_release
g:ale_elixir_lexical_release
Type: |String|
Default: `'lexical'`

View File

@@ -5,96 +5,124 @@ ALE Elm Integration *ale-elm-options*
===============================================================================
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*
elm_format_executable
g:ale_elm_format_executable
Type: |String|
Default: `'elm-format'`
See |ale-integrations-local-executables|
g:ale_elm_format_use_global *g:ale_elm_format_use_global*
*ale-options.elm_format_use_global*
*g:ale_elm_format_use_global*
*b:ale_elm_format_use_global*
elm_format_use_global
g:ale_elm_format_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_elm_format_options *g:ale_elm_format_options*
*ale-options.elm_format_options*
*g:ale_elm_format_options*
*b:ale_elm_format_options*
elm_format_options
g:ale_elm_format_options
Type: |String|
Default: `'--yes'`
This variable can be set to pass additional options to elm-format.
===============================================================================
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*
elm_ls_executable
g:ale_elm_ls_executable
Type: |String|
Default: `'elm-language-server'`
See |ale-integrations-local-executables|
g:ale_elm_ls_use_global *g:ale_elm_ls_use_global*
*ale-options.elm_ls_use_global*
*g:ale_elm_ls_use_global*
*b:ale_elm_ls_use_global*
elm_ls_use_global
g:ale_elm_ls_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 1)`
See |ale-integrations-local-executables|
g:ale_elm_ls_elm_path *g:ale_elm_ls_elm_path*
*ale-options.elm_ls_elm_path*
*g:ale_elm_ls_elm_path*
*b:ale_elm_ls_elm_path*
elm_ls_elm_path
g:ale_elm_ls_elm_path
Type: |String|
Default: `''`
See |ale-integrations-local-executables|
g:ale_elm_ls_elm_format_path *g:ale_elm_ls_elm_format_path*
*ale-options.elm_ls_elm_format_path*
*g: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|
Default: `''`
See |ale-integrations-local-executables|
g:ale_elm_ls_elm_test_path *g:ale_elm_ls_elm_test_path*
*ale-options.elm_ls_elm_test_path*
*g: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|
Default: `''`
See |ale-integrations-local-executables|
g:ale_elm_ls_elm_analyse_trigger *g:ale_elm_ls_elm_analyse_trigger*
*ale-options.elm_ls_elm_analyse_trigger*
*g: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|
Default: `'change'`
One of 'change', 'save' or 'never'
===============================================================================
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*
elm_make_executable
g:ale_elm_make_executable
Type: |String|
Default: `'elm'`
See |ale-integrations-local-executables|
g:ale_elm_make_use_global *g:ale_elm_make_use_global*
*ale-options.elm_make_use_global*
*g:ale_elm_make_use_global*
*b:ale_elm_make_use_global*
elm_make_use_global
g:ale_elm_make_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -5,34 +5,44 @@ ALE Erlang Integration *ale-erlang-options*
===============================================================================
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*
erlang_dialyzer_executable
g:ale_erlang_dialyzer_executable
Type: |String|
Default: `'dialyzer'`
This variable can be changed to specify the dialyzer executable.
g:ale_erlang_dialyzer_options *g:ale_erlang_dialyzer_options*
*ale-options.erlang_dialyzer_options*
*g:ale_erlang_dialyzer_options*
*b:ale_erlang_dialyzer_options*
erlang_dialyzer_options
g:ale_erlang_dialyzer_options
Type: |String|
Default: `'-Wunmatched_returns -Werror_handling -Wrace_conditions -Wunderspec'`
This variable can be changed to specify the options to pass to the dialyzer
executable.
g:ale_erlang_dialyzer_plt_file *g:ale_erlang_dialyzer_plt_file*
*ale-options.erlang_dialyzer_plt_file*
*g:ale_erlang_dialyzer_plt_file*
*b:ale_erlang_dialyzer_plt_file*
erlang_dialyzer_plt_file
g:ale_erlang_dialyzer_plt_file
Type: |String|
Default: `''`
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
there isn't one, it will fallback to the path `$REBAR_PLT_DIR/dialyzer/plt`.
Otherwise, it will default to `$HOME/.dialyzer_plt`.
g:ale_erlang_dialyzer_rebar3_profile *g:ale_erlang_dialyzer_rebar3_profile*
*ale-options.erlang_dialyzer_rebar3_profile*
*g:ale_erlang_dialyzer_rebar3_profile*
*b:ale_erlang_dialyzer_rebar3_profile*
erlang_dialyzer_rebar3_profile
g:ale_erlang_dialyzer_rebar3_profile
Type: |String|
Default: `'default'`
@@ -40,106 +50,138 @@ g:ale_erlang_dialyzer_rebar3_profile *g:ale_erlang_dialyzer_rebar3_profile*
run dialyzer with rebar3.
-------------------------------------------------------------------------------
===============================================================================
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*
erlang_elvis_executable
g:ale_erlang_elvis_executable
Type: |String|
Default: `'elvis'`
This variable can be changed to specify the elvis executable.
-------------------------------------------------------------------------------
===============================================================================
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*
*b:ale_erlang_erlang_mode_emacs_executable*
erlang_erlang_mode_emacs_executable
g:ale_erlang_erlang_mode_emacs_executable
Type: |String|
Default: `'emacs'`
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*
erlang_erlang_mode_indent_level
g:ale_erlang_erlang_mode_indent_level
Type: |Number|
Default: `4`
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*
erlang_erlang_mode_icr_indent
g:ale_erlang_erlang_mode_icr_indent
Type: `'nil'` or |Number|
Default: `'nil'`
Indentation of Erlang if/case/receive patterns. `'nil'` means keeping default
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*
erlang_erlang_mode_indent_guard
g:ale_erlang_erlang_mode_indent_guard
Type: |Number|
Default: `2`
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*
*b:ale_erlang_erlang_mode_argument_indent*
erlang_erlang_mode_argument_indent
g:ale_erlang_erlang_mode_argument_indent
Type: `'nil'` or |Number|
Default: `2`
Indentation of the first argument in a function call. When `'nil'`, indent
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*
*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'`
Default: `'nil'`
Indentation can insert tabs if this is non-`'nil'`.
-------------------------------------------------------------------------------
===============================================================================
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*
erlang_erlang_ls_executable
g:ale_erlang_erlang_ls_executable
Type: |String|
Default: `'erlang_ls'`
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*
erlang_erlang_ls_log_dir
g:ale_erlang_erlang_ls_log_dir
Type: |String|
Default: `''`
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*
erlang_erlang_ls_log_level
g:ale_erlang_erlang_ls_log_level
Type: |String|
Default: `'info'`
This variable can be changed to specify log level.
-------------------------------------------------------------------------------
===============================================================================
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*
erlang_erlc_executable
g:ale_erlang_erlc_executable
Type: |String|
Default: `'erlc'`
This variable can be changed to specify the erlc executable.
g:ale_erlang_erlc_options *g:ale_erlang_erlc_options*
*ale-options.erlang_erlc_options*
*g:ale_erlang_erlc_options*
*b:ale_erlang_erlc_options*
erlang_erlc_options
g:ale_erlang_erlc_options
Type: |String|
Default: `''`
@@ -147,19 +189,24 @@ g:ale_erlang_erlc_options *g:ale_erlang_erlc_options*
or `-pa`.
-------------------------------------------------------------------------------
===============================================================================
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*
erlang_erlfmt_executable
g:ale_erlang_erlfmt_executable
Type: |String|
Default: `'erlfmt'`
This variable can be changed to specify the erlfmt executable.
g:ale_erlang_erlfmt_options *g:ale_erlang_erlfmt_options*
*ale-options.erlang_erlfmt_options*
*g:ale_erlang_erlfmt_options*
*b:ale_erlang_erlfmt_options*
erlang_erlfmt_options
g:ale_erlang_erlfmt_options
Type: |String|
Default: `''`
@@ -167,11 +214,14 @@ g:ale_erlang_erlfmt_options *g:ale_erlang_erlfmt_options*
`--insert-pragma` or `--print-width`.
-------------------------------------------------------------------------------
===============================================================================
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*
erlang_syntaxerl_executable
g:ale_erlang_syntaxerl_executable
Type: |String|
Default: `'syntaxerl'`

View File

@@ -19,8 +19,11 @@ the result. To selectively enable a subset, see |g:ale_linters|.
===============================================================================
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*
eruby_erbformatter_executable
g:ale_eruby_erbformatter_executable
Type: |String|
Default: `'erb-formatter'`
@@ -31,17 +34,22 @@ g:ale_eruby_erbformatter_executable *g:ale_eruby_erbformatter_executable*
===============================================================================
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*
eruby_erblint_executable
g:ale_eruby_erblint_executable
Type: |String|
Default: `'erblint'`
Override the invoked erblint binary. This is useful for running erblint
from binstubs or a bundle.
g:ale_eruby_erblint_options *g:ale_ruby_erblint_options*
*ale-options.eruby_erblint_options*
*g:ale_eruby_erblint_options*
*b:ale_ruby_erblint_options*
eruby_erblint_options
g:ale_eruby_erblint_options
Type: |String|
Default: `''`
@@ -51,8 +59,11 @@ g:ale_eruby_erblint_options *g:ale_ruby_erblint_options*
===============================================================================
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*
eruby_htmlbeautifier_executable
g:ale_eruby_htmlbeautifier_executable
Type: |String|
Default: `'htmlbeautifier'`
@@ -63,17 +74,22 @@ g:ale_eruby_htmlbeautifier_executable *g:ale_eruby_htmlbeautifier_executable*
===============================================================================
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*
eruby_ruumba_executable
g:ale_eruby_ruumba_executable
Type: |String|
Default: `'ruumba'`
Override the invoked ruumba binary. This is useful for running ruumba
from binstubs or a bundle.
g:ale_eruby_ruumba_options *g:ale_ruby_ruumba_options*
*ale-options.eruby_ruumba_options*
*g:ale_eruby_ruumba_options*
*b:ale_ruby_ruumba_options*
eruby_ruumba_options
g:ale_eruby_ruumba_options
Type: |String|
Default: `''`

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
`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|
Default: `'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*
*b:ale_fish_fish_indent_options*
*ale-options.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|
Default: `''`
This variable can be set to pass additional options to fish_indent.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -5,25 +5,32 @@ ALE Fortran Integration *ale-fortran-options*
===============================================================================
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*
fortran_gcc_executable
g:ale_fortran_gcc_executable
Type: |String|
Default: `'gcc'`
This variable can be changed to modify the executable used for checking
Fortran code with GCC.
g:ale_fortran_gcc_options *g:ale_fortran_gcc_options*
*ale-options.fortran_gcc_options*
*g:ale_fortran_gcc_options*
*b:ale_fortran_gcc_options*
fortran_gcc_options
g:ale_fortran_gcc_options
Type: |String|
Default: `'-Wall'`
This variable can be changed to modify flags given to gcc.
g:ale_fortran_gcc_use_free_form *g:ale_fortran_gcc_use_free_form*
*ale-options.fortran_gcc_use_free_form*
*g: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|
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*
*b:ale_fortran_language_server_executable*
*ale-options.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|
Default: `'fortls'`
This variable can be changed to modify the executable used for the Fortran
Language Server.
g:ale_fortran_language_server_use_global *g:ale_fortran_language_server_use_global*
*b:ale_fortran_language_server_use_global*
*ale-options.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|
Default: `get(g:, 'ale_use_global_executables', 0)`

View File

@@ -5,16 +5,21 @@ ALE FusionScript Integration *ale-fuse-options*
===============================================================================
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*
fusion_fusionlint_executable
g:ale_fusion_fusionlint_executable
Type: |String|
Default: `'fusion-lint'`
This variable can be changed to change the path to fusion-lint.
g:ale_fuse_fusionlint_options *g:ale_fuse_fusionlint_options*
*ale-options.fuse_fusionlint_options*
*g:ale_fuse_fusionlint_options*
*b:ale_fuse_fusionlint_options*
fuse_fusionlint_options
g:ale_fuse_fusionlint_options
Type: |String|
Default: `''`

View File

@@ -5,32 +5,39 @@ ALE Git Commit Integration *ale-gitcommit-options*
===============================================================================
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*
gitcommit_gitlint_executable
g:ale_gitcommit_gitlint_executable
Type: |String|
Default: `'gitlint'`
This variable can be changed to modify the executable used for gitlint.
g:ale_gitcommit_gitlint_options *g:ale_gitcommit_gitlint_options*
*ale-options.gitcommit_gitlint_options*
*g:ale_gitcommit_gitlint_options*
*b:ale_gitcommit_gitlint_options*
gitcommit_gitlint_options
g:ale_gitcommit_gitlint_options
Type: |String|
Default: `''`
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. >
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 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'
<
g:ale_gitcommit_gitlint_use_global *g:ale_gitcommit_gitlint_use_global*
*ale-options.gitcommit_gitlint_use_global*
*g:ale_gitcommit_gitlint_use_global*
*b:ale_gitcommit_gitlint_use_global*
gitcommit_gitlint_use_global
g:ale_gitcommit_gitlint_use_global
Type: |Number|
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.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -6,8 +6,11 @@ ALE Gleam Integration *ale-gleam-options*
===============================================================================
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*
gleam_gleam_format_executable
g:ale_gleam_gleam_format_executable
Type: |String|
Default: `'gleam'`
@@ -18,8 +21,11 @@ g:ale_gleam_gleam_format_executable *g:ale_gleam_gleam_format_executable*
===============================================================================
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*
gleam_gleamlsp_executable
g:ale_gleam_gleamlsp_executable
Type: |String|
Default: `'gleam'`

View File

@@ -16,16 +16,21 @@ Integration Information
===============================================================================
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*
glsl_glslang_executable
g:ale_glsl_glslang_executable
Type: |String|
Default: `'glslangValidator'`
This variable can be changed to change the path to glslangValidator.
g:ale_glsl_glslang_options *g:ale_glsl_glslang_options*
*ale-options.glsl_glslang_options*
*g:ale_glsl_glslang_options*
*b:ale_glsl_glslang_options*
glsl_glslang_options
g:ale_glsl_glslang_options
Type: |String|
Default: `''`
@@ -35,16 +40,22 @@ g:ale_glsl_glslang_options *g:ale_glsl_glslang_options*
===============================================================================
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*
glsl_glslls_executable
g:ale_glsl_glslls_executable
Type: |String|
Default: `'glslls'`
This variable can be changed to change the path to glslls.
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*
glsl_glslls_logfile
g:ale_glsl_glslls_logfile
Type: |String|
Default: `''`

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.
let g:ale_linters = {'go': ['golangci-lint', 'gofmt']}
<
g:ale_go_go_executable *g:ale_go_go_executable*
*ale-options.go_go_executable*
*g:ale_go_go_executable*
*b:ale_go_go_executable*
go_go_executable
g:ale_go_go_executable
Type: |String|
Default: `'go'`
The executable that will be run for the `gobuild` and `govet` linters, and
the `gomod` fixer.
g:ale_go_go111module *g:ale_go_go111module*
*ale-options.go_go111module*
*g:ale_go_go111module*
*b:ale_go_go111module*
go_go111module
g:ale_go_go111module
Type: |String|
Default: `''`
@@ -37,16 +40,21 @@ g:ale_go_go111module *g:ale_go_go111module*
===============================================================================
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*
go_bingo_executable
g:ale_go_bingo_executable
Type: |String|
Default: `'bingo'`
Location of the bingo binary file.
g:ale_go_bingo_options *g:ale_go_bingo_options*
*ale-options.go_bingo_options*
*g:ale_go_bingo_options*
*b:ale_go_bingo_options*
go_bingo_options
g:ale_go_bingo_options
Type: |String|
Default: `''`
@@ -56,11 +64,15 @@ cspell *ale-go-cspell*
See |ale-cspell-options|
===============================================================================
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*
go_gobuild_options
g:ale_go_gobuild_options
Type: |String|
Default: `''`
@@ -71,8 +83,11 @@ g:ale_go_gobuild_options *g:ale_go_gobuild_options*
===============================================================================
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*
go_gofmt_options
g:ale_go_gofmt_options
Type: |String|
Default: `''`
@@ -82,15 +97,21 @@ g:ale_go_gofmt_options *g:ale_go_gofmt_options*
===============================================================================
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*
go_gofumpt_executable
g:ale_go_gofumpt_executable
Type: |String|
Default: `'gofumpt'`
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*
go_gofumpt_options
g:ale_go_gofumpt_options
Type: |String|
Default: `''`
@@ -104,25 +125,32 @@ golangci-lint *ale-go-golangci-lint*
written to disk. This differs from the default behavior of linting the buffer.
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*
go_golangci_lint_executable
g:ale_go_golangci_lint_executable
Type: |String|
Default: `'golangci-lint'`
The executable that will be run for golangci-lint.
g:ale_go_golangci_lint_options *g:ale_go_golangci_lint_options*
*ale-options.go_golangci_lint_options*
*g:ale_go_golangci_lint_options*
*b:ale_go_golangci_lint_options*
go_golangci_lint_options
g:ale_go_golangci_lint_options
Type: |String|
Default: `''`
This variable can be changed to alter the command-line arguments to the
golangci-lint invocation.
g:ale_go_golangci_lint_package *g:ale_go_golangci_lint_package*
*ale-options.go_golangci_lint_package*
*g:ale_go_golangci_lint_package*
*b:ale_go_golangci_lint_package*
go_golangci_lint_package
g:ale_go_golangci_lint_package
Type: |Number|
Default: `0`
@@ -133,16 +161,21 @@ g:ale_go_golangci_lint_package *g:ale_go_golangci_lint_package*
===============================================================================
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*
go_langserver_executable
g:ale_go_langserver_executable
Type: |String|
Default: `'go-langserver'`
Location of the go-langserver binary file.
g:ale_go_langserver_options *g:ale_go_langserver_options*
*ale-options.go_langserver_options*
*g:ale_go_langserver_options*
*b:ale_go_langserver_options*
go_langserver_options
g:ale_go_langserver_options
Type: |String|
Default: `''`
@@ -154,15 +187,21 @@ g:ale_go_langserver_options *g:ale_go_langserver_options*
===============================================================================
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*
go_golines_executable
g:ale_go_golines_executable
Type: |String|
Default: `'golines'`
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*
go_golines_options
g:ale_go_golines_options
Type: |String|
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
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*
go_gopls_executable
g:ale_go_gopls_executable
Type: |String|
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
otherwise.
g:ale_go_gopls_options *g:ale_go_gopls_options*
*ale-options.go_gopls_options*
*g:ale_go_gopls_options*
*b:ale_go_gopls_options*
go_gopls_options
g:ale_go_gopls_options
Type: |String|
Default: `''`
Command-line options passed to the gopls executable. See `gopls -h`.
g:ale_go_gopls_fix_executable *g:ale_go_gopls_fix_executable*
*ale-options.go_gopls_fix_executable*
*g:ale_go_gopls_fix_executable*
*b:ale_go_gopls_fix_executable*
go_gopls_fix_executable
g:ale_go_gopls_fix_executable
Type: |String|
Default: `'gopls'`
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*
go_gopls_fix_options
g:ale_go_gopls_fix_options
Type: |String|
Default: `''`
Options to pass to the gopls fixer.
g:ale_go_gopls_init_options *g:ale_go_gopls_init_options*
*ale-options.go_gopls_init_options*
*g:ale_go_gopls_init_options*
*b:ale_go_gopls_init_options*
go_gopls_init_options
g:ale_go_gopls_init_options
Type: |Dictionary|
Default: `{}`
LSP initialization options passed to gopls. This can be used to configure
the behaviour of gopls.
Example: >
let g:ale_go_gopls_init_options = {'ui.diagnostic.analyses': {
\ 'composites': v:false,
\ 'unusedparams': v:true,
\ 'unusedresult': v:true,
\ }}
For example: >
let g:ale_go_gopls_init_options = {
\ 'ui.diagnostic.analyses': {
\ 'composites': v:false,
\ 'unusedparams': v:true,
\ 'unusedresult': v:true,
\ },
\}
<
For a full list of supported analyzers, see:
https://github.com/golang/tools/blob/master/gopls/doc/analyzers.md
g:ale_go_gopls_use_global *g:ale_go_gopls_use_global*
*ale-options.go_gopls_use_global*
*g:ale_go_gopls_use_global*
*b:ale_go_gopls_use_global*
go_gopls_use_global
g:ale_go_gopls_use_global
Type: |String|
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*
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*
go_govet_options
g:ale_go_govet_options
Type: |String|
Default: `''`
@@ -264,16 +323,21 @@ g:ale_go_govet_options *g:ale_go_govet_options*
===============================================================================
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*
go_revive_executable
g:ale_go_revive_executable
Type: |String|
Default: `'revive'`
This variable can be set to change the revive executable path.
g:ale_go_revive_options *g:ale_go_revive_options*
*ale-options.go_revive_options*
*g:ale_go_revive_options*
*b:ale_go_revive_options*
go_revive_options
g:ale_go_revive_options
Type: |String|
Default: `''`
@@ -283,8 +347,11 @@ g:ale_go_revive_options *g:ale_go_revive_options*
===============================================================================
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*
go_staticcheck_executable
g:ale_go_staticcheck_executable
Type: |String|
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
found otherwise.
g:ale_go_staticcheck_options *g:ale_go_staticcheck_options*
*ale-options.go_staticcheck_options*
*g:ale_go_staticcheck_options*
*b:ale_go_staticcheck_options*
go_staticcheck_options
g:ale_go_staticcheck_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to the staticcheck
linter.
g:ale_go_staticcheck_lint_package *g:ale_go_staticcheck_lint_package*
*ale-options.go_staticcheck_lint_package*
*g:ale_go_staticcheck_lint_package*
*b:ale_go_staticcheck_lint_package*
go_staticcheck_lint_package
g:ale_go_staticcheck_lint_package
Type: |Number|
Default: `1`
When set to `1`, the whole Go package will be checked instead of only the
current file.
g:ale_go_staticcheck_use_global *g:ale_go_staticcheck_use_global*
*ale-options.go_staticcheck_use_global*
*g:ale_go_staticcheck_use_global*
*b:ale_go_staticcheck_use_global*
go_staticcheck_use_global
g:ale_go_staticcheck_use_global
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`

11
doc/ale-gohtmltmpl.txt Normal file
View File

@@ -0,0 +1,11 @@
===============================================================================
ALE Go HTML Template Integration *ale-gohtmltmpl-options*
===============================================================================
djlint *ale-gohtmltmpl-djlint*
See |ale-html-djlint|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

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*
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*
groovy_npmgroovylint_executable
g:ale_groovy_npmgroovylint_executable
Type: |String|
Default: `'npm-groovy-lint'`
Location of the npm-groovy-lint binary file.
g:ale_groovy_npmgroovylint_options *g:ale_groovy_npmgroovylint_options*
*ale-options.groovy_npmgroovylint_options*
*g:ale_groovy_npmgroovylint_options*
*b:ale_groovy_npmgroovylint_options*
groovy_npmgroovylint_options
g:ale_groovy_npmgroovylint_options
Type: |String|
Default: `'--loglevel warning'`
Additional npm-groovy-lint linter options.
g:ale_groovy_npmgroovylint_fix_options *g:ale_groovy_npmgroovylint_fix_options*
*ale-options.groovy_npmgroovylint_fix_options*
*g:ale_groovy_npmgroovylint_fix_options*
*b:ale_groovy_npmgroovylint_fix_options*
groovy_npmgroovylint_fix_options
g:ale_groovy_npmgroovylint_fix_options
Type: |String|
Default: `'--fix'`

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.
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 g:ale_linters = {'hack': ['hack', 'hhast']}
let b:ale_linters = ['hack', 'hhast']
<
Or in Lua: >
require("ale").setup.buffer({linters = {"hack", "hhast"}})
<
===============================================================================
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*
hack_hack_executable
g:ale_hack_hack_executable
Type: |String|
Default: `'hh_client'`
@@ -26,8 +31,11 @@ g:ale_hack_hack_executable *g:ale_hack_hack_executable*
===============================================================================
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*
hack_hackfmt_options
g:ale_hack_hackfmt_options
Type: |String|
Default: `''`
@@ -37,9 +45,11 @@ g:ale_hack_hackfmt_options *g:ale_hack_hackfmt_options*
===============================================================================
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*
hack_hhast_executable
g:ale_hack_hhast_executable
Type: |String|
Default: `'vendor/bin/hhast-lint'`

View File

@@ -2,6 +2,12 @@
ALE Handlebars Integration *ale-handlebars-options*
===============================================================================
djlint *ale-handlebars-djlint*
See |ale-html-djlint|
===============================================================================
prettier *ale-handlebars-prettier*
@@ -12,18 +18,21 @@ Uses glimmer parser by default.
===============================================================================
ember-template-lint *ale-handlebars-embertemplatelint*
g:ale_handlebars_embertemplatelint_executable
*ale-options.handlebars_embertemplatelint_executable*
*g:ale_handlebars_embertemplatelint_executable*
*b:ale_handlebars_embertemplatelint_executable*
handlebars_embertemplatelint_executable
g:ale_handlebars_embertemplatelint_executable
Type: |String|
Default: `'ember-template-lint'`
See |ale-integrations-local-executables|
g:ale_handlebars_embertemplatelint_use_global
*ale-options.handlebars_embertemplatelint_use_global*
*g:ale_handlebars_embertemplatelint_use_global*
*b:ale_handlebars_embertemplatelint_use_global*
handlebars_embertemplatelint_use_global
g:ale_handlebars_embertemplatelint_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`

View File

@@ -5,8 +5,11 @@ ALE Haskell Integration *ale-haskell-options*
===============================================================================
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*
haskell_brittany_executable
g:ale_haskell_brittany_executable
Type: |String|
Default: `'brittany'`
@@ -22,8 +25,11 @@ See |ale-cspell-options|
===============================================================================
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*
haskell_floskell_executable
g:ale_haskell_floskell_executable
Type: |String|
Default: `'floskell'`
@@ -33,8 +39,11 @@ g:ale_haskell_floskell_executable *g:ale_haskell_floskell_executable*
===============================================================================
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*
haskell_ghc_options
g:ale_haskell_ghc_options
Type: |String|
Default: `'-fno-code -v0'`
@@ -44,8 +53,11 @@ g:ale_haskell_ghc_options *g:ale_haskell_ghc_options*
===============================================================================
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*
haskell_ghc_mod_executable
g:ale_haskell_ghc_mod_executable
Type: |String|
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*
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*
haskell_cabal_ghc_options
g:ale_haskell_cabal_ghc_options
Type: |String|
Default: `'-fno-code -v0'`
@@ -67,16 +82,21 @@ g:ale_haskell_cabal_ghc_options *g:ale_haskell_cabal_ghc_options*
===============================================================================
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*
haskell_hdevtools_executable
g:ale_haskell_hdevtools_executable
Type: |String|
Default: `'hdevtools'`
This variable can be changed to use a different executable for hdevtools.
g:ale_haskell_hdevtools_options *g:ale_haskell_hdevtools_options*
*ale-options.haskell_hdevtools_options*
*g:ale_haskell_hdevtools_options*
*b:ale_haskell_hdevtools_options*
haskell_hdevtools_options
g:ale_haskell_hdevtools_options
Type: |String|
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*
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*
haskell_hfmt_executable
g:ale_haskell_hfmt_executable
Type: |String|
Default: `'hfmt'`
@@ -102,8 +125,11 @@ g:ale_haskell_hfmt_executable *g:ale_haskell_hfmt_executable*
===============================================================================
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*
haskell_hindent_executable
g:ale_haskell_hindent_executable
Type: |String|
Default: `'hindent'`
@@ -113,16 +139,21 @@ g:ale_haskell_hindent_executable *g:ale_haskell_hindent_executable*
===============================================================================
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*
haskell_hlint_executable
g:ale_haskell_hlint_executable
Type: |String|
Default: `'hlint'`
This variable can be changed to use a different executable for hlint.
g:ale_haskell_hlint_options g:ale_haskell_hlint_options
b:ale_haskell_hlint_options
*ale-options.haskell_hlint_options*
*g:ale_haskell_hlint_options*
*b:ale_haskell_hlint_options*
haskell_hlint_options
g:ale_haskell_hlint_options
Type: |String|
Default: `''`
@@ -133,17 +164,22 @@ g:ale_haskell_hlint_options g:ale_haskell_hlint_options
===============================================================================
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*
haskell_hls_executable
g:ale_haskell_hls_executable
Type: |String|
Default: `'haskell-language-server-wrapper'`
This variable can be changed to use a different executable for the haskell
language server.
g:ale_haskell_hls_config *g:ale_haskell_hls_config*
*ale-options.haskell_hls_config*
*g:ale_haskell_hls_config*
*b:ale_haskell_hls_config*
haskell_hls_config
g:ale_haskell_hls_config
Type: |Dictionary|
Default: `{}`
@@ -159,8 +195,11 @@ g:ale_haskell_hls_config *g:ale_haskell_hls_config*
===============================================================================
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*
haskell_stack_build_options
g:ale_haskell_stack_build_options
Type: |String|
Default: `'--fast'`
@@ -171,8 +210,11 @@ g:ale_haskell_stack_build_options *g:ale_haskell_stack_build_options*
===============================================================================
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*
haskell_stack_ghc_options
g:ale_haskell_stack_ghc_options
Type: |String|
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*
g:ale_haskell_stylish_haskell_executable
*ale-options.haskell_stylish_haskell_executable*
*g:ale_haskell_stylish_haskell_executable*
*b:ale_haskell_stylish_haskell_executable*
haskell_stylish_haskell_executable
g:ale_haskell_stylish_haskell_executable
Type: |String|
Default: `'stylish-haskell'`
@@ -195,8 +239,11 @@ g:ale_haskell_stylish_haskell_executable
===============================================================================
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*
haskell_hie_executable
g:ale_haskell_hie_executable
Type: |String|
Default: `'hie'`
@@ -207,16 +254,21 @@ g:ale_haskell_hie_executable *g:ale_haskell_hie_executable*
===============================================================================
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*
haskell_ormolu_executable
g:ale_haskell_ormolu_executable
Type: |String|
Default: `'ormolu'`
This variable can be changed to use a different executable for ormolu.
g:ale_haskell_ormolu_options *g:ale_haskell_ormolu_options*
*ale-options.haskell_ormolu_options*
*g:ale_haskell_ormolu_options*
*b:ale_haskell_ormolu_options*
haskell_ormolu_options
g:ale_haskell_ormolu_options
Type: |String|
Default: `''`
@@ -227,16 +279,21 @@ g:ale_haskell_ormolu_options *g:ale_haskell_ormolu_options*
===============================================================================
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*
haskell_fourmolu_executable
g:ale_haskell_fourmolu_executable
Type: |String|
Default: `'fourmolu'`
This variable can be changed to use a different executable for fourmolu.
g:ale_haskell_fourmolu_options *g:ale_haskell_fourmolu_options*
*ale-options.haskell_fourmolu_options*
*g:ale_haskell_fourmolu_options*
*b:ale_haskell_fourmolu_options*
haskell_fourmolu_options
g:ale_haskell_fourmolu_options
Type: |String|
Default: `''`

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.
g:ale_html_angular_executable *g:ale_html_angular_executable*
*ale-options.html_angular_executable*
*g:ale_html_angular_executable*
*b:ale_html_angular_executable*
html_angular_executable
g:ale_html_angular_executable
Type: |String|
Default: `'ngserver'`
See |ale-integrations-local-executables|
g:ale_html_angular_use_global *g:ale_html_angular_use_global*
*ale-options.html_angular_use_global*
*g:ale_html_angular_use_global*
*b:ale_html_angular_use_global*
html_angular_use_global
g:ale_html_angular_use_global
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -33,19 +37,28 @@ cspell *ale-html-cspell*
See |ale-cspell-options|
===============================================================================
djlint *ale-html-djlint*
g:ale_html_djlint_executable *g:ale_html_djlint_executable*
`djlint` options for HTML are the same as the options for htmlangular,
htmldjango, jinja, handlebars, nunjucks and gotmplhtml.
*ale-options.html_djlint_executable*
*g:ale_html_djlint_executable*
*b:ale_html_djlint_executable*
html_djlint_executable
g:ale_html_djlint_executable
Type: |String|
Default: `'djlint'`
See |ale-integrations-local-executables|
g:ale_html_djlint_options *g:ale_html_djlint_options*
*b:ale_html_djlint_options*
*ale-options.html_djlint_options*
*g:ale_html_djlint_options*
*b:ale_html_djlint_options*
html_djlint_options
g:ale_html_djlint_options
Type: |String|
Default: `''`
@@ -64,24 +77,31 @@ See: |ale-javascript-fecs|.
===============================================================================
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*
html_beautify_executable
g:ale_html_beautify_executable
Type: |String|
Default: `'html-beautify'`
See |ale-integrations-local-executables|
g:ale_html_beautify_options *g:ale_html_beautify_options*
*ale-options.html_beautify_options*
*g:ale_html_beautify_options*
*b:ale_html_beautify_options*
html_beautify_options
g:ale_html_beautify_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to html-beautify.
g:ale_html_beautify_use_global *g:ale_html_beautify_use_global*
*ale-options.html_beautify_use_global*
*g:ale_html_beautify_use_global*
*b:ale_html_beautify_use_global*
html_beautify_use_global
g:ale_html_beautify_use_global
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -91,24 +111,31 @@ g:ale_html_beautify_use_global *g:ale_html_beautify_use_global*
===============================================================================
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*
html_htmlhint_executable
g:ale_html_htmlhint_executable
Type: |String|
Default: `'htmlhint'`
See |ale-integrations-local-executables|
g:ale_html_htmlhint_options *g:ale_html_htmlhint_options*
*ale-options.html_htmlhint_options*
*g:ale_html_htmlhint_options*
*b:ale_html_htmlhint_options*
html_htmlhint_options
g:ale_html_htmlhint_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to HTMLHint.
g:ale_html_htmlhint_use_global *g:ale_html_htmlhint_use_global*
*ale-options.html_htmlhint_use_global*
*g:ale_html_htmlhint_use_global*
*b:ale_html_htmlhint_use_global*
html_htmlhint_use_global
g:ale_html_htmlhint_use_global
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -124,16 +151,21 @@ See |ale-javascript-prettier| for information about the available options.
===============================================================================
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*
html_rustywind_executable
g:ale_html_rustywind_executable
Type: |String|
Default: `'rustywind'`
See |ale-integrations-local-executables|
g:ale_html_rustywind_options *g:ale_html_rustywind_options*
*ale-options.html_rustywind_options*
*g:ale_html_rustywind_options*
*b:ale_html_rustywind_options*
html_rustywind_options
g:ale_html_rustywind_options
Type: |String|
Default: `''`
@@ -143,24 +175,31 @@ g:ale_html_rustywind_options *g:ale_html_rustywind_options*
===============================================================================
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*
html_stylelint_executable
g:ale_html_stylelint_executable
Type: |String|
Default: `'stylelint'`
See |ale-integrations-local-executables|
g:ale_html_stylelint_options *g:ale_html_stylelint_options*
*ale-options.html_stylelint_options*
*g:ale_html_stylelint_options*
*b:ale_html_stylelint_options*
html_stylelint_options
g:ale_html_stylelint_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to stylelint.
g:ale_html_stylelint_use_global *g:ale_html_stylelint_use_global*
*ale-options.html_stylelint_use_global*
*g:ale_html_stylelint_use_global*
*b:ale_html_stylelint_use_global*
html_stylelint_use_global
g:ale_html_stylelint_use_global
Type: |String|
Default: `0`
@@ -185,16 +224,24 @@ To use `tidy` on macOS, please install the latest version with Homebrew:
<
`/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*
html_tidy_executable
g:ale_html_tidy_executable
Type: |String|
Default: `'tidy'`
This variable can be changed to change the path to tidy.
g:ale_html_tidy_options *g:ale_html_tidy_options*
*ale-options.html_tidy_options*
*g:ale_html_tidy_options*
*b:ale_html_tidy_options*
html_tidy_options
g:ale_html_tidy_options
Type: |String|
Default: `'-q -e -language en'`
@@ -208,9 +255,10 @@ g:ale_html_tidy_options *g:ale_html_tidy_options*
cp850 (ibm858), cp932 (shiftjis), iso-2022-jp (iso-2022), latin1, macroman
(mac), sjis (shiftjis), utf-16le, utf-16, utf-8
g:ale_html_tidy_use_global *g:html_tidy_use_global*
*ale-options.html_tidy_use_global*
*g:ale_html_tidy_use_global*
html_tidy_use_global
g:ale_html_tidy_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
@@ -222,8 +270,9 @@ vscodehtml *ale-html-vscode*
Website: https://github.com/hrsh7th/vscode-langservers-extracted
Installation
-------------------------------------------------------------------------------
Installation
Install VSCode html language server either globally or locally: >

12
doc/ale-htmlangular.txt Normal file
View File

@@ -0,0 +1,12 @@
===============================================================================
ALE HTML Angular Template Integration *ale-htmlangular-options*
===============================================================================
djlint *ale-htmlangular-djlint*
See |ale-html-djlint|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

12
doc/ale-htmldjango.txt Normal file
View File

@@ -0,0 +1,12 @@
===============================================================================
ALE HTML Django Template Integration *ale-htmldjango-options*
===============================================================================
djlint *ale-htmldjango-djlint*
See |ale-html-djlint|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

20
doc/ale-http.txt Normal file
View File

@@ -0,0 +1,20 @@
===============================================================================
ALE HTTP Integration *ale-http-options*
===============================================================================
kulala_fmt *ale-http-kulala_fmt*
*ale-options.http_kulala_fmt_executable*
*g:ale_http_kulala_fmt_executable*
*b:ale_http_kulala_fmt_executable*
http_kulala_fmt
g:ale_http_kulala_fmt
Type: |String|
Default: `'kulala_fmt'`
Override the invoked kulala_fmt binary.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -5,8 +5,11 @@ ALE Hurl Integration *ale-hurl-options*
===============================================================================
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*
hurl_hurlfmt_executable
g:ale_hurl_hurlfmt_executable
Type: |String|
Default: `'hurlfmt'`

View File

@@ -1,23 +1,30 @@
===============================================================================
ALE Idris Integration *ale-idris-options*
===============================================================================
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*
idris_idris_executable
g:ale_idris_idris_executable
Type: |String|
Default: `'idris'`
This variable can be changed to change the path to idris.
g:ale_idris_idris_options *g:ale_idris_idris_options*
*ale-options.idris_idris_options*
*g:ale_idris_idris_options*
*b:ale_idris_idris_options*
idris_idris_options
g:ale_idris_idris_options
Type: |String|
Default: `'--total --warnpartial --warnreach --warnipkg'`
This variable can be changed to modify flags given to idris.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -5,19 +5,23 @@ ALE Ink Integration *ale-ink-options*
===============================================================================
ink-language-server *ale-ink-language-server*
Ink Language Server
(https://github.com/ephraim/ink-language-server)
Ink Language Server - https://github.com/ephraim/ink-language-server
g:ale_ink_ls_executable g:ale_ink_ls_executable
b:ale_ink_ls_executable
*ale-options.ink_ls_executable*
*g:ale_ink_ls_executable*
*b:ale_ink_ls_executable*
ink_ls_executable
g:ale_ink_ls_executable
Type: |String|
Default: `'ink-language-server'`
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
b:ale_ink_ls_initialization_options
Type: |Dictionary|
Default: `{}`
@@ -27,14 +31,16 @@ g:ale_ink_ls_initialization_options
change these settings - see the ink-language-server website for more
information.
An example of setting non-default options:
{
\ 'ink': {
\ 'mainStoryPath': 'init.ink',
\ 'inklecateExecutablePath': '/usr/local/bin/inklecate',
\ 'runThroughMono': v:false
\ }
\}
An example of setting non-default options: >
let g:ale_ink_ls_initialization_options = {
\ 'ink': {
\ 'mainStoryPath': 'init.ink',
\ 'inklecateExecutablePath': '/usr/local/bin/inklecate',
\ 'runThroughMono': v:false,
\ },
\}
<
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -2,16 +2,15 @@
ALE Inko Integration *ale-inko-options*
*ale-integration-inko*
===============================================================================
Integration Information
Currently, the only supported linter for Inko is the Inko compiler itself.
===============================================================================
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*
inko_inko_executable
g:ale_inko_inko_executable
Type: |String|
Default: `'inko'`

View File

@@ -5,20 +5,26 @@ ALE ISPC Integration *ale-ispc-options*
===============================================================================
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*
ispc_ispc_executable
g:ale_ispc_ispc_executable
Type: |String|
Default: `'ispc'`
This variable can be changed to use a different executable for ispc.
g:ale_ispc_ispc_options *g:ale_ispc_ispc_options*
*ale-options.ispc_ispc_options*
*g:ale_ispc_ispc_options*
*b:ale_ispc_ispc_options*
ispc_ispc_options
g:ale_ispc_ispc_options
Type: |String|
Default: `''`
This variable can be changed to modify flags given to ispc.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -5,9 +5,11 @@ ALE Java Integration *ale-java-options*
===============================================================================
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*
java_checkstyle_config
g:ale_java_checkstyle_config
Type: |String|
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
path. ALE will search for the relative path in parent directories.
g:ale_java_checkstyle_executable *g:ale_java_checkstyle_executable*
*ale-options.java_checkstyle_executable*
*g:ale_java_checkstyle_executable*
*b:ale_java_checkstyle_executable*
java_checkstyle_executable
g:ale_java_checkstyle_executable
Type: |String|
Default: `'checkstyle'`
This variable can be changed to modify the executable used for checkstyle.
g:ale_java_checkstyle_options *g:ale_java_checkstyle_options*
*ale-options.java_checkstyle_options*
*g:ale_java_checkstyle_options*
*b:ale_java_checkstyle_options*
java_checkstyle_options
g:ale_java_checkstyle_options
Type: |String|
Default: `''`
@@ -57,68 +61,80 @@ See |ale-cspell-options|
===============================================================================
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*
java_javac_classpath
g:ale_java_javac_classpath
Type: |String| or |List|
Default: `''`
This variable can be set to change the global classpath for Java.
g:ale_java_javac_executable *g:ale_java_javac_executable*
*ale-options.java_javac_executable*
*g:ale_java_javac_executable*
*b:ale_java_javac_executable*
java_javac_executable
g:ale_java_javac_executable
Type: |String|
Default: `'javac'`
This variable can be set to change the executable path used for javac.
g:ale_java_javac_options *g:ale_java_javac_options*
*ale-options.java_javac_options*
*g:ale_java_javac_options*
*b:ale_java_javac_options*
java_javac_options
g:ale_java_javac_options
Type: |String|
Default: `''`
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*
java_javac_sourcepath
g:ale_java_javac_sourcepath
Type: |String| or |List|
Default: `''`
This variable can set multiple source code paths, the source code path is a
relative path (relative to the project root directory).
This variable can set multiple source code paths, the source code path is a
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'
<
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 = [
\ 'build/generated/source/querydsl/main',
\ 'target/generated-sources/source/querydsl/main'
\ ]
\ 'build/generated/source/querydsl/main',
\ 'target/generated-sources/source/querydsl/main',
\]
<
===============================================================================
google-java-format *ale-java-google-java-format*
g:ale_java_google_java_format_executable
*ale-options.java_google_java_format_executable*
*g: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|
Default: `'google-java-format'`
See |ale-integrations-local-executables|
g:ale_java_google_java_format_options *g:ale_java_google_java_format_options*
*ale-options.java_google_java_format_options*
*g: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|
Default: `''`
@@ -128,9 +144,11 @@ g:ale_java_google_java_format_options *g:ale_java_google_java_format_options*
===============================================================================
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*
java_pmd_options
g:ale_java_pmd_options
Type: |String|
Default: `'-R category/java/bestpractices'`
@@ -151,56 +169,77 @@ set.
After downloading the source code and installing all pre-requisites you can
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
within the repo:
- lang_server_linux.sh
- lang_server_mac.sh
- lang_server_windows.sh
- `lang_server_linux.sh`
- `lang_server_mac.sh`
- `lang_server_windows.sh`
To let ALE use this language server you need to set the
g:ale_java_javalsp_executable variable to the absolute path of the launcher
executable for your platform.
To let ALE use this language server you need to set the executable, as
documented below.
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*
java_javalsp_executable
g:ale_java_javalsp_executable
Type: |String|
Default: `''`
This variable must be set to the absolute path of the language server launcher
executable. For example:
>
let g:ale_java_javalsp_executable=/java-language-server/dist/lang_server_linux.sh
<
This variable must be set to the absolute path of the language server
launcher executable. For example: >
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*
java_javalsp_config
g:ale_java_javalsp_config
Type: |Dictionary|
Default: `{}`
The javalsp linter automatically detects external dependencies for Maven and
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.
>
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 javalsp linter automatically detects external dependencies for Maven and
Gradle projects. In case the javalsp fails to detect some of them, you can
specify them configuring settings for the language server, such as in your
ftplugin file. >
The Java language server will look for the dependencies you specify in
`externalDependencies` array in your Maven and Gradle caches ~/.m2 and
~/.gradle.
let b:ale_java_javalsp_config = {
\ 'java': {
\ '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
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
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
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*
java_eclipselsp_path
g:ale_java_eclipselsp_path
Type: |String|
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
Linux).
g:ale_java_eclipselsp_executable *g:ale_java_eclipse_executable*
*ale-options.java_eclipselsp_executable*
*g:ale_java_eclipselsp_executable*
*b:ale_java_eclipse_executable*
java_eclipselsp_executable
g:ale_java_eclipselsp_executable
Type: |String|
Default: `'java'`
This variable can be set to change the executable path used for java.
g:ale_java_eclipselsp_config_path *g:ale_java_eclipse_config_path*
*ale-options.java_eclipselsp_config_path*
*g:ale_java_eclipselsp_config_path*
*b:ale_java_eclipse_config_path*
java_eclipselsp_config_path
g:ale_java_eclipselsp_config_path
Type: |String|
Default: `''`
Set this variable to change the configuration directory path used by
eclipselsp (e.g. `$HOME/.jdtls` in Linux).
By default ALE will attempt to use the configuration within the installation
directory.
eclipselsp (e.g. `$HOME/.jdtls` in Linux). By default ALE will attempt to
use the configuration within the installation directory.
This setting is particularly useful when eclipselsp is installed in a
non-writable directory like `/usr/share/java/jdtls`, as is the case when
installed via system package.
g:ale_java_eclipselsp_workspace_path *g:ale_java_eclipselsp_workspace_path*
*ale-options.java_eclipselsp_workspace_path*
*g:ale_java_eclipselsp_workspace_path*
*b:ale_java_eclipselsp_workspace_path*
java_eclipselsp_workspace_path
g:ale_java_eclipselsp_workspace_path
Type: |String|
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
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*
java_eclipselsp_javaagent
g:ale_java_eclipselsp_javaagent
Type: |String|
Default: `''`
A variable to add java agent for annotation processing such as Lombok.
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'
<

View File

@@ -1,6 +1,5 @@
===============================================================================
ALE JavaScript Integration *ale-javascript-options*
*ale-eslint-nested-configuration-files*
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"]
<
===============================================================================
biome *ale-javascript-biome*
@@ -59,33 +57,42 @@ See |ale-dprint-options| and https://dprint.dev/plugins/typescript
===============================================================================
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*
javascript_eslint_executable
g:ale_javascript_eslint_executable
Type: |String|
Default: `'eslint'`
See |ale-integrations-local-executables|
g:ale_javascript_eslint_options *g:ale_javascript_eslint_options*
*ale-options.javascript_eslint_options*
*g:ale_javascript_eslint_options*
*b:ale_javascript_eslint_options*
javascript_eslint_options
g:ale_javascript_eslint_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to eslint.
g:ale_javascript_eslint_use_global *g:ale_javascript_eslint_use_global*
*ale-options.javascript_eslint_use_global*
*g:ale_javascript_eslint_use_global*
*b:ale_javascript_eslint_use_global*
javascript_eslint_use_global
g:ale_javascript_eslint_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_javascript_eslint_suppress_eslintignore
*ale-options.javascript_eslint_suppress_eslintignore*
*g:ale_javascript_eslint_suppress_eslintignore*
*b:ale_javascript_eslint_suppress_eslintignore*
javascript_eslint_suppress_eslintignore
g:ale_javascript_eslint_suppress_eslintignore
Type: |Number|
Default: `0`
@@ -93,9 +100,11 @@ g:ale_javascript_eslint_suppress_eslintignore
by eslint.
g:ale_javascript_eslint_suppress_missing_config
*ale-options.javascript_eslint_suppress_missing_config*
*g: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|
Default: `0`
@@ -116,17 +125,21 @@ fecs *ale-javascript-fecs*
And the configuration file is located at `./fecsrc`, see http://fecs.baidu.com
for more options.
g:ale_javascript_fecs_executable *g:ale_javascript_fecs_executable*
*ale-options.javascript_fecs_executable*
*g:ale_javascript_fecs_executable*
*b:ale_javascript_fecs_executable*
javascript_fecs_executable
g:ale_javascript_fecs_executable
Type: |String|
Default: `'fecs'`
See |ale-integrations-local-executables|
g:ale_javascript_fecs_use_global *g:ale_javascript_fecs_use_global*
*ale-options.javascript_fecs_use_global*
*g:ale_javascript_fecs_use_global*
*b:ale_javascript_fecs_use_global*
javascript_fecs_use_global
g:ale_javascript_fecs_use_global
Type: |Number|
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*
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*
javascript_flow_executable
g:ale_javascript_flow_executable
Type: |String|
Default: `'flow'`
See |ale-integrations-local-executables|
g:ale_javascript_flow_use_home_config *g:ale_javascript_flow_use_home_config*
*ale-options.javascript_flow_use_home_config*
*g: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|
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
your RAM and CPU power.
g:ale_javascript_flow_use_global *g:ale_javascript_flow_use_global*
*ale-options.javascript_flow_use_global*
*g:ale_javascript_flow_use_global*
*b:ale_javascript_flow_use_global*
javascript_flow_use_global
g:ale_javascript_flow_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
g:ale_javascript_flow_use_respect_pragma
*ale-options.javascript_flow_use_respect_pragma*
*g: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|
Default: `1`
@@ -177,8 +198,11 @@ g:ale_javascript_flow_use_respect_pragma
===============================================================================
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*
javascript_importjs_executable
g:ale_javascript_importjs_executable
Type: |String|
Default: `'importjs'`
@@ -186,16 +210,21 @@ g:ale_javascript_importjs_executable *g:ale_javascript_importjs_executable*
===============================================================================
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*
javascript_jscs_executable
g:ale_javascript_jscs_executable
Type: |String|
Default: `'jscs'`
See |ale-integrations-local-executables|
g:ale_javascript_jscs_use_global *g:ale_javascript_jscs_use_global*
*ale-options.javascript_jscs_use_global*
*g:ale_javascript_jscs_use_global*
*b:ale_javascript_jscs_use_global*
javascript_jscs_use_global
g:ale_javascript_jscs_use_global
Type: |Number|
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*
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*
javascript_jshint_executable
g:ale_javascript_jshint_executable
Type: |String|
Default: `'jshint'`
See |ale-integrations-local-executables|
g:ale_javascript_jshint_use_global *g:ale_javascript_jshint_use_global*
*ale-options.javascript_jshint_use_global*
*g:ale_javascript_jshint_use_global*
*b:ale_javascript_jshint_use_global*
javascript_jshint_use_global
g:ale_javascript_jshint_use_global
Type: |Number|
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*
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*
javascript_prettier_executable
g:ale_javascript_prettier_executable
Type: |String|
Default: `'prettier'`
See |ale-integrations-local-executables|
g:ale_javascript_prettier_options *g:ale_javascript_prettier_options*
*ale-options.javascript_prettier_options*
*g:ale_javascript_prettier_options*
*b:ale_javascript_prettier_options*
javascript_prettier_options
g:ale_javascript_prettier_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to prettier.
g:ale_javascript_prettier_use_global *g:ale_javascript_prettier_use_global*
*ale-options.javascript_prettier_use_global*
*g:ale_javascript_prettier_use_global*
*b:ale_javascript_prettier_use_global*
javascript_prettier_use_global
g:ale_javascript_prettier_use_global
Type: |Number|
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*
g:ale_javascript_prettier_eslint_executable
*ale-options.javascript_prettier_eslint_executable*
*g:ale_javascript_prettier_eslint_executable*
*b:ale_javascript_prettier_eslint_executable*
javascript_prettier_eslint_executable
g:ale_javascript_prettier_eslint_executable
Type: |String|
Default: `'prettier-eslint'`
See |ale-integrations-local-executables|
g:ale_javascript_prettier_eslint_options
*ale-options.javascript_prettier_eslint_options*
*g:ale_javascript_prettier_eslint_options*
*b:ale_javascript_prettier_eslint_options*
javascript_prettier_eslint_options
g:ale_javascript_prettier_eslint_options
Type: |String|
Default: `''`
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*
*b:ale_javascript_prettier_eslint_use_global*
javascript_prettier_eslint_use_global
g:ale_javascript_prettier_eslint_use_global
Type: |Number|
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*
g:ale_javascript_prettier_standard_executable
*ale-options.javascript_prettier_standard_executable*
*g:ale_javascript_prettier_standard_executable*
*b:ale_javascript_prettier_standard_executable*
javascript_prettier_standard_executable
g:ale_javascript_prettier_standard_executable
Type: |String|
Default: `'prettier-standard'`
See |ale-integrations-local-executables|
g:ale_javascript_prettier_standard_options
*ale-options.javascript_prettier_standard_options*
*g:ale_javascript_prettier_standard_options*
*b:ale_javascript_prettier_standard_options*
javascript_prettier_standard_options
g:ale_javascript_prettier_standard_options
Type: |String|
Default: `''`
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*
*b:ale_javascript_prettier_standard_use_global*
javascript_prettier_standard_use_global
g:ale_javascript_prettier_standard_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
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*
javascript_standard_executable
g:ale_javascript_standard_executable
Type: |String|
Default: `'standard'`
See |ale-integrations-local-executables|
g:ale_javascript_standard_options *g:ale_javascript_standard_options*
*ale-options.javascript_standard_options*
*g:ale_javascript_standard_options*
*b:ale_javascript_standard_options*
javascript_standard_options
g:ale_javascript_standard_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to standard.
g:ale_javascript_standard_use_global *g:ale_javascript_standard_use_global*
*ale-options.javascript_standard_use_global*
*g:ale_javascript_standard_use_global*
*b:ale_javascript_standard_use_global*
javascript_standard_use_global
g:ale_javascript_standard_use_global
Type: |Number|
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*
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*
javascript_xo_executable
g:ale_javascript_xo_executable
Type: |String|
Default: `'xo'`
See |ale-integrations-local-executables|
g:ale_javascript_xo_options *g:ale_javascript_xo_options*
*ale-options.javascript_xo_options*
*g:ale_javascript_xo_options*
*b:ale_javascript_xo_options*
javascript_xo_options
g:ale_javascript_xo_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to xo.
g:ale_javascript_xo_use_global *g:ale_javascript_xo_use_global*
*ale-options.javascript_xo_use_global*
*g:ale_javascript_xo_use_global*
*b:ale_javascript_xo_use_global*
javascript_xo_use_global
g:ale_javascript_xo_use_global
Type: |Number|
Default: `get(g:, 'ale_use_global_executables', 0)`

12
doc/ale-jinja.txt Normal file
View File

@@ -0,0 +1,12 @@
===============================================================================
ALE Jinja Integration *ale-jinja-options*
===============================================================================
djlint *ale-jinja-djlint*
See |ale-html-djlint|
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -57,26 +57,34 @@ You can install it using npm:
<
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*
json_fixjson_executable
g:ale_json_fixjson_executable
Type: |String|
Default: `'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*
json_fixjson_options
g:ale_json_fixjson_options
Type: |String|
Default: `''`
This variable can add extra options to the command executed for running
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*
json_fixjson_use_global
g:ale_json_fixjson_use_global
Type: |Number|
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.
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*
json_pytool_executable
g:ale_json_pytool_executable
Type: |String|
Default: `'python'`
The python executable that run to use its json.tool module. This fixer
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*
json_pytool_options
g:ale_json_pytool_options
Type: |String|
Default: `''`
@@ -108,9 +120,11 @@ g:ale_json_pytool_options *g:ale_json_pytool_options*
< See docs for all options:
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*
json_pytool_use_global
g:ale_json_pytool_use_global
Type: |Number|
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*
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*
json_jsonlint_executable
g:ale_json_jsonlint_executable
Type: |String|
Default: `'jsonlint'`
The executable that will be run for jsonlint.
g:ale_json_jsonlint_use_global *g:ale_json_jsonlint_use_global*
*b:ale_json_jsonlint_use_global*
*ale-options.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|
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*
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*
json_jq_executable
g:ale_json_jq_executable
Type: |String|
Default: `'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*
json_jq_options
g:ale_json_jq_options
Type: |String|
Default: `''`
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*
json_jq_filters
g:ale_json_jq_filters
Type: |String|
Default: `'.'`
@@ -174,8 +201,9 @@ spectral *ale-json-spectral*
Website: https://github.com/stoplightio/spectral
Installation
-------------------------------------------------------------------------------
Installation
Install spectral either globally or locally: >
@@ -183,30 +211,37 @@ Install spectral either globally or locally: >
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*
json_spectral_executable
g:ale_json_spectral_executable
Type: |String|
Default: `'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*
json_spectral_use_global
g:ale_json_spectral_use_global
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`
See |ale-integrations-local-executables|
===============================================================================
vscodejson *ale-json-vscode*
Website: https://github.com/hrsh7th/vscode-langservers-extracted
Installation
-------------------------------------------------------------------------------
Installation
Install VSCode json language server either globally or locally: >

View File

@@ -5,16 +5,21 @@ ALE Jsonnet Integration *ale-jsonnet-options*
===============================================================================
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*
jsonnet_jsonnetfmt_executable
g:ale_jsonnet_jsonnetfmt_executable
Type: |String|
Default: `'jsonnetfmt'`
This option can be changed to change the path for `jsonnetfmt`.
g:ale_jsonnet_jsonnetfmt_options *g:ale_jsonnet_jsonnetfmt_options*
*ale-options.jsonnet_jsonnetfmt_options*
*g:ale_jsonnet_jsonnetfmt_options*
*b:ale_jsonnet_jsonnetfmt_options*
jsonnet_jsonnetfmt_options
g:ale_jsonnet_jsonnetfmt_options
Type: |String|
Default: `''`
@@ -24,20 +29,26 @@ g:ale_jsonnet_jsonnetfmt_options *g:ale_jsonnet_jsonnetfmt_options*
===============================================================================
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*
jsonnet_jsonnet_lint_executable
g:ale_jsonnet_jsonnet_lint_executable
Type: |String|
Default: `'jsonnet-lint'`
This option can be changed to change the path for `jsonnet-lint`.
g:ale_jsonnet_jsonnet_lint_options *g:ale_jsonnet_jsonnet_lint_options*
*b:ale_jsonnet_jsonnet_lint_options*
*ale-options.jsonnet_jsonnet_lint_options*
*g:ale_jsonnet_jsonnet_lint_options*
*b:ale_jsonnet_jsonnet_lint_options*
jsonnet_jsonnet_lint_options
g:ale_jsonnet_jsonnet_lint_options
Type: |String|
Default: `''`
This option can be changed to pass extra options to `jsonnet-lint`.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -1,20 +1,23 @@
===============================================================================
ALE Julia Integration *ale-julia-options*
===============================================================================
languageserver *ale-julia-languageserver*
To enable Julia LSP linter you need to install the LanguageServer.jl package
within julia.
g:ale_julia_executable *g:ale_julia_executable*
*ale-options.julia_executable*
*g:ale_julia_executable*
*b:ale_julia_executable*
julia_executable
g:ale_julia_executable
Type: |String|
Default: `'julia'`
Path to the julia exetuable.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

View File

@@ -15,47 +15,75 @@ Integration Information
===============================================================================
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|
Default: `''`
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|
Default: `0`
Setting this variable to `1` tells the linter to load a configuration file.
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|
Default: `'.ale_kotlin_kotlinc_config'`
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|
Default: `''`
A string containing the paths (separated by the appropriate path separator)
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|
Default: `''`
A string containing the paths (separated by space) of the source
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|
Default: `0`
This option indicates whether the linter should use a module file. It is off
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|
Default: `'module.xml'`
@@ -66,7 +94,11 @@ g:ale_kotlin_kotlinc_module_filename *g:ale_kotlin_kotlinc_module_filename*
===============================================================================
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|
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
similar to `'java -jar /path/to/ktlint.jar'`
g:ale_kotlin_ktlint_rulesets *g:ale_kotlin_ktlint_rulesets*
Type: |List| of |String|s
*ale-options.kotlin_ktlint_rulesets*
*g:ale_kotlin_ktlint_rulesets*
*b:ale_kotlin_ktlint_rulesets*
kotlin_ktlint_rulesets
g:ale_kotlin_ktlint_rulesets
Type: |List|
Default: `[]`
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',
'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|
Default: `''`
Additional options to pass to ktlint for both linting and fixing. Example:
>
let g:ale_kotlin_ktlint_options = '--android'
Options to pass to ktlint for both linting and fixing. For example: >
let g:ale_kotlin_ktlint_options = '--android'
<
===============================================================================
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|
Default: `''`

View File

@@ -5,24 +5,31 @@ ALE Less Integration *ale-less-options*
===============================================================================
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*
less_lessc_executable
g:ale_less_lessc_executable
Type: |String|
Default: `'lessc'`
See |ale-integrations-local-executables|
g:ale_less_lessc_options *g:ale_less_lessc_options*
*ale-options.less_lessc_options*
*g:ale_less_lessc_options*
*b:ale_less_lessc_options*
less_lessc_options
g:ale_less_lessc_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to lessc.
g:ale_less_lessc_use_global *g:ale_less_lessc_use_global*
*ale-options.less_lessc_use_global*
*g:ale_less_lessc_use_global*
*b:ale_less_lessc_use_global*
less_lessc_use_global
g:ale_less_lessc_use_global
Type: |String|
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*
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*
less_stylelint_executable
g:ale_less_stylelint_executable
Type: |String|
Default: `'stylelint'`
See |ale-integrations-local-executables|
g:ale_less_stylelint_options *g:ale_less_stylelint_options*
*ale-options.less_stylelint_options*
*g:ale_less_stylelint_options*
*b:ale_less_stylelint_options*
less_stylelint_options
g:ale_less_stylelint_options
Type: |String|
Default: `''`
This variable can be set to pass additional options to stylelint.
g:ale_less_stylelint_use_global *g:ale_less_stylelint_use_global*
*ale-options.less_stylelint_use_global*
*g:ale_less_stylelint_use_global*
*b:ale_less_stylelint_use_global*
less_stylelint_use_global
g:ale_less_stylelint_use_global
Type: |String|
Default: `get(g:, 'ale_use_global_executables', 0)`

View File

@@ -5,9 +5,11 @@ ALE LLVM Integration *ale-llvm-options*
===============================================================================
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*
llvm_llc_executable
g:ale_llvm_llc_executable
Type: |String|
Default: `"llc"`

View File

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

View File

@@ -5,8 +5,11 @@ ALE Make Integration *ale-make-options
===============================================================================
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*
make_checkmake_config
g:ale_make_checkmake_config
Type: |String|
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
option.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:

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