diff options
Diffstat (limited to 'doc/ale.txt')
| -rw-r--r-- | doc/ale.txt | 34 |
1 files changed, 22 insertions, 12 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index 6cc0026d..60178ee1 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -274,6 +274,7 @@ CONTENTS *ale-contents* write-good..........................|ale-vim-help-write-good| vue...................................|ale-vue-options| prettier............................|ale-vue-prettier| + vls.................................|ale-vue-vls| xhtml.................................|ale-xhtml-options| write-good..........................|ale-xhtml-write-good| xml...................................|ale-xml-options| @@ -419,7 +420,7 @@ Notes: * Verilog: `iverilog`, `verilator` * Vim: `vint` * Vim help^: `alex`!!, `proselint`, `write-good` -* Vue: `prettier` +* Vue: `prettier`, `vls` * XHTML: `alex`!!, `proselint`, `write-good` * XML: `xmllint` * YAML: `swaglint`, `yamllint` @@ -642,9 +643,6 @@ ALE supports the following LSP/tsserver features. ------------------------------------------------------------------------------- 5.1 Completion *ale-completion* -NOTE: At the moment, only `tsserver` for TypeScript code is supported for -completion. - ALE offers limited support for automatic completion of code while you type. Completion is only supported while a least one LSP linter is enabled. ALE will only suggest symbols provided by the LSP servers. @@ -2384,9 +2382,12 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* with a callback returning an address to connect to. ALE will not start a server automatically. - When this argument is not empty, only one of either - `language` or `language_callback` must be defined, - and `project_root_callback` must be defined. + When this argument is not empty + `project_root_callback` must be defined. + + `language` or `language_callback` can be defined to + describe the language for a file. The filetype will + be used as the language by default. LSP linters handle diagnostics automatically, so the `callback` argument must not be defined. @@ -2419,8 +2420,9 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* being checked. This string will be sent to the LSP to tell it what type of language is being checked. - This argument must only be set if the `lsp` argument - is also set to a non-empty string. + If this or `language_callback` isn't set, the + language will default to the value of the filetype + given to |ale#linter#Define|. `language_callback` A |String| or |Funcref| for a callback function accepting a buffer number. A |String| should be @@ -2491,14 +2493,22 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* For example: > 'command': 'ghc -fno-code -v0 %t', < + Any substring `%e` will be replaced with the escaped executable supplied + with `executable` or `executable_callback`. This provides a convenient way + to define a command string which needs to include a dynamic executable name, + but which is otherwise static. + + For example: > + 'command': '%e --some-argument', +< The character sequence `%%` can be used to emit a literal `%` into a command, so literal character sequences `%s` and `%t` can be escaped by using `%%s` and `%%t` instead, etc. If a callback for a command generates part of a command string which might - possibly contain `%%`, `%s`, or `%t` where the special formatting behaviour - is not desired, the |ale#engine#EscapeCommandPart()| function can be used to - replace those characters to avoid formatting issues. + possibly contain `%%`, `%s`, `%t`, or `%e`, where the special formatting + behavior is not desired, the |ale#engine#EscapeCommandPart()| function can + be used to replace those characters to avoid formatting issues. *ale-linter-loading-behavior* *ale-linter-loading-behaviour* |