Empowering everyone to build reliable and efficient software.
Go to file
bors[bot] 2a8dd492a8
Merge #2758
2758: Add "code-oss" Visual Studio Code binary name r=matklad a=leo-lb

When Visual Studio Code is manually compiled from the upstream
source tree the binary is named "code-oss".

Co-authored-by: leo-lb <lle-bout@zaclys.net>
2020-01-07 16:18:07 +00:00
.cargo Alternative quite tests alias 2019-11-20 22:22:32 +03:00
.github Share cache cleaning logic between OSes 2020-01-07 16:45:57 +01:00
.vscode Add rollup 2019-12-30 11:20:45 +01:00
crates Merge pull request #2756 from matklad/retasks 2020-01-07 17:17:31 +01:00
docs add note in vscode instructions for vim plugin users 2020-01-05 07:37:58 -08:00
editors Merge #2714 2020-01-06 11:39:41 +00:00
xtask Merge #2758 2020-01-07 16:18:07 +00: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 Add missing comma and use double-quotes to bors.toml 2020-01-05 19:58:54 +01:00
Cargo.lock ⬆️ crates 2020-01-07 16:45:57 +01:00
Cargo.toml ⬆️ rowan 2019-12-04 17:15:55 +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 link website 2019-12-16 18:41:03 +01: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, or if the language server cannot start, 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.