7.4 KiB
Rust Analyzer
Rust Analyzer is an experimental 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. If you want to get involved, check rls-2.0 working group repository:
https://github.com/rust-analyzer/WG-rls2.0
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-lsp
or
$ 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.
Getting in touch
We are on the rust-lang Zulip!
https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
Contributing
See CONTRIBUTING.md and ARCHITECTURE.md
Supported LSP features
General
Workspace
- workspace/workspaceFolders
- workspace/didChangeWorkspaceFolders
- workspace/didChangeConfiguration
- workspace/configuration
- workspace/didChangeWatchedFiles
- workspace/symbol
- workspace/executeCommand
apply_code_action- workspace/applyEdit
Text Synchronization
- textDocument/didOpen
- textDocument/didChange
- textDocument/willSave
- textDocument/willSaveWaitUntil
- textDocument/didSave
- textDocument/didClose
Diagnostics
Lanuguage Features
- textDocument/completion
- open close: false
- change: Full
- will save: false
- will save wait until: false
- save: false
- completionItem/resolve
- resolve provider: none
- trigger characters:
:,. - textDocument/hover
- textDocument/signatureHelp
- trigger characters:
(,,,) - textDocument/declaration
- textDocument/definition
- textDocument/typeDefinition
- textDocument/implementation
- textDocument/references
- textDocument/documentHighlight
- textDocument/documentSymbol
- textDocument/codeAction
- rust-analyzer.syntaxTree
- rust-analyzer.extendSelection
- rust-analyzer.matchingBrace
- rust-analyzer.parentModule
- rust-analyzer.joinLines
- rust-analyzer.run
- rust-analyzer.analyzerStatus
- textDocument/codeLens
- textDocument/documentLink
- documentLink/resolve
- textDocument/documentColor
- textDocument/colorPresentation
- textDocument/formatting
- textDocument/rangeFormatting
- textDocument/onTypeFormatting
- first trigger character:
= - more trigger character
. - textDocument/rename
- textDocument/prepareRename
- textDocument/foldingRange
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.