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

74 lines
3 KiB
Markdown
Raw Normal View History

Minimal viable meta
2020-03-02 13:27:26 +00:00
# rust-analyzer
Provides support for rust-analyzer: novel LSP server for the Rust programming language.
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
**Note** the extension may cause conflicts with the official Rust extension. It is recommended to disable the Rust extension when using the rust-analyzer extension.
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
**Note** the project is in alpha status: it is already useful in practice, but can't be considered stable.
## Sponsor
Work on rust-analyzer is sponsored by
[<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
add sponsor links
2021-03-01 20:07:36 +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
- [Mozilla](https://www.mozilla.org/en-US/)
- [Embark Studios](https://embark-studios.com/)
- [freiheit.com](https://www.freiheit.com)
add sponsor links
2021-03-01 20:07:36 +00:00
If you want to sponsor:
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
add sponsor links
2021-03-01 20:07:36 +00:00
- [OpenCollective](https://opencollective.com/rust-analyzer/)
- [Github Sponsors](https://github.com/sponsors/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
## Features
Update vscode README with a small features list
2021-03-01 10:07:15 +00:00
add sponsor links
2021-03-01 20:07:36 +00:00
- [code completion], [imports insertion]
- [go to definition], [implementation], [type definition]
- [find all references], [workspace symbol search], [rename]
- [types and documentation on hover]
- [inlay hints]
- [semantic syntax highlighting]
- a lot of [assist(code actions)]
- apply suggestions from errors
- ... and many more, checkout 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
[imports insertion]: https://rust-analyzer.github.io/manual.html#auto-import
[go to 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
[rename]: 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
[assist(code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions
[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
clean uo rustup link
2021-03-01 20:19:30 +00:00
1. Install [rustup]
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
2. Install the [rust-analyzer extension]
[rustup]: https://rustup.rs
[rust-analyzer extension]: https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer
## Configuration
This extension provides configurations through VSCode's configuration settings. All the configurations are under `rust-analyzer.*`.
add sponsor links
2021-03-01 20:07:36 +00:00
See <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
For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
add sponsor links
2021-03-01 20:07:36 +00:00
<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
add sponsor links
2021-03-01 20:07:36 +00:00
See <https://rust-analyzer.github.io/> for more information.
Reference in a new issue Copy permalink