summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBen Falconer <ben@falconers.me.uk>2018-06-06 16:58:49 +0100
committerBen Falconer <ben@falconers.me.uk>2018-06-06 17:53:36 +0100
commit1a4b08539bf44ef84516d26760093734e0257340 (patch)
treebd43a882f718b250e2219981692ecd126b55ddfe /doc
parentc49ea1a5e336f9b9e31a8de362b42f33aa79eb95 (diff)
downloadale-1a4b08539bf44ef84516d26760093734e0257340.zip
Allow initialization options to be passed to language servers
Diffstat (limited to 'doc')
-rw-r--r--doc/ale.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/ale.txt b/doc/ale.txt
index 66a81f3a..0808e2ac 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2331,6 +2331,10 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
An optional `completion_filter` callback may be
defined for filtering completion results.
+ An optional `initialization_options` or
+ `initialization_options_callback` may be defined to
+ pass initialization options to the LSP.
+
`project_root_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
@@ -2372,6 +2376,17 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
setting can make it easier to guess the linter name
by offering a few alternatives.
+ `initialization_options` A |Dictionary| of initialization options for LSPs.
+ This will be fed (as JSON) to the LSP in the
+ initialize command.
+
+ `initialization_options_callback`
+ A |String| or |Funcref| for a callback function
+ accepting a buffer number. A |Dictionary| should be
+ returned for initialization options to pass the LSP.
+ This can be used in place of `initialization_options`
+ when more complicated processing is needed.
+
Only one of `command`, `command_callback`, or `command_chain` should be
specified. `command_callback` is generally recommended when a command string
needs to be generated dynamically, or any global options are used.