Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2025-01-13 05:38:46 +00:00
Code Issues Projects Releases Packages Wiki Activity

tweak readme

Browse source
This commit is contained in:
Aleksey Kladov 2019-01-13 13:51:26 +03:00
parent 8e554ea5fa
commit afe5f26239
1 changed files with 32 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
README.md
View file

@ -2,15 +2,13 @@
[![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer) [![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer)
Rust Analyzer is an **experimental** modular compiler frontend for the Rust Analyzer is an **experimental** modular compiler frontend for the Rust
Rust language, which aims to lay a foundation for excellent IDE language, which aims to lay a foundation for excellent IDE support.
support.
It doesn't implement much of compiler functionality yet, but the It doesn't implement much of compiler functionality yet, but the white-space
white-space preserving Rust parser works, and there are significant preserving Rust parser works, and there are significant chunks of overall
chunks of overall architecture (indexing, on-demand & lazy architecture (indexing, on-demand & lazy computation, snapshotable world view)
computation, snapshotable world view) in place. Some basic IDE in place. Some basic IDE functionality is provided via a language server.
functionality is provided via a language server.
Work on the Rust Analyzer is sponsored by Work on the Rust Analyzer is sponsored by
@ -30,53 +28,45 @@ $ cargo run --package ra_cli parse < crates/ra_syntax/src/lib.rs
# show symbols of a Rust file # show symbols of a Rust file
$ cargo run --package ra_cli symbols < crates/ra_syntax/src/lib.rs $ cargo run --package ra_cli symbols < crates/ra_syntax/src/lib.rs
# install the language server
$ cargo install --path crates/ra_lsp_server
``` ```
To try out the language server, see [these See [these instructions](./editors/README.md) for VS Code setup and the list of
instructions](./editors/README.md). Please note that the server is not features (some of which are VS Code specific).
ready for general use yet. If you are looking for a Rust IDE that
works, use [IntelliJ
Rust](https://github.com/intellij-rust/intellij-rust) or
[RLS](https://github.com/rust-lang-nursery/rls). That being said, the
basic stuff works, and rust analyzer is developed in the rust analyzer
powered editor.
## Current Status and Plans ## Current Status and Plans
Rust analyzer aims to fill the same niche as the official [Rust Rust analyzer aims to fill the same niche as the official [Rust Language
Language Server](https://github.com/rust-lang-nursery/rls), but uses a Server](https://github.com/rust-lang-nursery/rls), but uses a significantly
significantly different architecture. More details can be found [in different architecture. More details can be found [in this
this
thread](https://internals.rust-lang.org/t/2019-strategy-for-rustc-and-the-rls/8361), thread](https://internals.rust-lang.org/t/2019-strategy-for-rustc-and-the-rls/8361),
but the core issue is that RLS works in the "wait until user stops but the core issue is that RLS works in the "wait until user stops typing, run
typing, run the build process, save the results of the analysis" mode, the build process, save the results of the analysis" mode, which arguably is the
which arguably is the wrong foundation for IDE. wrong foundation for IDE.
Rust Analyzer is a hobby project at the moment, there's exactly zero Rust Analyzer is an experimental project at the moment, there's exactly zero
guarantees that it becomes production-ready one day. guarantees that it becomes production-ready one day.
The near/mid term plan is to work independently of the main rustc The near/mid term plan is to work independently of the main rustc compiler and
compiler and implement at least simplistic versions of name implement at least simplistic versions of name resolution, macro expansion and
resolution, macro expansion and type inference. The purpose is two type inference. The purpose is two fold:
fold:
* to quickly bootstrap usable and useful language server: solution * to quickly bootstrap usable and useful language server: solution that covers
that covers 80% of Rust code will be useful for IDEs, and will be 80% of Rust code will be useful for IDEs, and will be vastly simpler than 100%
vastly simpler than 100% solution. solution.
* to understand how the consumer-side of compiler API should look like * to understand how the consumer-side of compiler API should look like
(especially it's on-demand aspects). If you have (especially it's on-demand aspects). If you have `get_expression_type`
`get_expression_type` function, you can write a ton of purely-IDE function, you can write a ton of purely-IDE features on top of it, even if the
features on top of it, even if the function is only partially function is only partially correct. Pluging in the precise function afterwards
correct. Plugin in the precise function afterwards should just make should just make IDE features more reliable.
IDE features more reliable.
The long term plan is to merge with the mainline rustc compiler, The long term plan is to merge with the mainline rustc compiler, probably around
probably around the HIR boundary? That is, use rust analyzer for the HIR boundary? That is, use rust analyzer for parsing, macro expansion and
parsing, macro expansion and related bits of name resolution, but related bits of name resolution, but leave the rest (including type inference
leave the rest (including type inference and trait selection) to the and trait selection) to the existing rustc.
existing rustc.
## Getting in touch ## Getting in touch