2018-09-16 11:29:34 +00:00
|
|
|
# Rust Analyzer
|
2018-01-10 18:58:38 +00:00
|
|
|
|
2018-10-09 13:18:22 +00:00
|
|
|
[](https://travis-ci.org/rust-analyzer/rust-analyzer)
|
2018-01-28 00:15:30 +00:00
|
|
|
|
2019-01-13 10:51:26 +00:00
|
|
|
Rust Analyzer is an **experimental** modular compiler frontend for the Rust
|
2019-02-12 14:55:02 +00:00
|
|
|
language. It is a part of a larger rls-2.0 effort to create excellent IDE
|
2019-03-13 18:36:26 +00:00
|
|
|
support for Rust. If you want to get involved, check the rls-2.0 working group
|
|
|
|
|
in the compiler-team repository:
|
2018-01-10 19:49:22 +00:00
|
|
|
|
2019-08-02 14:19:19 +00:00
|
|
|
https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/rls-2.0
|
2018-01-10 18:58:38 +00:00
|
|
|
|
2018-10-22 12:59:01 +00:00
|
|
|
Work on the Rust Analyzer is sponsored by
|
|
|
|
|
|
2019-05-21 14:10:08 +00:00
|
|
|
[<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
|
2019-05-21 10:27:07 +00:00
|
|
|
- [Mozilla](https://www.mozilla.org/en-US/)
|
2018-10-22 12:59:01 +00:00
|
|
|
|
2019-03-20 07:00:54 +00:00
|
|
|
## Language Server Quick Start
|
2018-08-24 15:14:21 +00:00
|
|
|
|
2019-03-20 07:00:54 +00:00
|
|
|
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.
|
2018-09-16 12:36:09 +00:00
|
|
|
|
2019-03-20 07:00:54 +00:00
|
|
|
To build rust-analyzer, you need:
|
2018-08-24 15:14:21 +00:00
|
|
|
|
2019-03-20 07:00:54 +00:00
|
|
|
* latest stable rust for language server itself
|
2019-09-18 11:24:20 +00:00
|
|
|
* latest stable npm and VS Code for VS Code extension
|
2018-08-24 15:14:21 +00:00
|
|
|
|
2019-09-18 11:24:20 +00:00
|
|
|
To quickly install rust-analyzer with VS Code extension with standard setup
|
|
|
|
|
(`code` and `cargo` in `$PATH`, etc), use this:
|
2018-08-24 15:14:21 +00:00
|
|
|
|
2019-01-13 10:51:26 +00:00
|
|
|
```
|
2019-03-20 07:00:54 +00:00
|
|
|
# clone the repo
|
|
|
|
|
$ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
|
2018-09-08 16:23:52 +00:00
|
|
|
|
2019-03-20 07:00:54 +00:00
|
|
|
# install both the language server and VS Code extension
|
2019-07-27 11:35:18 +00:00
|
|
|
$ cargo install-ra
|
2019-03-20 07:00:54 +00:00
|
|
|
|
|
|
|
|
# alternatively, install only the server. Binary name is `ra_lsp_server`.
|
2019-07-27 11:35:18 +00:00
|
|
|
$ cargo install-ra --server
|
2019-03-20 07:00:54 +00:00
|
|
|
```
|
2019-09-18 11:24:20 +00:00
|
|
|
|
|
|
|
|
For non-standard setup of VS Code and other editors, see [./docs/user](./docs/user).
|
|
|
|
|
|
2019-03-20 07:00:54 +00:00
|
|
|
## Documentation
|
2018-08-24 15:14:21 +00:00
|
|
|
|
2019-03-20 07:00:54 +00:00
|
|
|
If you want to **contribute** to rust-analyzer or just curious about how things work
|
2019-03-20 09:21:55 +00:00
|
|
|
under the hood, check the [./docs/dev](./docs/dev) folder.
|
2019-01-18 10:59:08 +00:00
|
|
|
|
2019-03-20 07:00:54 +00:00
|
|
|
If you want to **use** rust-analyzer's language server with your editor of
|
2019-03-20 09:24:12 +00:00
|
|
|
choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help
|
2019-03-20 07:00:54 +00:00
|
|
|
you be more productive when using rust-analyzer.
|
2019-01-18 10:59:08 +00:00
|
|
|
|
2019-02-12 14:55:02 +00:00
|
|
|
## Getting in touch
|
2018-09-16 11:29:34 +00:00
|
|
|
|
2019-02-12 14:55:02 +00:00
|
|
|
We are on the rust-lang Zulip!
|
2018-09-16 11:29:34 +00:00
|
|
|
|
2019-02-12 14:55:02 +00:00
|
|
|
https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
|
2018-10-09 18:30:41 +00:00
|
|
|
|
2019-03-26 12:38:46 +00:00
|
|
|
## Quick Links
|
|
|
|
|
|
|
|
|
|
* Work List: https://paper.dropbox.com/doc/RLS-2.0-work-list--AZ3BgHKKCtqszbsi3gi6sjchAQ-42vbnxzuKq2lKwW0mkn8Y
|
2019-09-02 12:02:45 +00:00
|
|
|
* API docs: https://rust-analyzer.github.io/rust-analyzer/api-docs/ra_ide_api/
|
2019-03-26 12:38:46 +00:00
|
|
|
* CI: https://travis-ci.org/rust-analyzer/rust-analyzer
|
|
|
|
|
|
2018-01-10 19:47:04 +00:00
|
|
|
## License
|
|
|
|
|
|
2018-09-16 12:36:09 +00:00
|
|
|
Rust analyzer is primarily distributed under the terms of both the MIT
|
|
|
|
|
license and the Apache License (Version 2.0).
|
2018-01-10 19:47:04 +00:00
|
|
|
|
|
|
|
|
See LICENSE-APACHE and LICENSE-MIT for details.
|
