Empowering everyone to build reliable and efficient software.
Go to file
Aleksey Kladov 6fb4871f31 Add note
2019-11-26 19:30:57 +03:00
.cargo Alternative quite tests alias 2019-11-20 22:22:32 +03:00
.github Run CI on trying as well 2019-11-19 11:24:18 +03:00
.vscode revert change to "check" since "build" is intentional 2019-03-10 14:57:30 +01:00
crates Add note 2019-11-26 19:30:57 +03:00
docs Merge #2343 2019-11-24 08:32:07 +00:00
editors Add rust-analyzer-expand-macro function for Emacs 2019-11-20 20:45:25 +01:00
xtask hir_def is fully doc'ed! 2019-11-24 21:00:50 +03:00
.gitattributes Set text to autodetect and use LF 2019-11-14 19:44:37 -05:00
.gitignore Updated the gitignore 2019-04-05 22:06:15 +01:00
bors.toml fix bors integration 2019-11-18 12:59:09 +03:00
Cargo.lock Fix stale crates that snuck in 2019-11-26 08:20:40 -05:00
Cargo.toml Speedup builds for users 2019-11-15 21:18:44 +03: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 add ws 2019-11-20 09:20:53 +03:00
rustfmt.toml Remove forcing \n via rustfmt 2019-11-02 22:19:59 +03:00

Rust Analyzer

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 in the compiler-team repository:

https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/rls-2.0

Work on the Rust Analyzer is sponsored by

Ferrous Systems

Language Server Quick Start

Rust Analyzer is a work-in-progress, so you'll have to build it from source, and 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 language server itself
  • latest stable npm and VS Code for VS Code extension

To quickly install rust-analyzer with 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 `ra_lsp_server`.
$ cargo xtask install --server

For non-standard setup of VS Code and other editors, see ./docs/user.

Documentation

If you want to contribute to rust-analyzer or 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.