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

Add docs for colorDiagnosticOutput capability

Browse source
This commit is contained in:
Ian Chamberlain 2023-01-09 11:44:38 -05:00
parent 65cf7abbe2
commit 283dfc45dd
No known key found for this signature in database
GPG key ID: BD7B25D58170E124
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -792,3 +792,29 @@ export interface ClientCommandOptions {
commands: string[];
}
```
## Colored Diagnostic Output
**Experimental Client Capability:** `{ "colorDiagnosticOutput": boolean }`
If this capability is set, the "full compiler diagnostics" provided by `checkOnSave`
will include ANSI color and style codes to render the diagnostic in a similar manner
as `cargo`. This is translated into `--message-format=json-diagnostic-rendered-ansi`
when flycheck is run, instead of the default `--message-format=json`.
The full compiler rendered diagnostics are included in the server response
regardless of this capability:
```typescript
// https://microsoft.github.io/language-server-protocol/specifications/specification-current#diagnostic
export interface Diagnostic {
...
data?: {
/**
* The human-readable compiler output as it would be printed to a terminal.
* Includes ANSI color and style codes if the client has set the experimental
* `colorDiagnosticOutput` capability.
*/
rendered?: string;
};
}