rust/editors/code/README.md

# 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

- [code completion] with [imports insertion]
- go to [definition], [implementation], [type definition]
- [find all references], [workspace symbol search], [symbol renaming]
- [types and documentation on hover]
- [inlay hints] for types and parameter names
- [semantic syntax highlighting]
- a lot of [assists (code actions)]
- apply suggestions from errors
- ... 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
[definition]: https://rust-analyzer.github.io/manual.html#go-to-definition
[implementation]: https://rust-analyzer.github.io/manual.html#go-to-implementation
[type definition]: https://rust-analyzer.github.io/manual.html#go-to-type-definition
[find all references]: https://rust-analyzer.github.io/manual.html#find-all-references
[workspace symbol search]: https://rust-analyzer.github.io/manual.html#workspace-symbol
[symbol renaming]: https://rust-analyzer.github.io/manual.html#rename
[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
[manual]: https://rust-analyzer.github.io/manual.html

## Quick start

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 configurations are under `rust-analyzer.*`.

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 the ["IDEs and Editors" category of the Rust forum](https://users.rust-lang.org/c/ide/14).

## Documentation

See [rust-analyzer.github.io](https://rust-analyzer.github.io/) for more information.
Minimal viable meta 2020-03-02 07:27:26 -06:00			`# rust-analyzer`

Fix typo in VSCode readme 2022-04-30 13:03:51 -05:00			`This extension provides support for the [Rust programming language](https://www.rust-lang.org/).`
Improve extension description and README 2022-05-13 11:12:54 -05:00			It is recommended over and replaces `rust-lang.rust`.
Update vscode README with a small features list 2021-03-01 04:07:15 -06:00
Add more information to VSCode extenstion README A lot of these are duplicated from the documentation or main README. While it's unfortunate to have duplicated information, the current VSCode page is very barebones and doesn't offer much confidence. This updated README offers a few more links and follows a structure similar to the official rust extension and other popular vscode extensions. The additions are, as much as possible specific to the vscode extension and not rust-analyzer as a LSP. The note about not using the official extension is also right there at the top because that's a common issue people have when trying it out. I added the sponsor section since it's common in other extensions README, but I'm not sure if it's necessary 2021-03-01 13:47:54 -06:00			`## Features`
Update vscode README with a small features list 2021-03-01 04:07:15 -06:00
Update feature listing in extension README 2022-04-15 12:11:56 -05:00			`- [code completion] with [imports insertion]`
			`- go to [definition], [implementation], [type definition]`
			`- [find all references], [workspace symbol search], [symbol renaming]`
add sponsor links 2021-03-01 14:07:36 -06:00			`- [types and documentation on hover]`
Update feature listing in extension README 2022-04-15 12:11:56 -05:00			`- [inlay hints] for types and parameter names`
add sponsor links 2021-03-01 14:07:36 -06:00			`- [semantic syntax highlighting]`
Improve extension description and README 2022-05-13 11:12:54 -05:00			`- a lot of [assists (code actions)]`
add sponsor links 2021-03-01 14:07:36 -06:00			`- apply suggestions from errors`
Improve extension description and README 2022-05-13 11:12:54 -05:00			`- ... and many more, check out the [manual] to see them all`
Update vscode README with a small features list 2021-03-01 04:07:15 -06:00
			`[code completion]: https://rust-analyzer.github.io/manual.html#magic-completions`
Update feature listing in extension README 2022-04-15 12:11:56 -05:00			`[imports insertion]: https://rust-analyzer.github.io/manual.html#completion-with-autoimport`
			`[definition]: https://rust-analyzer.github.io/manual.html#go-to-definition`
Update vscode README with a small features list 2021-03-01 04:07:15 -06:00			`[implementation]: https://rust-analyzer.github.io/manual.html#go-to-implementation`
			`[type definition]: https://rust-analyzer.github.io/manual.html#go-to-type-definition`
			`[find all references]: https://rust-analyzer.github.io/manual.html#find-all-references`
			`[workspace symbol search]: https://rust-analyzer.github.io/manual.html#workspace-symbol`
Update feature listing in extension README 2022-04-15 12:11:56 -05:00			`[symbol renaming]: https://rust-analyzer.github.io/manual.html#rename`
Update vscode README with a small features list 2021-03-01 04:07:15 -06:00			`[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`
Improve extension description and README 2022-05-13 11:12:54 -05:00			`[assists (code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions`
Update vscode README with a small features list 2021-03-01 04:07:15 -06:00			`[manual]: https://rust-analyzer.github.io/manual.html`

Add more information to VSCode extenstion README A lot of these are duplicated from the documentation or main README. While it's unfortunate to have duplicated information, the current VSCode page is very barebones and doesn't offer much confidence. This updated README offers a few more links and follows a structure similar to the official rust extension and other popular vscode extensions. The additions are, as much as possible specific to the vscode extension and not rust-analyzer as a LSP. The note about not using the official extension is also right there at the top because that's a common issue people have when trying it out. I added the sponsor section since it's common in other extensions README, but I'm not sure if it's necessary 2021-03-01 13:47:54 -06:00			`## Quick start`
add sponsor links 2021-03-01 14:07:36 -06:00
Improve extension description and README 2022-05-13 11:12:54 -05:00			`1. Install [rustup].`
			`2. Install the [rust-analyzer extension].`
Add more information to VSCode extenstion README A lot of these are duplicated from the documentation or main README. While it's unfortunate to have duplicated information, the current VSCode page is very barebones and doesn't offer much confidence. This updated README offers a few more links and follows a structure similar to the official rust extension and other popular vscode extensions. The additions are, as much as possible specific to the vscode extension and not rust-analyzer as a LSP. The note about not using the official extension is also right there at the top because that's a common issue people have when trying it out. I added the sponsor section since it's common in other extensions README, but I'm not sure if it's necessary 2021-03-01 13:47:54 -06:00
			`[rustup]: https://rustup.rs`
feat: Change VSCode extension publisher to `rust-lang` 2022-05-13 06:21:52 -05:00			`[rust-analyzer extension]: https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer`
Add more information to VSCode extenstion README A lot of these are duplicated from the documentation or main README. While it's unfortunate to have duplicated information, the current VSCode page is very barebones and doesn't offer much confidence. This updated README offers a few more links and follows a structure similar to the official rust extension and other popular vscode extensions. The additions are, as much as possible specific to the vscode extension and not rust-analyzer as a LSP. The note about not using the official extension is also right there at the top because that's a common issue people have when trying it out. I added the sponsor section since it's common in other extensions README, but I'm not sure if it's necessary 2021-03-01 13:47:54 -06:00
			`## Configuration`

Improve extension description and README 2022-05-13 11:12:54 -05:00			This extension provides configurations through VSCode's configuration settings. All configurations are under `rust-analyzer.*`.
Add more information to VSCode extenstion README A lot of these are duplicated from the documentation or main README. While it's unfortunate to have duplicated information, the current VSCode page is very barebones and doesn't offer much confidence. This updated README offers a few more links and follows a structure similar to the official rust extension and other popular vscode extensions. The additions are, as much as possible specific to the vscode extension and not rust-analyzer as a LSP. The note about not using the official extension is also right there at the top because that's a common issue people have when trying it out. I added the sponsor section since it's common in other extensions README, but I'm not sure if it's necessary 2021-03-01 13:47:54 -06:00
Improve extension description and README 2022-05-13 11:12:54 -05:00			`See [the manual](https://rust-analyzer.github.io/manual.html#vs-code-2) for more information on VSCode specific configurations.`
Add more information to VSCode extenstion README A lot of these are duplicated from the documentation or main README. While it's unfortunate to have duplicated information, the current VSCode page is very barebones and doesn't offer much confidence. This updated README offers a few more links and follows a structure similar to the official rust extension and other popular vscode extensions. The additions are, as much as possible specific to the vscode extension and not rust-analyzer as a LSP. The note about not using the official extension is also right there at the top because that's a common issue people have when trying it out. I added the sponsor section since it's common in other extensions README, but I'm not sure if it's necessary 2021-03-01 13:47:54 -06:00
			`## Communication`

Improve extension description and README 2022-05-13 11:12:54 -05:00			`For usage and troubleshooting requests, please use the ["IDEs and Editors" category of the Rust forum](https://users.rust-lang.org/c/ide/14).`
Add more information to VSCode extenstion README A lot of these are duplicated from the documentation or main README. While it's unfortunate to have duplicated information, the current VSCode page is very barebones and doesn't offer much confidence. This updated README offers a few more links and follows a structure similar to the official rust extension and other popular vscode extensions. The additions are, as much as possible specific to the vscode extension and not rust-analyzer as a LSP. The note about not using the official extension is also right there at the top because that's a common issue people have when trying it out. I added the sponsor section since it's common in other extensions README, but I'm not sure if it's necessary 2021-03-01 13:47:54 -06:00
			`## Documentation`

Improve extension description and README 2022-05-13 11:12:54 -05:00			`See [rust-analyzer.github.io](https://rust-analyzer.github.io/) for more information.`