rust-analyzer is an experimental modular compiler frontend for the Rust
language. It is a part of a larger rls-2.0 effort to create excellent IDE
support for Rust. If you want to get involved, check the rls-2.0 working group:
https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0
Work on rust-analyzer is sponsored by
Language Server Quick Start
rust-analyzer is a work-in-progress, so you might encounter critical bugs. That
said, it is complete enough to provide a useful IDE experience and some people
use it as a daily driver.
To build rust-analyzer, you need:
- latest stable Rust for the language server itself
- latest stable npm and VS Code for VS Code extension
To quickly install the rust-analyzer language server and VS Code extension with
standard setup (code and cargo in $PATH, etc), use this:
# clone the repo
$ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
# install both the language server and VS Code extension
$ cargo xtask install
# alternatively, install only the server. Binary name is `rust-analyzer`.
$ cargo xtask install --server
For non-standard setup of VS Code and other editors, or if the language server
cannot start, see ./docs/user.
Documentation
If you want to contribute to rust-analyzer or are just curious about how
things work under the hood, check the ./docs/dev folder.
If you want to use rust-analyzer's language server with your editor of
choice, check ./docs/user folder. It also contains some tips & tricks to help
you be more productive when using rust-analyzer.
Getting in touch
We are on the rust-lang Zulip!
https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
Quick Links
- API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide/
- Website: https://rust-analyzer.github.io/
License
Rust analyzer is primarily distributed under the terms of both the MIT
license and the Apache License (Version 2.0).
See LICENSE-APACHE and LICENSE-MIT for details.