feat: Colorize cargo check diagnostics in VSCode via text decorations - #13848
#13848feat: Colorize cargo check diagnostics in VSCode via text decorations#13848bors merged 6 commits intorust-lang:masterrust-lang/rust-analyzer:masterfrom ian-h-chamberlain:feature/color-compiler-diagnosticsian-h-chamberlain/rust-analyzer:feature/color-compiler-diagnosticsCopy head branch name to clipboard
cargo check diagnostics in VSCode via text decorations#13848Conversation
|
☔ The latest upstream changes (presumably #13841) made this pull request unmergeable. Please resolve the merge conflicts. |
e69c7f1 to
687a3bb
Compare
|
I can test this on windows later |
| .arg(self.root.join("Cargo.toml").as_os_str()); | ||
| cmd.args([ | ||
| "--workspace", | ||
| "--message-format=json-diagnostic-rendered-ansi", |
There was a problem hiding this comment.
This should be gated behind a config disabled by default, otherwise this may break clients that don't handle color codes.
There was a problem hiding this comment.
good point, I had forgotten about how this would impact other clients. I guess it should be called something like checkOnSave_enableColorOutput ?
Edit: also, does it make sense to make it something like an Option<bool> and default to true for VScode using something like https://github.com/rust-lang/rust-analyzer/pull/13699/files#diff-779cb31c0defa0631d570725eb4ca124c0860d6ec07bb5b9deddc2dd34966315R719 ?
There was a problem hiding this comment.
Hmm, actually, thinking about again, a config might make sense for the client, but not the server. We might want to make this an experimental client capability instead (and expose an extra config for the vscode client only)
The server side stuff for these capabilities can be found here https://github.com/Veykril/rust-analyzer/blob/17cc78f169538538a10e11251562e0fde8ed4958/crates/rust-analyzer/src/config.rs#L990-L1006, the client side is here https://github.com/Veykril/rust-analyzer/blob/17cc78f169538538a10e11251562e0fde8ed4958/editors/code/src/client.ts#L295-L321
There was a problem hiding this comment.
I've just pushed a change as suggested. Should this also be exposed as a config in package.json? Do I need to update #4604 and/or lsp-extensions.md to document this as a VSCode-specific extension?
There was a problem hiding this comment.
Would be good to add that to the markdown file as a small entry yes, most likely VSCode is the only client benefiting from this, but its always good to keep that list in sync. If you change that file you'll also have to update the hash (a test will fail otherwise, the test will tell the expected hash)
|
☔ The latest upstream changes (presumably #13853) made this pull request unmergeable. Please resolve the merge conflicts. |
687a3bb to
e5a1dac
Compare
|
lgtm if you could touch up the |
|
✌️ @ian-h-chamberlain can now approve this pull request |
|
☔ The latest upstream changes (presumably #13890) made this pull request unmergeable. Please resolve the merge conflicts. |
Use ANSI control characters to display text decorations matching the VScode terminal theme, and strip them out when providing text content for rustc diagnostics. This adds the small `anser` library to parse the control codes, and it also supports HTML output so it should be fairly easy to switch to a rendered HTML/webview implementation if desired.
c03d23e to
283dfc4
Compare
|
@bors r+ |
|
☀️ Test successful - checks-actions |
|
I've just read about this feature in the Announcements. On the one hand, I think this is great. But I also wonder if it would be a bit better to let the clients decide how they want to color errors, warnings, etc. For example, would it be possible to send a html-like with symbolic formatting instead? I think coupling this feature with the VScode terminal theme is not very portable. Independently from the above, will the ansi-encoded text contain just color information or for example hyperlinks as well? Thanks |
cargo check diagnostics in VSCode via text decorationscargo check diagnostics in VSCode via text decorations
|
The coloring is just passed through from |
|
Hyperlinks might be a nice addition |
|
Just upgraded to the latest nightly and it works great, thanks! ❤️ |
Thanks. This wasn't clear for me from the original message. |
## Context This builds on the original **Click for full diagnostic** feature implemented in [astral-sh/ruff#26269](astral-sh/ruff#26269) and [#462](#462). The colored rendering follows the approach established by [rust-lang/rust-analyzer#13848](rust-lang/rust-analyzer#13848). ## Summary - advertise support for colored full diagnostic output - strip ANSI sequences from the virtual document and recreate their styles with VS Code decorations - support named terminal colors, 256-color palette entries, truecolor, and text decorations ## Companion PRs - [astral-sh/ruff#26384](astral-sh/ruff#26384) - [astral-sh/ty#3858](astral-sh/ty#3858) ## Test plan https://github.com/user-attachments/assets/36638263-fe48-4ba7-8abe-95db353f1257
## Context This builds on the original **Click for full diagnostic** feature implemented in [astral-sh/ruff#26269](astral-sh/ruff#26269) and [astral-sh/ty-vscode#462](astral-sh/ty-vscode#462). The colored rendering follows the approach established by [rust-lang/rust-analyzer#13848](rust-lang/rust-analyzer#13848). ## Summary Explain that `fullDiagnosticOutput` can include ANSI colour codes and clients are expected to be able to handle this ## Companion PRs - [astral-sh/ruff#26384](astral-sh/ruff#26384) - [astral-sh/ty-vscode#463](astral-sh/ty-vscode#463)
## Context This builds on the original **Click for full diagnostic** feature implemented in [#26269](#26269) and [astral-sh/ty-vscode#462](astral-sh/ty-vscode#462). The colored rendering follows the approach established by [rust-lang/rust-analyzer#13848](rust-lang/rust-analyzer#13848). ## Summary - render full ty diagnostics with ANSI color and styling when the client opts in - negotiate color support separately from `fullDiagnosticOutput` for rollout compatibility - disable terminal hyperlinks in LSP output and cover the behavior under forced hyperlink support ## Companion PRs - [astral-sh/ty-vscode#463](astral-sh/ty-vscode#463) - [astral-sh/ty#3858](astral-sh/ty#3858) ## Test plan https://github.com/user-attachments/assets/dc7e7538-ae2b-4870-9e9b-f59943ee804a
Fixes #13648
Use ANSI control characters to display text decorations matching the VScode terminal theme, and strip them out when providing text content for rustc diagnostics.
This adds the small
anserlibrary (MIT license, no dependencies) to parse the control codes, and it also supports HTML output so it should be fairly easy to switch to a rendered HTML/webview implementation in the futureI also updated the default
cargo checkcommand to use the rendered ANSI diagnostics, although I'm not sure if it makes sense to put this kind of thing behind a feature flag, or whether it might have any issues on Windows (as I believe ANSI codes are not used for colorization there)?