mirror of https://github.com/rust-lang/rust.git synced 2024-11-25 16:24:46 +00:00

Charles Giguere a0de1723bd

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 14:47:54 -05:00

2.8 KiB

Raw Blame History

rust-analyzer

Provides support for rust-analyzer: novel LSP server for the Rust programming language.

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.

Note the project is in alpha status: it is already useful in practice, but can't be considered stable.

Work on rust-analyzer is sponsored by

Features

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

Quick start

Install rustup the rust toolchain
Install the rust-analyzer extension

Configuration

This extension provides configurations through VSCode's configuration settings. All the configurations are under rust-analyzer.*.

See 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

Documentation

See https://rust-analyzer.github.io/ for more information.

2.8 KiB Raw Blame History