No description
Find a file
bors[bot] 4b0c37bd6e Merge #1439
1439: Rich mapping of cargo watch output r=matklad a=etaoins

Currently we depend on the ASCII rendering string that `rustc` provides to populate Visual Studio Code's diagnostic. This has a number of shortcomings:

1. It's not a very good use of space in the error list
2. We can't jump to secondary spans (e.g. where a called function is defined)
3. We can't use Code Actions aka Quick Fix

This moves all of the low-level parsing and mapping to a `rust_diagnostics.ts`. This uses some heuristics to map Rust diagnostics to VsCode:

1. As before, the Rust diagnostic message and primary span is used for the root diagnostic. However, we now just use the message instead of the rendered version.

2. Every secondary span is converted to "related information". This  shows as child in the error list and can be jumped to.

3. Every child diagnostic is categorised in to three buckets:
    1. If they have no span they're treated as another line of the root messages
    2. If they have replacement text they're treated as a Code Action
    3. If they have a span but no replacement text they're treated as related information (same as secondary spans).

Co-authored-by: Ryan Cumming <etaoins@gmail.com>
2019-06-25 12:37:07 +00:00
.cargo rename tools -> ra_tools 2019-06-11 01:47:37 +03:00
.vscode revert change to "check" since "build" is intentional 2019-03-10 14:57:30 +01:00
crates Add comment 2019-06-25 20:57:42 +09:00
docs More details on how to set up coc 2019-06-18 09:25:59 -05:00
editors Tweak isUnusedOrUnnecessary 2019-06-25 21:44:27 +10:00
.gitattributes add .gitattributes 2019-04-05 23:31:58 +08:00
.gitignore Updated the gitignore 2019-04-05 22:06:15 +01:00
.travis.yml don't remove tools from cache 2019-05-30 10:17:29 +03:00
bors.toml remove appveyor 2019-04-21 19:26:01 +03:00
Cargo.lock Bump cargo_metadata, ena, flexi_logger 2019-06-20 15:09:39 -04:00
Cargo.toml ⬆️ salsa 2019-06-07 09:44:28 +03: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 fix logo 2019-05-21 17:43:24 +03:00
rustfmt.toml enable "small heuristics" 2019-02-08 14:49:26 +03:00

Rust Analyzer

Build Status

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 the rls-2.0 working group in the compiler-team repository:

https://github.com/rust-lang/compiler-team/tree/master/working-groups/rls-2.0

Work on the Rust Analyzer is sponsored by

Ferrous Systems

Language Server Quick Start

Rust Analyzer is a work-in-progress, so you'll have to build it from source, and you might encounter critical bugs. That said, it is complete enough to provide a useful IDE experience and some people use it as a daily driver.

To build rust-analyzer, you need:

  • latest stable rust for language server itself
  • latest stable npm and VS Code for VS Code extension (code should be in path)

For setup for other editors, see ./docs/user.

# clone the repo
$ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer

# install both the language server and VS Code extension
$ cargo install-code

# alternatively, install only the server. Binary name is `ra_lsp_server`.
$ cargo install-lsp

Documentation

If you want to contribute to rust-analyzer or just curious about how things work under the hood, check the ./docs/dev folder.

If you want to use rust-analyzer's language server with your editor of choice, check ./docs/user folder. It also contains some tips & tricks to help you be more productive when using rust-analyzer.

Getting in touch

We are on the rust-lang Zulip!

https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0

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.