summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorw0rp <w0rp@users.noreply.github.com>2018-10-31 16:24:11 +0000
committerGitHub <noreply@github.com>2018-10-31 16:24:11 +0000
commit5f206d900e3ae09cafc36f8038000fb13dbe3bab (patch)
tree97a2f2a8a3a20f7d9c0ea6aaa7c295fdcf1cd9f3 /doc
parent6212c22b5a6312db7e06f802197a7cb021b7e588 (diff)
parent2ac9e2a29e3c570e8aac5d8f5404921e8d816006 (diff)
downloadale-5f206d900e3ae09cafc36f8038000fb13dbe3bab.zip
Merge pull request #2035 from jparise/lsp_config_callback
Add a `lsp_config_callback` linter option
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-development.txt1
-rw-r--r--doc/ale.txt13
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/ale-development.txt b/doc/ale-development.txt
index ac72d615..1e168130 100644
--- a/doc/ale-development.txt
+++ b/doc/ale-development.txt
@@ -306,6 +306,7 @@ given the above setup are as follows.
`AssertLinterNotExecuted` - Check that linters will not be executed.
`AssertLSPLanguage language` - Check the language given to an LSP server.
`AssertLSPOptions options_dict` - Check the options given to an LSP server.
+`AssertLSPConfig config_dict` - Check the config given to an LSP server.
`AssertLSPProject project_root` - Check the root given to an LSP server.
`AssertLSPAddress address` - Check the address to an LSP server.
diff --git a/doc/ale.txt b/doc/ale.txt
index 6340091c..59b9f352 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2685,6 +2685,9 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
`initialization_options_callback` may be defined to
pass initialization options to the LSP.
+ An optional `lsp_config` or `lsp_config_callback` may
+ be defined to pass configuration settings to the LSP.
+
`address_callback` A |String| or |Funcref| for a callback function
accepting a buffer number. A |String| should be
returned with an address to connect to.
@@ -2745,6 +2748,16 @@ ale#linter#Define(filetype, linter) *ale#linter#Define()*
This can be used in place of `initialization_options`
when more complicated processing is needed.
+ `lsp_config` A |Dictionary| of configuration settings for LSPs.
+ This will be fed (as JSON) to the LSP in the
+ workspace/didChangeConfiguration command.
+
+ `lsp_config_callback` A |String| or |Funcref| for a callback function
+ accepting a buffer number. A |Dictionary| should be
+ returned for configuration settings to pass the LSP.
+ This can be used in place of `lsp_config` 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.