-# Rust Analyzer
+<p align="center">
+ <img
+ src="https://raw.githubusercontent.com/rust-analyzer/rust-analyzer/master/assets/logo-wide.svg"
+ alt="rust-analyzer logo">
+</p>
-[](https://travis-ci.org/rust-analyzer/rust-analyzer)
+rust-analyzer is a 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.
-Rust Analyzer is an **experimental** modular compiler frontend for the Rust
-language, which aims to lay a foundation for excellent IDE support.
+Work on rust-analyzer is sponsored by
-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
-
-[](https://ferrous-systems.com/)
+[<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
+- [Mozilla](https://www.mozilla.org/en-US/)
+- [Embark Studios](https://embark-studios.com/)
+- [freiheit.com](https://www.freiheit.com)
## 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](./editors/README.md) for VS Code setup and the list of
-features (some of which are VS Code specific).
-
-## Debugging
-
-See [these instructions](./DEBUGGING.md) for VS Code setup and the list of
-features (some of which are VS Code specific).
-
-## Current Status and Plans
+https://rust-analyzer.github.io/manual.html#installation
-Rust analyzer aims to fill the same niche as the official [Rust Language
-Server](https://github.com/rust-lang-nursery/rls), but uses a significantly
-different architecture. More details can be found [in this
-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 typing, run
-the build process, save the results of the analysis" mode, which arguably is the
-wrong foundation for IDE.
+## Documentation
-Rust Analyzer is an experimental project at the moment, there's exactly zero
-guarantees that it becomes production-ready one day.
+If you want to **contribute** to rust-analyzer or are just curious about how
+things work under the hood, check the [./docs/dev](./docs/dev) folder.
-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:
+If you want to **use** rust-analyzer's language server with your editor of
+choice, check [the manual](https://rust-analyzer.github.io/manual.html) folder.
+It also contains some tips & tricks to help you be more productive when using rust-analyzer.
-- 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.
+## Communication
-- to understand how the consumer-side of compiler API should look like
- (especially it's on-demand aspects). If you have `get_expression_type`
- function, 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.
+For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
-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.
+https://users.rust-lang.org/c/ide/14
-## Getting in touch
+For questions about development and implementation, join rust-analyzer working group on Zulip:
-We have a Discord server dedicated to compilers and language servers
-implemented in Rust: [https://discord.gg/sx3RQZB](https://discord.gg/sx3RQZB).
+https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer
-## Contributing
+## Quick Links
-See [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md)
+* Website: https://rust-analyzer.github.io/
+* Metrics: https://rust-analyzer.github.io/metrics/
+* API docs: https://rust-analyzer.github.io/rust-analyzer/ide/
+* Changelog: https://rust-analyzer.github.io/thisweek
## License
projects / rust.git / blobdiff