Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-26 04:53:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

internal: explain the motivation behind early configuration

Browse source
This commit is contained in:
Aleksey Kladov 2021-05-27 11:16:14 +03:00
parent 7d1653dcdc
commit cabb679cbb
1 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/dev/lsp-extensions.md
View file

@ -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`