itsscb/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-10-01 11:31:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge #9021

Browse Source 
9021: internal: explain the motivation behind early configuration r=matklad a=matklad

bors r+
🤖

Co-authored-by: Aleksey Kladov <aleksey.kladov@gmail.com>
This commit is contained in:
bors[bot] 2021-05-27 08:17:10 +00:00 committed by GitHub
commit a9a978e0bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
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 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: 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` * Not sending `initializationOptions`
* Send `"initializationOptions": null` * Sending `"initializationOptions": null`
* Send `"initializationOptions": {}` * Sending `"initializationOptions": {}`
## Snippet `TextEdit` ## Snippet `TextEdit`