Go to file
Sergey Parilin 36cb58f76d structure moved to ra_ide_api
ra_ide_api_light removed completely
2019-03-25 11:41:21 +03:00
.cargo Add `cargo jinstall-lsp` as a shorthand to include jemalloc support 2019-01-29 17:02:06 +00:00
.vscode revert change to "check" since "build" is intentional 2019-03-10 14:57:30 +01:00
crates structure moved to ra_ide_api 2019-03-25 11:41:21 +03:00
docs structure moved to ra_ide_api 2019-03-25 11:41:21 +03:00
editors Don't execute cargo watch when popup is dismissed 2019-03-22 09:38:48 +09:00
.gitignore Add .vscode/settings.json to .gitignore 2019-01-19 15:37:25 +03:00
.travis.yml fix build 2019-03-25 10:48:24 +03:00
Cargo.lock structure moved to ra_ide_api 2019-03-25 11:41:21 +03:00
Cargo.toml update salsa 2019-01-15 15:06:45 +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 link docs from dev docs, not from the main readme 2019-03-25 10:27:43 +03:00
bors.toml don't gate on appveyor 2018-10-09 19:06:05 +03:00
rustfmt.toml enable "small heuristics" 2019-02-08 14:49:26 +03:00

README.md

Rust Analyzer

Build Status

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/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 (code should be in path)

For setup for other editors, see ./docs/user.

# 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 install-code

# alternatively, install only the server. Binary name is `ra_lsp_server`.
$ cargo install-lsp

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.