Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-11-10 07:04:22 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
4852 commits 3 branches 263 tags 150 MiB
Rust 96.4%
HTML 1.8%
TypeScript 1.8%
Find a file
bors[bot] 734a43e95a
Merge #1793 
1793: Fix outer doc-comments of `macro_rules` r=matklad a=uHOOCCOOHu

Document comments of `macro_rules!` is currently parsed outside the `MACRO_CALL` node,
which makes `DocCommentsOwner::doc_comments()` always empty.

For the input:
```rust
/// Some docs
macro_rules! foo {
    () => {};
}
```

Current parsing tree is:
```
SOURCE_FILE
  COMMENT    // <- This should be children of MACRO_CALL
  WHITESPACE
  MACRO_CALL
    PATH
<...omitted...>
```

It should be:
```
SOURCE_FILE
  MACRO_CALL
    COMMENT
    WHITESPACE
    PATH
<...omitted...>
```


Co-authored-by: uHOOCCOOHu <hooccooh1896@gmail.com>
2019-09-09 08:45:00 +00:00
.cargo start GitHub pages 2019-09-02 14:42:23 +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 Merge #1793 2019-09-09 08:45:00 +00:00
docs Update README.md 2019-09-09 12:58:44 +08:00
editors add option to disable notify 2019-09-06 17:21:29 +03:00
website fix links 2019-09-02 15:02:45 +03: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 start GitHub pages 2019-09-02 14:42:23 +03:00
bors.toml remove appveyor 2019-04-21 19:26:01 +03:00
Cargo.lock Revert "Replace with immutable map to avoid heavy cloning" 2019-09-09 01:34:53 +08:00
Cargo.toml start GitHub pages 2019-09-02 14:42:23 +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 links 2019-09-02 15:02:45 +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 (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-ra

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

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.