diff options
Diffstat (limited to 'doc/ale.txt')
| -rw-r--r-- | doc/ale.txt | 46 |
1 files changed, 43 insertions, 3 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 5eff73bb..51da9463 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -1264,7 +1264,10 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* search by in future before being passed on to the |loclist|, etc. - This argument is required. + This argument is required, unless the linter is an + LSP linter. In which case, this argument must not be + defined, as LSP linters handle diangostics + automatically. See |ale-lsp-linters|. The keys for each item in the List will be handled in the following manner: @@ -1395,10 +1398,47 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* be set automatically to `0`. The two options cannot be used together. + *ale-lsp-linters* + `lsp` A |String| for defining LSP (Language Server Protocol) + linters. + + This argument may be omitted or `''` when a linter + does not represent an LSP linter. + + When this argument is set to `'stdio'`, then the + linter will be defined as an LSP linter which keeps a + process for a language server runnning, and + communicates with it directly via a |channel|. + + When this argument is not empty, then the + `project_callback` and `language_callback` arguments + must also be defined. + + LSP linters handle diagonstics automatically, so + the `callback` argument must not be defined. + + `project_callback` A |String| or |Funcref| for a callback function + accepting a buffer number. A |String| should be + returned representing the path to the project for the + file being checked with the language server. If an + empty string is returned, the file will not be + checked at all. + + This argument must only be set if the `lsp` argument + is also set to a non-empty string. + + `language_callback` A |String| or |Funcref| for a callback function + accepting a buffer number. A |String| should be + returned representing the name of the language being + checked. + + This argument must only be set if the `lsp` argument + is also set to a non-empty string. + `aliases` A |List| of aliases for the linter name. - This option can be set with alternative names for - for selecting the linter with |g:ale_linters|. This + This argument can be set with alternative names for + selecting the linter with |g:ale_linters|. This setting can make it easier to guess the linter name by offering a few alternatives. |