diff options
| author | Kevin Svetlitski <kevin_svetlitski@berkeley.edu> | 2021-01-26 14:43:17 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-26 20:43:17 +0000 |
| commit | cab4280d02f0297ae10ab0611778389c7a5766ae (patch) | |
| tree | ab017d04390b3c0079f8413ab673044d0d6c0964 /doc/ale.txt | |
| parent | 3a1728297a915b6e41c6339d571e85bc3756e5ff (diff) | |
| download | ale-cab4280d02f0297ae10ab0611778389c7a5766ae.zip | |
Feature: Add support for named-pipe sockets for LSPs (#3509)
* Add support for using named pipes for lsp 'socket' servers; documentation updated accordingly
* Add tests for connecting to named pipe sockets
Diffstat (limited to 'doc/ale.txt')
| -rw-r--r-- | doc/ale.txt | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/ale.txt b/doc/ale.txt index bb87ed1a..e58fed72 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -228,8 +228,8 @@ A minimal configuration for a language server linter might look so. > \ 'project_root': '/path/to/root_of_project', \}) < -For language servers that use a TCP socket connection, you should define the -address to connect to instead. > +For language servers that use a TCP or named pipe socket connection, you +should define the address to connect to instead. > call ale#linter#Define('filetype_here', { \ 'name': 'any_name_you_want', @@ -3852,7 +3852,7 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* When this argument is set to `'socket'`, then the linter will be defined as an LSP linter via a TCP - socket connection. `address` must be set. + or named pipe socket connection. `address` must be set. ALE will not start a server automatically. @@ -3877,7 +3877,10 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()* `address` A |String| representing an address to connect to, or a |Funcref| accepting a buffer number and - returning the |String|. + returning the |String|. If the value contains a + colon, it is interpreted as referring to a TCP + socket; otherwise it is interpreted as the path of a + named pipe. The result can be computed with |ale#command#Run()|. |