rust-lang / rust-lang/rust-analyzer
Make it clear how to debug
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
Nowhere in the documentation of this plugin that I could find did it explain how you can debug in VSCode. That's an awful oversight, because even if this plugin does ship the debug feature by itself, this is where most people will end up when they try to use Rust in VSCode. I just spent 15 minutes on Google trying to piece together which extensions were needed (despite having installed Rust on another computer a few months back), what I needed in my launch.json, my cargo.toml... And of course plenty of people give plenty of different solutions, because it's the internet.
Please update the readme of this plugin to provide a link to a md document explaining what is the recommended setup to debug Rust in VSCode. Having such a high barrier to entry does this beautiful language absolutely no favors.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the plugin README and its documentation structure. Review the recommended Rust debugging setup for VSCode, including required extensions, launch.json, and Cargo.toml, then add a Markdown guide and link it from the README; done means newcomers can find one authoritative setup path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust, vscode
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100