Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-26 13:03:31 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve extension description and README

Browse source
This commit is contained in:
Florian Diebold 2022-05-13 18:12:54 +02:00
parent 4f6b2a20fd
commit 85fe9391d3
2 changed files with 12 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
editors/code/README.md
View file

@ -1,6 +1,7 @@
# rust-analyzer
This extension provides support for the [Rust programming language](https://www.rust-lang.org/).
It is recommended over and replaces `rust-lang.rust`.
## Features
@ -10,9 +11,9 @@ This extension provides support for the [Rust programming language](https://www.
- [types and documentation on hover]
- [inlay hints] for types and parameter names
- [semantic syntax highlighting]
- a lot of [assists(code actions)]
- a lot of [assists (code actions)]
- apply suggestions from errors
- ... and many more, checkout the [manual] to see them all
- ... and many more, check out the [manual] to see them all
[code completion]: https://rust-analyzer.github.io/manual.html#magic-completions
[imports insertion]: https://rust-analyzer.github.io/manual.html#completion-with-autoimport
@ -25,29 +26,27 @@ This extension provides support for the [Rust programming language](https://www.
[types and documentation on hover]: https://rust-analyzer.github.io/manual.html#hover
[inlay hints]: https://rust-analyzer.github.io/manual.html#inlay-hints
[semantic syntax highlighting]: https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting
[assists(code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions
[assists (code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions
[manual]: https://rust-analyzer.github.io/manual.html
## Quick start
1. Install [rustup]
2. Install the [rust-analyzer extension]
1. Install [rustup].
2. Install the [rust-analyzer extension].
[rustup]: https://rustup.rs
[rust-analyzer extension]: https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer
## Configuration
This extension provides configurations through VSCode's configuration settings. All the configurations are under `rust-analyzer.*`.
This extension provides configurations through VSCode's configuration settings. All configurations are under `rust-analyzer.*`.
See <https://rust-analyzer.github.io/manual.html#vs-code-2> for more information on VSCode specific configurations.
See [the manual](https://rust-analyzer.github.io/manual.html#vs-code-2) for more information on VSCode specific configurations.
## Communication
For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
<https://users.rust-lang.org/c/ide/14>
For usage and troubleshooting requests, please use the ["IDEs and Editors" category of the Rust forum](https://users.rust-lang.org/c/ide/14).
## Documentation
See <https://rust-analyzer.github.io/> for more information.
See [rust-analyzer.github.io](https://rust-analyzer.github.io/) for more information.

4
editors/code/package.json
View file

@ -1,7 +1,7 @@
{
"name": "rust-analyzer",
"displayName": "rust-analyzer",
"description": "A language server for the rust programming language",
"description": "The future of Rust support in VSCode.",
"preview": true,
"private": true,
"icon": "icon.png",
@ -9,7 +9,7 @@
"releaseTag": null,
"publisher": "rust-lang",
"repository": {
"url": "https://github.com/rust-analyzer/rust-analyzer.git",
"url": "https://github.com/rust-lang/rust-analyzer.git",
"type": "git"
},
"homepage": "https://rust-analyzer.github.io/",