editors/code/README.md

   1 # rust-analyzer
   2
   3 Provides support for rust-analyzer: novel LSP server for the Rust programming language.
   4
   5 **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.
   6
   7 ## Features
   8
   9 - [code completion], [imports insertion]
  10 - [go to definition], [implementation], [type definition]
  11 - [find all references], [workspace symbol search], [rename]
  12 - [types and documentation on hover]
  13 - [inlay hints]
  14 - [semantic syntax highlighting]
  15 - a lot of [assist(code actions)]
  16 - apply suggestions from errors
  17 - ... and many more, checkout the [manual] to see them all
  18
  19 [code completion]: https://rust-analyzer.github.io/manual.html#magic-completions
  20 [imports insertion]: https://rust-analyzer.github.io/manual.html#auto-import
  21 [go to definition]: https://rust-analyzer.github.io/manual.html#go-to-definition
  22 [implementation]: https://rust-analyzer.github.io/manual.html#go-to-implementation
  23 [type definition]: https://rust-analyzer.github.io/manual.html#go-to-type-definition
  24 [find all references]: https://rust-analyzer.github.io/manual.html#find-all-references
  25 [workspace symbol search]: https://rust-analyzer.github.io/manual.html#workspace-symbol
  26 [rename]: https://rust-analyzer.github.io/manual.html#rename
  27 [types and documentation on hover]: https://rust-analyzer.github.io/manual.html#hover
  28 [inlay hints]: https://rust-analyzer.github.io/manual.html#inlay-hints
  29 [semantic syntax highlighting]: https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting
  30 [assist(code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions
  31
  32 [manual]: https://rust-analyzer.github.io/manual.html
  33
  34 ## Quick start
  35
  36 1. Install [rustup]
  37 2. Install the [rust-analyzer extension]
  38
  39 [rustup]: https://rustup.rs
  40 [rust-analyzer extension]: https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer
  41
  42 ## Configuration
  43
  44 This extension provides configurations through VSCode's configuration settings. All the configurations are under `rust-analyzer.*`.
  45
  46 See <https://rust-analyzer.github.io/manual.html#vs-code-2> for more information on VSCode specific configurations.
  47
  48 ## Communication
  49
  50 For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
  51
  52 <https://users.rust-lang.org/c/ide/14>
  53
  54 ## Documentation
  55
  56 See <https://rust-analyzer.github.io/> for more information.