Go to file
2020-03-04 18:56:20 +01:00
.cargo Alternative quite tests alias 2019-11-20 22:22:32 +03:00
.github Fix yaml syntax 2020-03-04 18:55:23 +01:00
.vscode Rename the binary to rust-analyzer 2020-02-18 12:33:16 +01:00
crates Minor cleanup 2020-03-04 14:39:51 +01:00
docs rewording and typo fix 2020-02-22 18:07:43 +01:00
editors/code Actually include readme into .vsix 2020-03-03 18:40:27 +01:00
xtask Build server via dist as well 2020-03-04 18:56:20 +01:00
.gitattributes Set text to autodetect and use LF 2019-11-14 19:44:37 -05:00
.gitignore cargo xtask dist 2020-03-04 18:18:20 +01:00
bors.toml Gate CI on windows build 2020-01-26 14:15:57 +01:00
Cargo.lock Update deps 2020-03-04 10:20:03 -05:00
Cargo.toml Extend analysis-stats a bit 2020-02-15 18:04:01 +01:00
LICENSE-APACHE Licenses 2018-01-10 22:47:04 +03:00
LICENSE-MIT Licenses 2018-01-10 22:47:04 +03:00
README.md Rename the binary to rust-analyzer 2020-02-18 12:33:16 +01:00
rustfmt.toml Remove forcing \n via rustfmt 2019-11-02 22:19:59 +03:00

rust-analyzer logo

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

Ferrous Systems

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

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.