about summary refs log tree commit diff
path: root/docs/dev
diff options
context:
space:
mode:
authorAleksey Kladov <aleksey.kladov@gmail.com>2020-06-01 17:42:46 +0200
committerAleksey Kladov <aleksey.kladov@gmail.com>2020-06-01 17:42:46 +0200
commitaaa288126bd27f7b4d3d87827d1b8d3adf01d584 (patch)
tree7ae4a168c4ef709623c0464d82ffce09b2aae39f /docs/dev
parentd23814bf3dd3429b35690ba0f57e0b0bb0913d7d (diff)
downloadrust-aaa288126bd27f7b4d3d87827d1b8d3adf01d584.tar.gz
rust-aaa288126bd27f7b4d3d87827d1b8d3adf01d584.zip
Document initilizationOptions used by rust-analyzer
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/lsp-extensions.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/dev/lsp-extensions.md b/docs/dev/lsp-extensions.md
index dbc95be387c..6b2d385fc66 100644
--- a/docs/dev/lsp-extensions.md
+++ b/docs/dev/lsp-extensions.md
@@ -7,6 +7,14 @@ All capabilities are enabled via `experimental` field of `ClientCapabilities` or
 Requests which we hope to upstream live under `experimental/` namespace.
 Requests, which are likely to always remain specific to `rust-analyzer` are under `rust-analyzer/` namespace.
 
+## `initializationOptions`
+
+As `initializationOptions`, `rust-analyzer` expects `"rust-analyzer"` section of the configuration.
+That is, `rust-analyzer` usually sends `"workspace/configuration"` request with `{ "items": ["rust-analyzer"] }` payload.
+`initializationOptions` should contain the same data that would be in the first item of the result.
+It's OK to not send anything, then all the settings would take their default values.
+However, some settings can not be changed after startup at the moment.
+
 ## Snippet `TextEdit`
 
 **Issue:** https://github.com/microsoft/language-server-protocol/issues/724