editors/code/README.md

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