Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2025-01-13 13:48:50 +00:00
Code Issues Projects Releases Packages Wiki Activity

Remove confusion around serverStatusNotification

Browse source
This commit is contained in:
Aleksey Kladov 2021-04-19 18:10:33 +03:00
parent 2cdc83af93
commit dcb759b727
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -433,11 +433,13 @@ interface ServerStatusParams {
/// `ok` means that the server is completely functional. /// `ok` means that the server is completely functional.
/// ///
/// `warning` means that the server is partially functional. /// `warning` means that the server is partially functional.
/// It can server requests, but some results might be wrong due to, /// It can answer correctly to most requests, but some results
/// for example, some missing dependencies. /// might be wrong due to, for example, some missing dependencies.
/// ///
/// `error` means that the server is not functional. For example, /// `error` means that the server is not functional. For example,
/// there's a fatal build configuration problem. /// there's a fatal build configuration problem. The server might
/// still give correct answers to simple requests, but most results
/// will be incomplete or wrong.
health: "ok" | "warning" | "error", health: "ok" | "warning" | "error",
/// Is there any pending background work which might change the status? /// Is there any pending background work which might change the status?
/// For example, are dependencies being downloaded? /// For example, are dependencies being downloaded?
@ -451,6 +453,9 @@ This notification is sent from server to client.
The client can use it to display *persistent* status to the user (in modline). The client can use it to display *persistent* status to the user (in modline).
It is similar to the `showMessage`, but is intended for stares rather than point-in-time events. It is similar to the `showMessage`, but is intended for stares rather than point-in-time events.
Note that this functionality is intended primarily to inform the end user about the state of the server.
In particular, it's valid for the client to completely ignore this extension.
Clients are discouraged from but are allowed to use the `health` status to decide if it's worth sending a request to the server.
## Syntax Tree ## Syntax Tree