docs/user/readme.adoc

   1 = User Manual
   2 :toc: preamble
   3 :sectanchors:
   4 :page-layout: post
   5 // https://gist.github.com/dcode/0cfbf2699a1fe9b46ff04c41721dda74#admonitions
   6 :tip-caption: :bulb:
   7 :note-caption: :information_source:
   8 :important-caption: :heavy_exclamation_mark:
   9 :caution-caption: :fire:
  10 :warning-caption: :warning:
  11
  12
  13
  14 // Master copy of this document lives in the https://github.com/rust-analyzer/rust-analyzer repository
  15
  16 At its core, rust-analyzer is a *library* for semantic analysis of Rust code as it changes over time.
  17 This manual focuses on a specific usage of the library -- running it as part of a server that implements the
  18 https://microsoft.github.io/language-server-protocol/[Language Server Protocol] (LSP).
  19 The LSP allows various code editors, like VS Code, Emacs or Vim, to implement semantic features like completion or goto definition by talking to an external language server process.
  20
  21 To improve this document, send a pull request against
  22 https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/readme.adoc[this file].
  23
  24 == Installation
  25
  26 In theory, one should be able to just install the server binary and have it automatically work with any editor.
  27 We are not there yet, so some editor specific setup is required.
  28
  29 Additionally, rust-analyzer needs the sources of the standard library.
  30 If the source code is not present, rust-analyzer will attempt to install it automatically.
  31
  32 To add the sources manually, run the following command:
  33
  34 ```bash
  35 $ rustup component add rust-src
  36 ```
  37
  38 === VS Code
  39
  40 This is the best supported editor at the moment.
  41 The rust-analyzer plugin for VS Code is maintained
  42 https://github.com/rust-analyzer/rust-analyzer/tree/master/editors/code[in tree].
  43
  44 You can install the latest release of the plugin from
  45 https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer[the marketplace].
  46 By default, the plugin will prompt you to download the matching version of the server as well:
  47
  48 image::https://user-images.githubusercontent.com/9021944/75067008-17502500-54ba-11ea-835a-f92aac50e866.png[]
  49
  50 [NOTE]
  51 ====
  52 To disable this notification put the following to `settings.json`
  53
  54 [source,json]
  55 ----
  56 { "rust-analyzer.updates.askBeforeDownload": false }
  57 ----
  58 ====
  59
  60 The server binary is stored in `~/.config/Code/User/globalStorage/matklad.rust-analyzer` (Linux) or in `~/.Library/Application Support/Code/User/globalStorage/matklad.rust-analyzer` (macOS) or in `%APPDATA%\Code\User\globalStorage` (Windows).
  61
  62 Note that we only support the latest version of VS Code.
  63
  64 ==== Updates
  65
  66 The extension will be updated automatically as new versions become available. It will ask your permission to download the matching language server version binary if needed.
  67
  68 ===== Nightly
  69
  70 We ship nightly releases for VS Code. To help us out with testing the newest code and follow the bleeding edge of our `master`, please use the following config:
  71
  72 [source,json]
  73 ----
  74 { "rust-analyzer.updates.channel": "nightly" }
  75 ----
  76
  77 You will be prompted to install the `nightly` extension version. Just click `Download now` and from that moment you will get automatic updates every 24 hours.
  78
  79 If you don't want to be asked for `Download now` every day when the new nightly version is released add the following to your `settings.json`:
  80 [source,json]
  81 ----
  82 { "rust-analyzer.updates.askBeforeDownload": false }
  83 ----
  84
  85 NOTE: Nightly extension should **only** be installed via the `Download now` action from VS Code.
  86
  87 ==== Building From Source
  88
  89 Alternatively, both the server and the plugin can be installed from source:
  90
  91 [source]
  92 ----
  93 $ git clone https://github.com/rust-analyzer/rust-analyzer.git && cd rust-analyzer
  94 $ cargo xtask install
  95 ----
  96
  97 You'll need Cargo, nodejs and npm for this.
  98
  99 Note that installing via `xtask install` does not work for VS Code Remote, instead you'll need to install the `.vsix` manually.
 100
 101 ==== Troubleshooting
 102
 103 Here are some useful self-diagnostic commands:
 104
 105 * **Rust Analyzer: Show RA Version** shows the version of `rust-analyzer` binary
 106 * **Rust Analyzer: Status** prints some statistics about the server, like the few latest LSP requests
 107 * To enable server-side logging, run with `env RUST_LOG=info` and see `Output > Rust Analyzer Language Server` in VS Code's panel.
 108 * To log all LSP requests, add `"rust-analyzer.trace.server": "verbose"` to the settings and look for `Server Trace` in the panel.
 109 * To enable client-side logging, add `"rust-analyzer.trace.extension": true` to the settings and open the `Console` tab of VS Code developer tools.
 110
 111 === Language Server Binary
 112
 113 Other editors generally require the `rust-analyzer` binary to be in `$PATH`.
 114 You can download the pre-built binary from the https://github.com/rust-analyzer/rust-analyzer/releases[releases] page. Typically, you then need to rename the binary for your platform, e.g. `rust-analyzer-mac` if you're on Mac OS, to `rust-analzyer` and make it executable in addition to moving it into a directory in your `$PATH`.
 115
 116 Alternatively, you can install it from source using the following command:
 117
 118 [source,bash]
 119 ----
 120 $ cargo xtask install --server
 121 ----
 122
 123 If your editor can't find the binary even though the binary is on your `$PATH`, the likely explanation is that it doesn't see the same `$PATH` as the shell, see https://github.com/rust-analyzer/rust-analyzer/issues/1811[this issue]. On Unix, running the editor from a shell or changing the `.desktop` file to set the environment should help.
 124
 125 ==== Arch Linux
 126
 127 The `rust-analyzer` binary can be installed from AUR (Arch User Repository):
 128
 129 - https://aur.archlinux.org/packages/rust-analyzer-bin[`rust-analyzer-bin`] (binary from GitHub releases)
 130 - https://aur.archlinux.org/packages/rust-analyzer[`rust-analyzer`] (built from latest tagged source)
 131 - https://aur.archlinux.org/packages/rust-analyzer-git[`rust-analyzer-git`] (latest git version)
 132
 133 Install it with AUR helper of your choice, for example:
 134
 135 [source,bash]
 136 ----
 137 $ yay -S rust-analyzer-bin
 138 ----
 139
 140 === Emacs
 141
 142 Emacs support is maintained https://github.com/emacs-lsp/lsp-mode/blob/master/lsp-rust.el[upstream].
 143
 144 1. Install the most recent version of `emacs-lsp` package by following the instructions https://github.com/emacs-lsp/lsp-mode[here].
 145 2. Set `lsp-rust-server` to `'rust-analyzer`.
 146 3. Run `lsp` in a Rust buffer.
 147 4. (Optionally) bind commands like `lsp-rust-analyzer-join-lines`, `lsp-extend-selection` and `lsp-rust-analyzer-expand-macro` to keys.
 148
 149 === Vim
 150
 151 The are several LSP client implementations for vim:
 152
 153 ==== coc-rust-analyzer
 154
 155 1. Install coc.nvim by following the instructions at
 156    https://github.com/neoclide/coc.nvim[coc.nvim]
 157    (nodejs required)
 158 2. Run `:CocInstall coc-rust-analyzer` to install
 159    https://github.com/fannheyward/coc-rust-analyzer[coc-rust-analyzer],
 160    this extension implements _most_ of the features supported in the VSCode extension:
 161    * same configurations as VSCode extension, `rust-analyzer.serverPath`, `rust-analyzer.cargo.features` etc.
 162    * same commands too, `rust-analyzer.analyzerStatus`, `rust-analyzer.ssr` etc.
 163    * highlighting and inlay_hints are not implemented yet
 164
 165 ==== LanguageClient-neovim
 166
 167 1. Install LanguageClient-neovim by following the instructions
 168    https://github.com/autozimu/LanguageClient-neovim[here]
 169    * The github project wiki has extra tips on configuration
 170
 171 2. Configure by adding this to your vim/neovim config file (replacing the existing Rust-specific line if it exists):
 172 +
 173 [source,vim]
 174 ----
 175 let g:LanguageClient_serverCommands = {
 176 \ 'rust': ['rust-analyzer'],
 177 \ }
 178 ----
 179
 180 ==== YouCompleteMe
 181
 182 1. Install YouCompleteMe by following the instructions
 183   https://ycm-core.github.io/YouCompleteMe/#rust-semantic-completion[here]
 184
 185 2. Configure by adding this to your vim/neovim config file (replacing the existing Rust-specific line if it exists):
 186 +
 187 [source,vim]
 188 ----
 189 let g:ycm_language_server =
 190 \ [
 191 \   {
 192 \     'name': 'rust',
 193 \     'cmdline': ['rust-analyzer'],
 194 \     'filetypes': ['rust'],
 195 \     'project_root_files': ['Cargo.toml']
 196 \   }
 197 \ ]
 198 ----
 199
 200 ==== nvim-lsp
 201
 202 NeoVim 0.5 (not yet released) has built-in language server support.
 203 For a quick start configuration of rust-analyzer, use https://github.com/neovim/nvim-lsp#rust_analyzer[neovim/nvim-lsp].
 204 Once `neovim/nvim-lsp` is installed, use `+lua require'nvim_lsp'.rust_analyzer.setup({})+` in your `init.vim`.
 205
 206 === Sublime Text 3
 207
 208 Prerequisites: You have installed the <<language-server-binary,`rust-analyzer` binary>>.
 209
 210 You also need the `LSP` package. To install it:
 211
 212 1. If you've never installed a Sublime Text package, install Package Control:
 213    * Open the command palette (Win/Linux: `ctrl+shift+p`, Mac: `cmd+shift+p`)
 214    * Type `Install Package Control`, press enter
 215 2. In the command palette, run `Package control: Install package`, and in the list that pops up, type `LSP` and press enter.
 216
 217 Finally, with your Rust project open, in the command palette, run `LSP: Enable Language Server In Project` or `LSP: Enable Language Server Globally`, then select `rust-analyzer` in the list that pops up to enable the rust-analyzer LSP. The latter means that rust-analzyer is enabled by default in Rust projects.
 218
 219 If it worked, you should see "rust-analzyer, Line X, Column Y" on the left side of the bottom bar, and after waiting a bit, functionality like tooltips on hovering over variables should become available.
 220
 221 If you get an error saying `No such file or directory: 'rust-analyzer'`, see the <<language-server-binary,section on installing the language server binary>>.
 222
 223 == Usage
 224
 225 See https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/features.md[features.md].