rust-lang / rust-lang/rust-analyzer

Add VSCode command to show the `rustc --explain EXXXX` output

Open
#14,280 16 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-diagnostics C-feature
Dominant language
Rust
Stars
16.9k
Forks
2.2k
Avg merge
1d 12h
Merged PRs (30d)
72

Description

Here is a user story example:

  1. I use VSCode.
  2. I have a compilation (analysis) error.
  3. This error has an explanation code (For more information about this error, try `rustc --explain EXXXX`.).
  4. I open the command palette and run the command rust-analyzer: Explain.
  5. It opens a new tab containing the rustc --explain EXXXX output.

There are other considerations to take into account:

  • multiple errors
  • (rather?) add it in code actions
  • how would that reflect in other IDEs/text editors?

If this feature is acceptable (and once the specs would be agreed upon), I could try to contribute by working on it but I must warn that I'm a beginner in Rust, so that would take some time.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue mentions the rust-analyzer command palette, rustc --explain EXXXX, code actions, multiple errors, and behavior across IDEs and text editors, but no files or tests. First resolve the command versus code-action scope and multi-error behavior; done means an agreed implementation opens the requested explanation output for a diagnostic code.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust, vscode
Domain
developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.