3 [![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer)
5 Rust Analyzer is an **experimental** modular compiler frontend for the Rust
6 language. It is a part of a larger rls-2.0 effort to create excellent IDE
7 support for Rust. If you want to get involved, check the rls-2.0 working group
8 in the compiler-team repository:
10 https://github.com/rust-lang/compiler-team/tree/master/working-groups/rls-2.0
12 Work on the Rust Analyzer is sponsored by
14 [![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/)
18 Rust analyzer builds on Rust >= 1.31.0 and uses the 2018 edition.
24 # show syntax tree of a Rust file
25 $ cargo run --package ra_cli parse < crates/ra_syntax/src/lib.rs
27 # show symbols of a Rust file
28 $ cargo run --package ra_cli symbols < crates/ra_syntax/src/lib.rs
30 # install the language server
33 $ cargo install --path crates/ra_lsp_server
36 See [these instructions](./editors/README.md) for VS Code setup and the list of
37 features (some of which are VS Code specific).
41 See [these instructions](./DEBUGGING.md) on how to debug the vscode extension and the lsp server.
45 We are on the rust-lang Zulip!
47 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
51 See [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md)
53 ## Supported LSP features
56 - [x] [initialize](https://microsoft.github.io/language-server-protocol/specification#initialize)
57 - [x] [initialized](https://microsoft.github.io/language-server-protocol/specification#initialized)
58 - [x] [shutdown](https://microsoft.github.io/language-server-protocol/specification#shutdown)
59 - [ ] [exit](https://microsoft.github.io/language-server-protocol/specification#exit)
60 - [x] [$/cancelRequest](https://microsoft.github.io/language-server-protocol/specification#cancelRequest)
63 - [ ] [workspace/workspaceFolders](https://microsoft.github.io/language-server-protocol/specification#workspace_workspaceFolders)
64 - [ ] [workspace/didChangeWorkspaceFolders](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeWorkspaceFolders)
65 - [x] [workspace/didChangeConfiguration](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeConfiguration)
66 - [ ] [workspace/configuration](https://microsoft.github.io/language-server-protocol/specification#workspace_configuration)
67 - [x] [workspace/didChangeWatchedFiles](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeWatchedFiles)
68 - [x] [workspace/symbol](https://microsoft.github.io/language-server-protocol/specification#workspace_symbol)
69 - [x] [workspace/executeCommand](https://microsoft.github.io/language-server-protocol/specification#workspace_executeCommand)
71 - [ ] [workspace/applyEdit](https://microsoft.github.io/language-server-protocol/specification#workspace_applyEdit)
73 ### Text Synchronization
74 - [x] [textDocument/didOpen](https://microsoft.github.io/language-server-protocol/specification#textDocument_didOpen)
75 - [x] [textDocument/didChange](https://microsoft.github.io/language-server-protocol/specification#textDocument_didChange)
76 - [ ] [textDocument/willSave](https://microsoft.github.io/language-server-protocol/specification#textDocument_willSave)
77 - [ ] [textDocument/willSaveWaitUntil](https://microsoft.github.io/language-server-protocol/specification#textDocument_willSaveWaitUntil)
78 - [x] [textDocument/didSave](https://microsoft.github.io/language-server-protocol/specification#textDocument_didSave)
79 - [x] [textDocument/didClose](https://microsoft.github.io/language-server-protocol/specification#textDocument_didClose)
82 - [x] [textDocument/publishDiagnostics](https://microsoft.github.io/language-server-protocol/specification#textDocument_publishDiagnostics)
84 ### Lanuguage Features
85 - [x] [textDocument/completion](https://microsoft.github.io/language-server-protocol/specification#textDocument_completion)
89 - will save wait until: false
91 - [x] [completionItem/resolve](https://microsoft.github.io/language-server-protocol/specification#completionItem_resolve)
92 - resolve provider: none
93 - trigger characters: `:`, `.`
94 - [x] [textDocument/hover](https://microsoft.github.io/language-server-protocol/specification#textDocument_hover)
95 - [x] [textDocument/signatureHelp](https://microsoft.github.io/language-server-protocol/specification#textDocument_signatureHelp)
96 - trigger characters: `(`, `,`, `)`
97 - [ ] [textDocument/declaration](https://microsoft.github.io/language-server-protocol/specification#textDocument_declaration)
98 - [x] [textDocument/definition](https://microsoft.github.io/language-server-protocol/specification#textDocument_definition)
99 - [ ] [textDocument/typeDefinition](https://microsoft.github.io/language-server-protocol/specification#textDocument_typeDefinition)
100 - [x] [textDocument/implementation](https://microsoft.github.io/language-server-protocol/specification#textDocument_implementation)
101 - [x] [textDocument/references](https://microsoft.github.io/language-server-protocol/specification#textDocument_references)
102 - [x] [textDocument/documentHighlight](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentHighlight)
103 - [x] [textDocument/documentSymbol](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentSymbol)
104 - [x] [textDocument/codeAction](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeAction)
105 - rust-analyzer.syntaxTree
106 - rust-analyzer.extendSelection
107 - rust-analyzer.matchingBrace
108 - rust-analyzer.parentModule
109 - rust-analyzer.joinLines
111 - rust-analyzer.analyzerStatus
112 - [x] [textDocument/codeLens](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeLens)
113 - [ ] [textDocument/documentLink](https://microsoft.github.io/language-server-protocol/specification#codeLens_resolve)
114 - [ ] [documentLink/resolve](https://microsoft.github.io/language-server-protocol/specification#documentLink_resolve)
115 - [ ] [textDocument/documentColor](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentColor)
116 - [ ] [textDocument/colorPresentation](https://microsoft.github.io/language-server-protocol/specification#textDocument_colorPresentation)
117 - [x] [textDocument/formatting](https://microsoft.github.io/language-server-protocol/specification#textDocument_formatting)
118 - [ ] [textDocument/rangeFormatting](https://microsoft.github.io/language-server-protocol/specification#textDocument_rangeFormatting)
119 - [x] [textDocument/onTypeFormatting](https://microsoft.github.io/language-server-protocol/specification#textDocument_onTypeFormatting)
120 - first trigger character: `=`
121 - more trigger character `.`
122 - [x] [textDocument/rename](https://microsoft.github.io/language-server-protocol/specification#textDocument_rename)
123 - [x] [textDocument/prepareRename](https://microsoft.github.io/language-server-protocol/specification#textDocument_prepareRename)
124 - [x] [textDocument/foldingRange](https://microsoft.github.io/language-server-protocol/specification#textDocument_foldingRange)
128 Rust analyzer is primarily distributed under the terms of both the MIT
129 license and the Apache License (Version 2.0).
131 See LICENSE-APACHE and LICENSE-MIT for details.