editors/code/README.md

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