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 **Note** the project is in alpha status: it is already useful in practice, but can't be considered stable.
   8
   9 ## Sponsor
  10
  11 Work on rust-analyzer is sponsored by
  12
  13 [<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
  14 - [Mozilla](https://www.mozilla.org/en-US/)
  15 - [Embark Studios](https://embark-studios.com/)
  16 - [freiheit.com](https://www.freiheit.com)
  17
  18
  19
  20 ## Features
  21
  22 * [code completion], [imports insertion]
  23 * [go to definition], [implementation], [type definition]
  24 * [find all references], [workspace symbol search], [rename]
  25 * [types and documentation on hover]
  26 * [inlay hints]
  27 * [semantic syntax highlighting]
  28 * a lot of [assist(code actions)]
  29 * apply suggestions from errors
  30 * ... and many more, checkout the [manual] to see them all
  31
  32 [code completion]: https://rust-analyzer.github.io/manual.html#magic-completions
  33 [imports insertion]: https://rust-analyzer.github.io/manual.html#auto-import
  34 [go to definition]: https://rust-analyzer.github.io/manual.html#go-to-definition
  35 [implementation]: https://rust-analyzer.github.io/manual.html#go-to-implementation
  36 [type definition]: https://rust-analyzer.github.io/manual.html#go-to-type-definition
  37 [find all references]: https://rust-analyzer.github.io/manual.html#find-all-references
  38 [workspace symbol search]: https://rust-analyzer.github.io/manual.html#workspace-symbol
  39 [rename]: https://rust-analyzer.github.io/manual.html#rename
  40 [types and documentation on hover]: https://rust-analyzer.github.io/manual.html#hover
  41 [inlay hints]: https://rust-analyzer.github.io/manual.html#inlay-hints
  42 [semantic syntax highlighting]: https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting
  43 [assist(code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions
  44
  45
  46
  47 [manual]: https://rust-analyzer.github.io/manual.html
  48
  49 ## Quick start
  50 1. Install [rustup] the rust toolchain
  51 2. Install the [rust-analyzer extension]
  52
  53 [rustup]: https://rustup.rs
  54 [rust-analyzer extension]: https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer
  55
  56 ## Configuration
  57
  58 This extension provides configurations through VSCode's configuration settings. All the configurations are under `rust-analyzer.*`.
  59
  60 See https://rust-analyzer.github.io/manual.html#vs-code-2 for more information on VSCode specific configurations.
  61
  62 ## Communication
  63
  64 For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
  65
  66 https://users.rust-lang.org/c/ide/14
  67
  68 ## Documentation
  69
  70 See https://rust-analyzer.github.io/ for more information.