Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-11-16 17:58:16 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
5488 commits 3 branches 264 tags 157 MiB
Rust 96.4%
HTML 1.8%
TypeScript 1.8%
Find a file
bors[bot] eb8f76a86f
Merge #2152 
2152: Use run-time project path in xtask r=matklad a=lnicola

Fixes #2131.

Co-authored-by: Laurențiu Nicola <lnicola@dend.ro>
2019-11-01 20:25:17 +00:00
.cargo rename tools -> xtask 2019-10-17 23:14:05 +03:00
.github Create FUNDING.yml 2019-07-06 08:33:19 +03:00
.vscode revert change to "check" since "build" is intentional 2019-03-10 14:57:30 +01:00
crates Change SourceAnalyzer method resoltion API 2019-11-01 20:01:21 +01:00
docs move all assists to use generated docs 2019-10-27 17:49:39 +03:00
editors Add link to the vscode VIM extension compatibility warning. 2019-10-30 21:44:27 +01:00
xtask Use run-time project path in xtask 2019-11-01 22:20:44 +02: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 scale website back 2019-10-17 22:37:01 +03:00
bors.toml remove appveyor 2019-04-21 19:26:01 +03:00
Cargo.lock updates 2019-10-31 10:31:59 -04:00
Cargo.toml rename tools -> xtask 2019-10-17 23:14:05 +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 WIP: move to xtasks 2019-10-17 22:54:38 +03:00
rustfmt.toml always use \n newlines 2019-09-05 17:50:39 +03:00

README.md

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/content/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

To quickly install rust-analyzer with VS Code extension with standard setup (code and cargo in $PATH, etc), use this:

# 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 xtask install

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

For non-standard setup of VS Code and other editors, see ./docs/user.

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

Quick Links

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.