No description
Find a file
Ville Penttinen 77a4a311fe Add new configuration "enableEnhancedTyping" to control registering of "type" command
This further fixes problems when having a VIM extension (at least vscodevim)
enabled, by not calling `overrideCommand('type', commands.onEnter.handle)` when
enableEnhancedTyping is set to `false`.

The problem is dependent on the order in which extensions are activated, if
rust-analyzer is activated before `vscodevim`, rust-analyzer will register the
`type` command, and when `vscodevim` finally attempts to activate, it will fail
to register the command. This causes `vscodevim` to stop working properly.

This setting allows users to disable the registerCommand `type` in
rust-analyzer, allowing `vscodevim` to work. The setting defaults to `true`.

Currently changing the setting requires reloading of the window.
2019-02-07 12:37:36 +02:00
.cargo Add cargo jinstall-lsp as a shorthand to include jemalloc support 2019-01-29 17:02:06 +00:00
.vscode Config for raLspServerPath will be overwritten if __RA_LSP_SERVER_DEBUG is set 2019-01-19 15:36:54 +03:00
crates Remove stray dbg! 2019-02-06 07:22:16 -05:00
editors Add new configuration "enableEnhancedTyping" to control registering of "type" command 2019-02-07 12:37:36 +02:00
.gitignore Some cleanup and additional tests 2019-02-01 23:24:26 +01:00
.travis.yml fix verification on CI 2019-01-27 02:30:54 +03:00
ARCHITECTURE.md Add cargo jinstall-lsp as a shorthand to include jemalloc support 2019-01-29 17:02:06 +00:00
bors.toml don't gate on appveyor 2018-10-09 19:06:05 +03:00
Cargo.lock Bump insta and proptest to latest 2019-02-04 14:11:51 -05:00
Cargo.toml update salsa 2019-01-15 15:06:45 +03:00
CONTRIBUTING.md brush up docs 2018-10-15 01:05:18 +03:00
DEBUGGING.md Removed gif 2019-01-19 15:36:58 +03:00
guide.md add illustrations 2019-01-21 10:27:01 +02:00
LICENSE-APACHE Licenses 2018-01-10 22:47:04 +03:00
LICENSE-MIT Licenses 2018-01-10 22:47:04 +03:00
README.md Go to Implementation for structs and enums 2019-01-29 19:13:02 -05:00
ROADMAP.md don't mention beta channel Rust in ROADMAP 2018-12-28 14:38:27 -08:00
rustfmt.toml Don't order import alphabetical 2018-11-01 16:18:53 +03:00

Rust Analyzer

Build Status

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

Ferrous Systems

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.

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_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.

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.

Supported LSP features

General

Workspace

Text Synchronization

Diagnostics

Lanuguage Features

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.