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