595a2f9900
593: Docs for completion r=matklad a=kjeremy The first commit adds documentation support to CompletionItems. The second one I am unsure about. Is that the right way to add docs for functions? If so should I do something similar for other `hir` types and CompletionItems? Co-authored-by: Jeremy Kolb <kjeremy@gmail.com> Co-authored-by: Jeremy A. Kolb <jkolb@ara.com> |
||
|---|---|---|
| .cargo | ||
| .vscode | ||
| crates | ||
| editors | ||
| .gitignore | ||
| .travis.yml | ||
| ARCHITECTURE.md | ||
| bors.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CONTRIBUTING.md | ||
| DEBUGGING.md | ||
| guide.md | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| ROADMAP.md | ||
| rustfmt.toml | ||
Rust Analyzer
Rust Analyzer is an experimental modular compiler frontend for the Rust language, which aims to lay a foundation for excellent IDE support.
It doesn't implement much of compiler functionality yet, but the white-space preserving Rust parser works, and there are significant chunks of overall architecture (indexing, on-demand & lazy computation, snapshotable world view) in place. Some basic IDE functionality is provided via a language server.
Work on the Rust Analyzer is sponsored by
Quick Start
Rust analyzer builds on Rust >= 1.31.0 and uses the 2018 edition.
# run tests
$ cargo test
# show syntax tree of a Rust file
$ cargo run --package ra_cli parse < crates/ra_syntax/src/lib.rs
# show symbols of a Rust file
$ cargo run --package ra_cli symbols < crates/ra_syntax/src/lib.rs
# install the language server
$ cargo install --path crates/ra_lsp_server
See these instructions for VS Code setup and the list of features (some of which are VS Code specific).
Debugging
See these instructions on how to debug the vscode extension and the lsp server.
Current Status and Plans
Rust analyzer aims to fill the same niche as the official Rust Language Server, but uses a significantly different architecture. More details can be found in this thread, but the core issue is that RLS works in the "wait until user stops typing, run the build process, save the results of the analysis" mode, which arguably is the wrong foundation for IDE.
Rust Analyzer is an experimental project at the moment, there's exactly zero guarantees that it becomes production-ready one day.
The near/mid term plan is to work independently of the main rustc compiler and implement at least simplistic versions of name resolution, macro expansion and type inference. The purpose is two fold:
-
to quickly bootstrap usable and useful language server: solution that covers 80% of Rust code will be useful for IDEs, and will be vastly simpler than 100% solution.
-
to understand how the consumer-side of compiler API should look like (especially it's on-demand aspects). If you have
get_expression_typefunction, you can write a ton of purely-IDE features on top of it, even if the function is only partially correct. Pluging in the precise function afterwards should just make IDE features more reliable.
The long term plan is to merge with the mainline rustc compiler, probably around the HIR boundary? That is, use rust analyzer for parsing, macro expansion and related bits of name resolution, but leave the rest (including type inference and trait selection) to the existing rustc.
Getting in touch
We have a Discord server dedicated to compilers and language servers implemented in Rust: https://discord.gg/sx3RQZB.
Contributing
See CONTRIBUTING.md and ARCHITECTURE.md
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.