vim/ale
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document the command empty string behaviour

Browse Source
This commit is contained in:
w0rp 2017-02-10 23:11:26 +00:00
parent 49f7ce4f6d
commit 81779e60bb
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/ale.txt
View File

@ -1075,6 +1075,11 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
place of `command` when more complicated processing place of `command` when more complicated processing
is needed. is needed.
If an empty string is returned from the callback,
no jobs for linting will be run for that linter.
This can be used for skipping a linter call,
say if no configuration file was found.
`command_chain` A |List| of |Dictionary| items defining a series `command_chain` A |List| of |Dictionary| items defining a series
of commands to be run. At least one |Dictionary| of commands to be run. At least one |Dictionary|
should be provided. Each Dictionary must contain the should be provided. Each Dictionary must contain the
@ -1091,6 +1096,13 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
a `(buffer)` argument, as there are no previous a `(buffer)` argument, as there are no previous
commands to run which return `output`. commands to run which return `output`.
If an empty string is returned for a command in a
chain, that command in the chain will be skipped,
and the next function in the chain will be called
immediately instead. If the last command in a chain
returns an empty string, then no linting will be
performed.
Commands in the chain will all use the Commands in the chain will all use the
`output_stream` value provided in the root `output_stream` value provided in the root
|Dictionary|. Each command in the chain can also |Dictionary|. Each command in the chain can also