README.md

   1 # Rust Analyzer
   2
   3 [![Build Status](https://travis-ci.org/matklad/rust-analyzer.svg?branch=master)](https://travis-ci.org/matklad/rust-analyzer)
   4 [![Build status](https://ci.appveyor.com/api/projects/status/j56x1hbje8rdg6xk/branch/master?svg=true)](https://ci.appveyor.com/project/matklad/rust-analyzer/branch/master)
   5
   6
   7 Rust Analyzer is an **experimental** modular compiler frontend for the
   8 Rust language, which aims to lay a foundation for excellent IDE
   9 support.
  10
  11 It doesn't implement much of compiler functionality yet, but the
  12 white-space preserving Rust parser works, and there are significant
  13 chunks of overall architecture (indexing, on-demand & lazy
  14 computation, snapshotable world view) in place. Some basic IDE
  15 functionality is provided via a language server.
  16
  17 ## Quick Start
  18
  19 Rust analyzer builds on stable Rust >= 1.29.0.
  20
  21 ```
  22 # run tests
  23 $ cargo test
  24
  25 # show syntax tree of a Rust file
  26 $ cargo run --package ra_cli parse < crates/ra_syntax/src/lib.rs
  27
  28 # show symbols of a Rust file
  29 $ cargo run --package ra_cli symbols < crates/ra_syntax/src/lib.rs
  30 ```
  31
  32 To try out the language server, see [these
  33 instructions](./editors/README.md). Please note that the server is not
  34 ready for general use yet. If you are looking for a Rust IDE that
  35 works, use [IntelliJ
  36 Rust](https://github.com/intellij-rust/intellij-rust) or
  37 [RLS](https://github.com/rust-lang-nursery/rls). That being said, the
  38 basic stuff works, and rust analyzer is developed in the rust analyzer
  39 powered editor.
  40
  41
  42 ## Current Status and Plans
  43
  44 Rust analyzer aims to fill the same niche as the official [Rust
  45 Language Server](https://github.com/rust-lang-nursery/rls), but uses a
  46 significantly different architecture. More details can be found [in
  47 this
  48 thread](https://internals.rust-lang.org/t/2019-strategy-for-rustc-and-the-rls/8361),
  49 but the core issue is that RLS works in the "wait until user stops
  50 typing, run the build process, save the results of the analysis" mode,
  51 which arguably is the wrong foundation for IDE.
  52
  53 Rust Analyzer is a hobby project at the moment, there's exactly zero
  54 guarantees that it becomes production-ready one day.
  55
  56 The near/mid term plan is to work independently of the main rustc
  57 compiler and implement at least simplistic versions of name
  58 resolution, macro expansion and type inference. The purpose is two
  59 fold:
  60
  61 * to quickly bootstrap usable and useful language server: solution
  62   that covers 80% of Rust code will be useful for IDEs, and will be
  63   vastly simpler than 100% solution.
  64
  65 * to understand how the consumer-side of compiler API should look like
  66   (especially it's on-demand aspects). If you have
  67   `get_expression_type` function, you can write a ton of purely-IDE
  68   features on top of it, even if the function is only partially
  69   correct. Plugin in the precise function afterwards should just make
  70   IDE features more reliable.
  71
  72 The long term plan is to merge with the mainline rustc compiler,
  73 probably around the HIR boundary? That is, use rust analyzer for
  74 parsing, macro expansion and related bits of name resolution, but
  75 leave the rest (including type inference and trait selection) to the
  76 existing rustc.
  77
  78 ## Code Walk-Through
  79
  80 ### `crates/ra_syntax`
  81
  82 Rust syntax tree structure and parser. See
  83 [RFC](https://github.com/rust-lang/rfcs/pull/2256) for some design
  84 notes.
  85
  86 - `yellow`, red/green syntax tree, heavily inspired [by this](https://github.com/apple/swift/tree/ab68f0d4cbf99cdfa672f8ffe18e433fddc8b371/lib/Syntax)
  87 - `grammar`, the actual parser
  88 - `parser_api/parser_impl` bridges the tree-agnostic parser from `grammar` with `yellow` trees
  89 - `grammar.ron` RON description of the grammar, which is used to
  90   generate `syntax_kinds` and `ast` modules.
  91 - `algo`: generic tree algorithms, including `walk` for O(1) stack
  92   space tree traversal (this is cool) and `visit` for type-driven
  93   visiting the nodes (this is double plus cool, if you understand how
  94   `Visitor` works, you understand rust-analyzer).
  95
  96
  97 ### `crates/ra_editor`
  98
  99 All IDE features which can be implemented if you only have access to a
 100 single file. `ra_editor` could be used to enhance editing of Rust code
 101 without the need to fiddle with build-systems, file
 102 synchronization and such.
 103
 104 In a sense, `ra_editor` is just a bunch of pure functions which take a
 105 syntax tree as an input.
 106
 107 ### `crates/salsa`
 108
 109 An implementation of red-green incremental compilation algorithm from
 110 rust compiler. It makes all rust-analyzer features on-demand.
 111
 112
 113 ### `crates/ra_analysis`
 114
 115 A stateful library for analyzing many Rust files as they change.
 116 `AnalysisHost` is a mutable entity (clojure's atom) which holds
 117 current state, incorporates changes and handles out `Analysis` --- an
 118 immutable consistent snapshot of world state at a point in time, which
 119 actually powers analysis.
 120
 121
 122 ### `crates/ra_lsp_server`
 123
 124 An LSP implementation which uses `ra_analysis` for managing state and
 125 `ra_editor` for actually doing useful stuff.
 126
 127
 128 ### `crates/cli`
 129
 130 A CLI interface to libsyntax
 131
 132 ### `crate/tools`
 133
 134 Code-gen tasks, used to develop rust-analyzer:
 135
 136 - `cargo gen-kinds` -- generate `ast` and `syntax_kinds`
 137 - `cargo gen-tests` -- collect inline tests from grammar
 138 - `cargo install-code` -- build and install VS Code extension and server
 139
 140 ### `editors/code`
 141
 142 VS Code plugin
 143
 144
 145 ## Performance
 146
 147 Non-incremental, but seems pretty fast:
 148
 149 ```
 150 $ cargo build --release --package ra_cli
 151 $ wc -l ~/projects/rust/src/libsyntax/parse/parser.rs
 152 7546 /home/matklad/projects/rust/src/libsyntax/parse/parser.rs
 153 $ ./target/release/ra_cli parse < ~/projects/rust/src/libsyntax/parse/parser.rs --no-dump  > /dev/null
 154 parsing: 21.067065ms
 155 ```
 156
 157 ## Getting in touch
 158
 159 @matklad can be found at Rust
 160 [discord](https://discordapp.com/invite/rust-lang), in
 161 #ides-and-editors.
 162
 163
 164 ## License
 165
 166 Rust analyzer is primarily distributed under the terms of both the MIT
 167 license and the Apache License (Version 2.0).
 168
 169 See LICENSE-APACHE and LICENSE-MIT for details.