From cabb679cbb7d94fba5bdbcfdb0dc66e9fdd47415 Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Thu, 27 May 2021 11:16:14 +0300 Subject: internal: explain the motivation behind early configuration --- docs/dev/lsp-extensions.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) (limited to 'docs/dev/lsp-extensions.md') diff --git a/docs/dev/lsp-extensions.md b/docs/dev/lsp-extensions.md index fbe2ce1c9..11a3dd04e 100644 --- a/docs/dev/lsp-extensions.md +++ b/docs/dev/lsp-extensions.md @@ -25,15 +25,21 @@ rust-analyzer supports clangd's extension for opting into UTF-8 as the coordinat https://clangd.llvm.org/extensions.html#utf-8-offsets -## `initializationOptions` +## Configuration in `initializationOptions` + +**Issue:** https://github.com/microsoft/language-server-protocol/issues/567 + +The `initializationOptions` filed of the `InitializeParams` of the initialization request should contain `"rust-analyzer"` section of the configuration. + +`rust-analyzer` normally sends a `"workspace/configuration"` request with `{ "items": ["rust-analyzer"] }` payload. +However, the server can't do this during initialization. +At the same time some essential configuration parameters are needed early on, before servicing requests. +For this reason, we ask that `initializationOptions` contains the configuration, as if the server did make a `"workspace/configuration"` request. -For `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. If a language client does not know about `rust-analyzer`'s configuration options it can get sensible defaults by doing any of the following: * Not sending `initializationOptions` - * Send `"initializationOptions": null` - * Send `"initializationOptions": {}` + * Sending `"initializationOptions": null` + * Sending `"initializationOptions": {}` ## Snippet `TextEdit` -- cgit v1.2.3