Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-11-15 01:17:27 +00:00
Code Issues Projects Releases Packages Wiki Activity
rust-analyzer/editors/code/README.md

53 lines
2.4 KiB
Markdown
Raw Normal View History

Minimal viable meta
2020-03-02 13:27:26 +00:00
# rust-analyzer
Fix typo in VSCode readme
2022-04-30 18:03:51 +00:00
This extension provides support for the [Rust programming language](https://www.rust-lang.org/).
Improve extension description and README
2022-05-13 16:12:54 +00:00
It is recommended over and replaces `rust-lang.rust`.
Update vscode README with a small features list
2021-03-01 10:07:15 +00: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 19:47:54 +00:00
## Features
Update vscode README with a small features list
2021-03-01 10:07:15 +00:00
Update feature listing in extension README
2022-04-15 17:11:56 +00: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 20:07:36 +00:00
- [types and documentation on hover]
Update feature listing in extension README
2022-04-15 17:11:56 +00:00
- [inlay hints] for types and parameter names
add sponsor links
2021-03-01 20:07:36 +00:00
- [semantic syntax highlighting]
Improve extension description and README
2022-05-13 16:12:54 +00:00
- a lot of [assists (code actions)]
add sponsor links
2021-03-01 20:07:36 +00:00
- apply suggestions from errors
Improve extension description and README
2022-05-13 16:12:54 +00:00
- ... and many more, check out the [manual] to see them all
Update vscode README with a small features list
2021-03-01 10:07:15 +00:00
[code completion]: https://rust-analyzer.github.io/manual.html#magic-completions
Update feature listing in extension README
2022-04-15 17:11:56 +00: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 10:07:15 +00: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 17:11:56 +00:00
[symbol renaming]: https://rust-analyzer.github.io/manual.html#rename
Update vscode README with a small features list
2021-03-01 10:07:15 +00: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 16:12:54 +00: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 10:07:15 +00: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 19:47:54 +00:00
## Quick start
add sponsor links
2021-03-01 20:07:36 +00:00
Improve extension description and README
2022-05-13 16:12:54 +00: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 19:47:54 +00:00
[rustup]: https://rustup.rs
feat: Change VSCode extension publisher to `rust-lang`
2022-05-13 11:21:52 +00: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 19:47:54 +00:00
## Configuration
Improve extension description and README
2022-05-13 16:12:54 +00: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 19:47:54 +00:00
Improve extension description and README
2022-05-13 16:12:54 +00: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 19:47:54 +00:00
## Communication
Improve extension description and README
2022-05-13 16:12:54 +00: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 19:47:54 +00:00
## Documentation
Improve extension description and README
2022-05-13 16:12:54 +00:00
See [rust-analyzer.github.io](https://rust-analyzer.github.io/) for more information.
Reference in a new issue Copy permalink