feat: Colorize `cargo check` diagnostics in VSCode via text decorations #13848

ian-h-chamberlain · 2022-12-25T19:13:42Z

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 (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 future

I also updated the default cargo check command 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)?

bors · 2022-12-27T20:51:54Z

☔ The latest upstream changes (presumably #13841) made this pull request unmergeable. Please resolve the merge conflicts.

Veykril · 2022-12-30T21:33:58Z

I can test this on windows later

Veykril · 2023-01-02T12:28:42Z

crates/flycheck/src/lib.rs

-                    .arg(self.root.join("Cargo.toml").as_os_str());
+                cmd.args([
+                    "--workspace",
+                    "--message-format=json-diagnostic-rendered-ansi",


This should be gated behind a config disabled by default, otherwise this may break clients that don't handle color codes.

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 ?

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

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?

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)

editors/code/src/client.ts

bors · 2023-01-03T09:57:25Z

☔ The latest upstream changes (presumably #13853) made this pull request unmergeable. Please resolve the merge conflicts.

Veykril · 2023-01-09T14:10:22Z

lgtm if you could touch up the lsp-extension.md!
@bors delegate+

bors · 2023-01-09T14:10:28Z

✌️ @ian-h-chamberlain can now approve this pull request

bors · 2023-01-09T16:23:43Z

☔ 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.

ian-h-chamberlain · 2023-01-09T17:07:29Z

@bors r+

bors · 2023-01-09T17:07:30Z

📌 Commit 283dfc4 has been approved by ian-h-chamberlain

It is now in the queue for this repository.

bors · 2023-01-09T17:07:37Z

⌛ Testing commit 283dfc4 with merge 368e0bb...

bors · 2023-01-09T17:24:17Z

☀️ Test successful - checks-actions
Approved by: ian-h-chamberlain
Pushing 368e0bb to master...

nemethf · 2023-01-09T17:32:24Z

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

Veykril · 2023-01-09T20:11:51Z

The coloring is just passed through from cargo, the server doesn't generate the coloring itself. The clients are free to re-map the color codes as other colors as they like, but that's not something that rust-analyzer would be interested in doing.

Veykril · 2023-01-09T20:12:04Z

Hyperlinks might be a nice addition

jplatte · 2023-01-10T08:10:07Z

Just upgraded to the latest nightly and it works great, thanks! ❤️

nemethf · 2023-01-10T20:25:39Z

The coloring is just passed through from cargo, the server doesn't generate the coloring itself.

Thanks. This wasn't clear for me from the original message.

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Dec 25, 2022

ian-h-chamberlain force-pushed the feature/color-compiler-diagnostics branch from e69c7f1 to 687a3bb Compare December 28, 2022 14:42

Veykril reviewed Jan 2, 2023

View reviewed changes

ian-h-chamberlain force-pushed the feature/color-compiler-diagnostics branch from 687a3bb to e5a1dac Compare January 4, 2023 17:05

Veykril added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 9, 2023

ian-h-chamberlain and others added 6 commits January 9, 2023 11:46

Default to use colored ANSI diagnostics

4020790

Update docs to include note about ANSI diagnostics

c3e4bc3

Strip colors before matching preview diagnostics

738ce83

Use experimental capability to enable color codes

65cf7ab

Add docs for colorDiagnosticOutput capability

283dfc4

ian-h-chamberlain force-pushed the feature/color-compiler-diagnostics branch from c03d23e to 283dfc4 Compare January 9, 2023 16:50

ian-h-chamberlain mentioned this pull request Jan 9, 2023

Announcements: Client Changes #4604

Open

bors merged commit 368e0bb into rust-lang:master Jan 9, 2023

lnicola changed the title ~~Colorize cargo check diagnostics in VSCode via text decorations~~ feat: Colorize cargo check diagnostics in VSCode via text decorations Jan 9, 2023

ian-h-chamberlain deleted the feature/color-compiler-diagnostics branch January 9, 2023 20:22

lnicola mentioned this pull request Feb 18, 2023

I'm only getting the first line of each error in my inline popups #12454

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Colorize `cargo check` diagnostics in VSCode via text decorations #13848

feat: Colorize `cargo check` diagnostics in VSCode via text decorations #13848

ian-h-chamberlain commented Dec 25, 2022 •

edited

bors commented Dec 27, 2022

Veykril commented Dec 30, 2022

Veykril Jan 2, 2023

ian-h-chamberlain Jan 3, 2023 •

edited

Veykril Jan 3, 2023 •

edited

ian-h-chamberlain Jan 4, 2023

Veykril Jan 9, 2023 •

edited

bors commented Jan 3, 2023

Veykril commented Jan 9, 2023

bors commented Jan 9, 2023

bors commented Jan 9, 2023

ian-h-chamberlain commented Jan 9, 2023

bors commented Jan 9, 2023

bors commented Jan 9, 2023

bors commented Jan 9, 2023

nemethf commented Jan 9, 2023

Veykril commented Jan 9, 2023

Veykril commented Jan 9, 2023

jplatte commented Jan 10, 2023

nemethf commented Jan 10, 2023

feat: Colorize cargo check diagnostics in VSCode via text decorations #13848

feat: Colorize cargo check diagnostics in VSCode via text decorations #13848

Conversation

ian-h-chamberlain commented Dec 25, 2022 • edited

bors commented Dec 27, 2022

Veykril commented Dec 30, 2022

Veykril Jan 2, 2023

Choose a reason for hiding this comment

ian-h-chamberlain Jan 3, 2023 • edited

Choose a reason for hiding this comment

Veykril Jan 3, 2023 • edited

Choose a reason for hiding this comment

ian-h-chamberlain Jan 4, 2023

Choose a reason for hiding this comment

Veykril Jan 9, 2023 • edited

Choose a reason for hiding this comment

bors commented Jan 3, 2023

Veykril commented Jan 9, 2023

bors commented Jan 9, 2023

bors commented Jan 9, 2023

ian-h-chamberlain commented Jan 9, 2023

bors commented Jan 9, 2023

bors commented Jan 9, 2023

bors commented Jan 9, 2023

nemethf commented Jan 9, 2023

Veykril commented Jan 9, 2023

Veykril commented Jan 9, 2023

jplatte commented Jan 10, 2023

nemethf commented Jan 10, 2023

feat: Colorize `cargo check` diagnostics in VSCode via text decorations #13848

feat: Colorize `cargo check` diagnostics in VSCode via text decorations #13848

ian-h-chamberlain commented Dec 25, 2022 •

edited

ian-h-chamberlain Jan 3, 2023 •

edited

Veykril Jan 3, 2023 •

edited

Veykril Jan 9, 2023 •

edited