fork/rust-analyzer

git clone https://git.julia.blue/fork/rust-analyzer

borsAuto merge of #12399 - Joehoel:patch-1, r=lnicola732eb9a167

2022-06-20
33.6 KiB855 linesraw
1= User Manual
2:toc: preamble
3:sectanchors:
4:page-layout: post
5:icons: font
6:source-highlighter: rouge
7:experimental:
8
9////
10IMPORTANT: the master copy of this document lives in the https://github.com/rust-analyzer/rust-analyzer repository
11////
12
13At its core, rust-analyzer is a *library* for semantic analysis of Rust code as it changes over time.
14This manual focuses on a specific usage of the library -- running it as part of a server that implements the
15https://microsoft.github.io/language-server-protocol/[Language Server Protocol] (LSP).
16The 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.
17
18[TIP]
19====
20[.lead]
21To improve this document, send a pull request: +
22https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc]
23
24The manual is written in https://asciidoc.org[AsciiDoc] and includes some extra files which are generated from the source code. Run `cargo test` and `cargo test -p xtask` to create these and then `asciidoctor manual.adoc` to create an HTML copy.
25====
26
27If you have questions about using rust-analyzer, please ask them in the https://users.rust-lang.org/c/ide/14["`IDEs and Editors`"] topic of Rust users forum.
28
29== Installation
30
31In theory, one should be able to just install the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>> and have it automatically work with any editor.
32We are not there yet, so some editor specific setup is required.
33
34Additionally, rust-analyzer needs the sources of the standard library.
35If the source code is not present, rust-analyzer will attempt to install it automatically.
36
37To add the sources manually, run the following command:
38
39```bash
40$ rustup component add rust-src
41```
42
43=== Toolchain
44
45Only the latest stable standard library source is officially supported for use with rust-analyzer.
46If you are using an older toolchain or have an override set, rust-analyzer may fail to understand the Rust source.
47You will either need to update your toolchain or use an older version of rust-analyzer that is compatible with your toolchain.
48
49If you are using an override in your project, you can still force rust-analyzer to use the stable toolchain via the environment variable `RUSTUP_TOOLCHAIN`.
50For example, with VS Code or coc-rust-analyzer:
51
52[source,json]
53----
54{ "rust-analyzer.server.extraEnv": { "RUSTUP_TOOLCHAIN": "stable" } }
55----
56
57=== VS Code
58
59This is the best supported editor at the moment.
60The rust-analyzer plugin for VS Code is maintained
61https://github.com/rust-analyzer/rust-analyzer/tree/master/editors/code[in tree].
62
63You can install the latest release of the plugin from
64https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer[the marketplace].
65
66Note that the plugin may cause conflicts with the
67https://marketplace.visualstudio.com/items?itemName=rust-lang.rust[official Rust plugin].
68It is recommended to disable the Rust plugin when using the rust-analyzer extension.
69
70By default, the plugin will prompt you to download the matching version of the server as well:
71
72image::https://user-images.githubusercontent.com/9021944/75067008-17502500-54ba-11ea-835a-f92aac50e866.png[]
73
74[NOTE]
75====
76To disable this notification put the following to `settings.json`
77
78[source,json]
79----
80{ "rust-analyzer.updates.askBeforeDownload": false }
81----
82====
83
84The server binary is stored in the extension install directory, which starts with `rust-lang.rust-analyzer-` and is located under:
85
86* Linux: `~/.vscode/extensions`
87* Linux (Remote, such as WSL): `~/.vscode-server/extensions`
88* macOS: `~/.vscode/extensions`
89* Windows: `%USERPROFILE%\.vscode\extensions`
90
91As an exception, on NixOS, the extension makes a copy of the server and stores it under `~/.config/Code/User/globalStorage/rust-lang.rust-analyzer`.
92
93Note that we only support the two most recent versions of VS Code.
94
95==== Updates
96
97The extension will be updated automatically as new versions become available.
98It will ask your permission to download the matching language server version binary if needed.
99
100===== Nightly
101
102We ship nightly releases for VS Code.
103To help us out by testing the newest code, you can enable pre-release versions in the Code extension page.
104
105==== Manual installation
106
107Alternatively, download a VSIX corresponding to your platform from the
108https://github.com/rust-analyzer/rust-analyzer/releases[releases] page.
109
110Install the extension with the `Extensions: Install from VSIX` command within VS Code, or from the command line via:
111[source]
112----
113$ code --install-extension /path/to/rust-analyzer.vsix
114----
115
116If you are running an unsupported platform, you can install `rust-analyzer-no-server.vsix` and compile or obtain a server binary.
117Copy the server anywhere, then add the path to your settings.json, for example:
118[source,json]
119----
120{ "rust-analyzer.server.path": "~/.local/bin/rust-analyzer-linux" }
121----
122
123==== Building From Source
124
125Both the server and the Code plugin can be installed from source:
126
127[source]
128----
129$ git clone https://github.com/rust-analyzer/rust-analyzer.git && cd rust-analyzer
130$ cargo xtask install
131----
132
133You'll need Cargo, nodejs (matching a supported version of VS Code) and npm for this.
134
135Note that installing via `xtask install` does not work for VS Code Remote, instead you'll need to install the `.vsix` manually.
136
137If you're not using Code, you can compile and install only the LSP server:
138
139[source]
140----
141$ cargo xtask install --server
142----
143
144=== rust-analyzer Language Server Binary
145
146Other editors generally require the `rust-analyzer` binary to be in `$PATH`.
147You can download pre-built binaries from the https://github.com/rust-analyzer/rust-analyzer/releases[releases] page.
148You will need to uncompress and rename the binary for your platform, e.g. from `rust-analyzer-aarch64-apple-darwin.gz` on Mac OS to `rust-analyzer`, make it executable, then move it into a directory in your `$PATH`.
149
150On Linux to install the `rust-analyzer` binary into `~/.local/bin`, these commands should work:
151
152[source,bash]
153----
154$ mkdir -p ~/.local/bin
155$ curl -L https://github.com/rust-analyzer/rust-analyzer/releases/latest/download/rust-analyzer-x86_64-unknown-linux-gnu.gz | gunzip -c - > ~/.local/bin/rust-analyzer
156$ chmod +x ~/.local/bin/rust-analyzer
157----
158
159Make sure that `~/.local/bin` is listed in the `$PATH` variable and use the appropriate URL if you're not on a `x86-64` system.
160
161You don't have to use `~/.local/bin`, any other path like `~/.cargo/bin` or `/usr/local/bin` will work just as well.
162
163Alternatively, you can install it from source using the command below.
164You'll need the latest stable version of the Rust toolchain.
165
166[source,bash]
167----
168$ git clone https://github.com/rust-analyzer/rust-analyzer.git && cd rust-analyzer
169$ cargo xtask install --server
170----
171
172If 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].
173On Unix, running the editor from a shell or changing the `.desktop` file to set the environment should help.
174
175==== `rustup`
176
177`rust-analyzer` is available in `rustup`, but only in the nightly toolchain:
178
179[source,bash]
180----
181$ rustup +nightly component add rust-analyzer-preview
182----
183
184However, in contrast to `component add clippy` or `component add rustfmt`, this does not actually place a `rust-analyzer` binary in `~/.cargo/bin`, see https://github.com/rust-lang/rustup/issues/2411[this issue].
185
186==== Arch Linux
187
188The `rust-analyzer` binary can be installed from the repos or AUR (Arch User Repository):
189
190- https://www.archlinux.org/packages/community/x86_64/rust-analyzer/[`rust-analyzer`] (built from latest tagged source)
191- https://aur.archlinux.org/packages/rust-analyzer-git[`rust-analyzer-git`] (latest Git version)
192
193Install it with pacman, for example:
194
195[source,bash]
196----
197$ pacman -S rust-analyzer
198----
199
200==== Gentoo Linux
201
202`rust-analyzer` is available in the GURU repository:
203
204- https://gitweb.gentoo.org/repo/proj/guru.git/tree/dev-util/rust-analyzer?id=9895cea62602cfe599bd48e0fb02127411ca6e81[`dev-util/rust-analyzer`] builds from source
205- https://gitweb.gentoo.org/repo/proj/guru.git/tree/dev-util/rust-analyzer-bin?id=9895cea62602cfe599bd48e0fb02127411ca6e81[`dev-util/rust-analyzer-bin`] installs an official binary release
206
207If not already, GURU must be enabled (e.g. using `app-eselect/eselect-repository`) and sync'd before running `emerge`:
208
209[source,bash]
210----
211$ eselect repository enable guru && emaint sync -r guru
212$ emerge rust-analyzer-bin
213----
214
215==== macOS
216
217The `rust-analyzer` binary can be installed via https://brew.sh/[Homebrew].
218
219[source,bash]
220----
221$ brew install rust-analyzer
222----
223
224=== Emacs
225
226Note this excellent https://robert.kra.hn/posts/2021-02-07_rust-with-emacs/[guide] from https://github.com/rksm[@rksm].
227
228Prerequisites: You have installed the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>.
229
230Emacs support is maintained as part of the https://github.com/emacs-lsp/lsp-mode[Emacs-LSP] package in https://github.com/emacs-lsp/lsp-mode/blob/master/lsp-rust.el[lsp-rust.el].
231
2321. Install the most recent version of `emacs-lsp` package by following the https://github.com/emacs-lsp/lsp-mode[Emacs-LSP instructions].
2332. Set `lsp-rust-server` to `'rust-analyzer`.
2343. Run `lsp` in a Rust buffer.
2354. (Optionally) bind commands like `lsp-rust-analyzer-join-lines`, `lsp-extend-selection` and `lsp-rust-analyzer-expand-macro` to keys.
236
237=== Vim/NeoVim
238
239Prerequisites: You have installed the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>.
240Not needed if the extension can install/update it on its own, coc-rust-analyzer is one example.
241
242There are several LSP client implementations for vim or neovim:
243
244==== coc-rust-analyzer
245
2461. Install coc.nvim by following the instructions at
247   https://github.com/neoclide/coc.nvim[coc.nvim]
248   (Node.js required)
2492. Run `:CocInstall coc-rust-analyzer` to install
250   https://github.com/fannheyward/coc-rust-analyzer[coc-rust-analyzer],
251   this extension implements _most_ of the features supported in the VSCode extension:
252   * automatically install and upgrade stable/nightly releases
253   * same configurations as VSCode extension, `rust-analyzer.server.path`, `rust-analyzer.cargo.features` etc.
254   * same commands too, `rust-analyzer.analyzerStatus`, `rust-analyzer.ssr` etc.
255   * inlay hints for variables and method chaining, _Neovim Only_
256
257Note: for code actions, use `coc-codeaction-cursor` and `coc-codeaction-selected`; `coc-codeaction` and `coc-codeaction-line` are unlikely to be useful.
258
259==== LanguageClient-neovim
260
2611. Install LanguageClient-neovim by following the instructions
262   https://github.com/autozimu/LanguageClient-neovim[here]
263   * The GitHub project wiki has extra tips on configuration
264
2652. Configure by adding this to your vim/neovim config file (replacing the existing Rust-specific line if it exists):
266+
267[source,vim]
268----
269let g:LanguageClient_serverCommands = {
270\ 'rust': ['rust-analyzer'],
271\ }
272----
273
274==== YouCompleteMe
275
276Install YouCompleteMe by following the instructions
277  https://github.com/ycm-core/YouCompleteMe#installation[here].
278
279rust-analyzer is the default in ycm, it should work out of the box.
280
281==== ALE
282
283To use the LSP server in https://github.com/dense-analysis/ale[ale]:
284
285[source,vim]
286----
287let g:ale_linters = {'rust': ['analyzer']}
288----
289
290==== nvim-lsp
291
292NeoVim 0.5 has built-in language server support.
293For a quick start configuration of rust-analyzer, use https://github.com/neovim/nvim-lspconfig#rust_analyzer[neovim/nvim-lspconfig].
294Once `neovim/nvim-lspconfig` is installed, use `+lua require'lspconfig'.rust_analyzer.setup({})+` in your `init.vim`.
295
296You can also pass LSP settings to the server:
297
298[source,vim]
299----
300lua << EOF
301local nvim_lsp = require'lspconfig'
302
303local on_attach = function(client)
304    require'completion'.on_attach(client)
305end
306
307nvim_lsp.rust_analyzer.setup({
308    on_attach=on_attach,
309    settings = {
310        ["rust-analyzer"] = {
311            assist = {
312                importGranularity = "module",
313                importPrefix = "self",
314            },
315            cargo = {
316                loadOutDirsFromCheck = true
317            },
318            procMacro = {
319                enable = true
320            },
321        }
322    }
323})
324EOF
325----
326
327See https://sharksforarms.dev/posts/neovim-rust/ for more tips on getting started.
328
329Check out https://github.com/simrat39/rust-tools.nvim for a batteries included rust-analyzer setup for neovim.
330
331==== vim-lsp
332
333vim-lsp is installed by following https://github.com/prabirshrestha/vim-lsp[the plugin instructions].
334It can be as simple as adding this line to your `.vimrc`:
335
336[source,vim]
337----
338Plug 'prabirshrestha/vim-lsp'
339----
340
341Next you need to register the `rust-analyzer` binary.
342If it is available in `$PATH`, you may want to add this to your `.vimrc`:
343
344[source,vim]
345----
346if executable('rust-analyzer')
347  au User lsp_setup call lsp#register_server({
348        \   'name': 'Rust Language Server',
349        \   'cmd': {server_info->['rust-analyzer']},
350        \   'whitelist': ['rust'],
351        \ })
352endif
353----
354
355There is no dedicated UI for the server configuration, so you would need to send any options as a value of the `initialization_options` field, as described in the <<_configuration,Configuration>> section.
356Here is an example of how to enable the proc-macro support:
357
358[source,vim]
359----
360if executable('rust-analyzer')
361  au User lsp_setup call lsp#register_server({
362        \   'name': 'Rust Language Server',
363        \   'cmd': {server_info->['rust-analyzer']},
364        \   'whitelist': ['rust'],
365        \   'initialization_options': {
366        \     'cargo': {
367        \       'loadOutDirsFromCheck': v:true,
368        \     },
369        \     'procMacro': {
370        \       'enable': v:true,
371        \     },
372        \   },
373        \ })
374endif
375----
376
377=== Sublime Text
378
379==== Sublime Text 4:
380* Follow the instructions in link:https://github.com/sublimelsp/LSP-rust-analyzer[LSP-rust-analyzer].
381
382NOTE: Install link:https://packagecontrol.io/packages/LSP-file-watcher-chokidar[LSP-file-watcher-chokidar] to enable file watching (`workspace/didChangeWatchedFiles`).
383
384==== Sublime Text 3:
385* Install the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>.
386* Install the link:https://packagecontrol.io/packages/LSP[LSP package].
387* From the command palette, run `LSP: Enable Language Server Globally` and select `rust-analyzer`.
388
389If it worked, you should see "rust-analyzer, Line X, Column Y" on the left side of the status bar, and after waiting a bit, functionalities like tooltips on hovering over variables should become available.
390
391If you get an error saying `No such file or directory: 'rust-analyzer'`, see the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>> section on installing the language server binary.
392
393=== GNOME Builder
394
395GNOME Builder 3.37.1 and newer has native `rust-analyzer` support.
396If the LSP binary is not available, GNOME Builder can install it when opening a Rust file.
397
398
399=== Eclipse IDE
400
401Support for Rust development in the Eclipse IDE is provided by link:https://github.com/eclipse/corrosion[Eclipse Corrosion].
402If available in PATH or in some standard location, `rust-analyzer` is detected and powers editing of Rust files without further configuration.
403If `rust-analyzer` is not detected, Corrosion will prompt you for configuration of your Rust toolchain and language server with a link to the __Window > Preferences > Rust__ preference page; from here a button allows to download and configure `rust-analyzer`, but you can also reference another installation.
404You'll need to close and reopen all .rs and Cargo files, or to restart the IDE, for this change to take effect.
405
406=== Kate Text Editor
407
408Support for the language server protocol is built into Kate through the LSP plugin, which is included by default.
409It is preconfigured to use rust-analyzer for Rust sources since Kate 21.12.
410
411Earlier versions allow you to use rust-analyzer through a simple settings change.
412In the LSP Client settings of Kate, copy the content of the third tab "default parameters" to the second tab "server configuration".
413Then in the configuration replace:
414[source,json]
415----
416        "rust": {
417            "command": ["rls"],
418            "rootIndicationFileNames": ["Cargo.lock", "Cargo.toml"],
419            "url": "https://github.com/rust-lang/rls",
420            "highlightingModeRegex": "^Rust$"
421        },
422----
423With
424[source,json]
425----
426        "rust": {
427            "command": ["rust-analyzer"],
428            "rootIndicationFileNames": ["Cargo.lock", "Cargo.toml"],
429            "url": "https://github.com/rust-analyzer/rust-analyzer",
430            "highlightingModeRegex": "^Rust$"
431        },
432----
433Then click on apply, and restart the LSP server for your rust project.
434
435=== juCi++
436
437https://gitlab.com/cppit/jucipp[juCi++] has built-in support for the language server protocol, and since version 1.7.0 offers installation of both Rust and rust-analyzer when opening a Rust file.
438
439=== Kakoune
440
441https://kakoune.org/[Kakoune] supports LSP with the help of https://github.com/kak-lsp/kak-lsp[`kak-lsp`].
442Follow the https://github.com/kak-lsp/kak-lsp#installation[instructions] to install `kak-lsp`.
443To configure `kak-lsp`, refer to the https://github.com/kak-lsp/kak-lsp#configuring-kak-lsp[configuration section] which is basically about copying the https://github.com/kak-lsp/kak-lsp/blob/master/kak-lsp.toml[configuration file] in the right place (latest versions should use `rust-analyzer` by default).
444
445Finally, you need to configure Kakoune to talk to `kak-lsp` (see https://github.com/kak-lsp/kak-lsp#usage[Usage section]).
446A basic configuration will only get you LSP but you can also activate inlay diagnostics and auto-formatting on save.
447The following might help you get all of this.
448
449[source,txt]
450----
451eval %sh{kak-lsp --kakoune -s $kak_session}  # Not needed if you load it with plug.kak.
452hook global WinSetOption filetype=rust %{
453    # Enable LSP
454    lsp-enable-window
455
456    # Auto-formatting on save
457    hook window BufWritePre .* lsp-formatting-sync
458
459    # Configure inlay hints (only on save)
460    hook window -group rust-inlay-hints BufWritePost .* rust-analyzer-inlay-hints
461    hook -once -always window WinSetOption filetype=.* %{
462        remove-hooks window rust-inlay-hints
463    }
464}
465----
466
467=== Helix
468
469https://docs.helix-editor.com/[Helix] supports LSP by default.
470However, it won't install `rust-analyzer` automatically.
471You can follow instructions for installing <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>.
472
473== Troubleshooting
474
475Start with looking at the rust-analyzer version.
476Try **Rust Analyzer: Show RA Version** in VS Code (using **Command Palette** feature typically activated by Ctrl+Shift+P) or `rust-analyzer --version` in the command line.
477If the date is more than a week ago, it's better to update rust-analyzer version.
478
479The next thing to check would be panic messages in rust-analyzer's log.
480Log messages are printed to stderr, in VS Code you can see then in the `Output > Rust Analyzer Language Server` tab of the panel.
481To see more logs, set the `RA_LOG=info` environment variable, this can be done either by setting the environment variable manually or by using `rust-analyzer.server.extraEnv`, note that both of these approaches require the server to be restarted.
482
483To fully capture LSP messages between the editor and the server, set `"rust-analyzer.trace.server": "verbose"` config and check
484`Output > Rust Analyzer Language Server Trace`.
485
486The root cause for many "`nothing works`" problems is that rust-analyzer fails to understand the project structure.
487To debug that, first note the `rust-analyzer` section in the status bar.
488If it has an error icon and red, that's the problem (hover will have somewhat helpful error message).
489**Rust Analyzer: Status** prints dependency information for the current file.
490Finally, `RA_LOG=project_model=debug` enables verbose logs during project loading.
491
492If rust-analyzer outright crashes, try running `rust-analyzer analysis-stats /path/to/project/directory/` on the command line.
493This command type checks the whole project in batch mode bypassing LSP machinery.
494
495When filing issues, it is useful (but not necessary) to try to minimize examples.
496An ideal bug reproduction looks like this:
497
498```bash
499$ git clone https://github.com/username/repo.git && cd repo && git switch --detach commit-hash
500$ rust-analyzer --version
501rust-analyzer dd12184e4 2021-05-08 dev
502$ rust-analyzer analysis-stats .
503💀 💀 💀
504```
505
506It is especially useful when the `repo` doesn't use external crates or the standard library.
507
508If you want to go as far as to modify the source code to debug the problem, be sure to take a look at the
509https://github.com/rust-analyzer/rust-analyzer/tree/master/docs/dev[dev docs]!
510
511== Configuration
512
513**Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/rust-analyzer/src/config.rs[config.rs]
514
515The <<_installation,Installation>> section contains details on configuration for some of the editors.
516In general `rust-analyzer` is configured via LSP messages, which means that it's up to the editor to decide on the exact format and location of configuration files.
517
518Some clients, such as <<vs-code,VS Code>> or <<coc-rust-analyzer,COC plugin in Vim>> provide `rust-analyzer` specific configuration UIs. Others may require you to know a bit more about the interaction with `rust-analyzer`.
519
520For the later category, it might help to know that the initial configuration is specified as a value of the `initializationOptions` field of the https://microsoft.github.io/language-server-protocol/specifications/specification-current/#initialize[`InitializeParams` message, in the LSP protocol].
521The spec says that the field type is `any?`, but `rust-analyzer` is looking for a JSON object that is constructed using settings from the list below.
522Name of the setting, ignoring the `rust-analyzer.` prefix, is used as a path, and value of the setting becomes the JSON property value.
523
524For example, a very common configuration is to enable proc-macro support, can be achieved by sending this JSON:
525
526[source,json]
527----
528{
529  "cargo": {
530    "loadOutDirsFromCheck": true,
531  },
532  "procMacro": {
533    "enable": true,
534  }
535}
536----
537
538Please consult your editor's documentation to learn more about how to configure https://microsoft.github.io/language-server-protocol/[LSP servers].
539
540To verify which configuration is actually used by `rust-analyzer`, set `RA_LOG` environment variable to `rust_analyzer=info` and look for config-related messages.
541Logs should show both the JSON that `rust-analyzer` sees as well as the updated config.
542
543This is the list of config options `rust-analyzer` supports:
544
545include::./generated_config.adoc[]
546
547== Non-Cargo Based Projects
548
549rust-analyzer does not require Cargo.
550However, if you use some other build system, you'll have to describe the structure of your project for rust-analyzer in the `rust-project.json` format:
551
552[source,TypeScript]
553----
554interface JsonProject {
555    /// Path to the directory with *source code* of
556    /// sysroot crates.
557    ///
558    /// It should point to the directory where std,
559    /// core, and friends can be found:
560    ///
561    /// https://github.com/rust-lang/rust/tree/master/library.
562    ///
563    /// If provided, rust-analyzer automatically adds
564    /// dependencies on sysroot crates. Conversely,
565    /// if you omit this path, you can specify sysroot
566    /// dependencies yourself and, for example, have
567    /// several different "sysroots" in one graph of
568    /// crates.
569    sysroot_src?: string;
570    /// The set of crates comprising the current
571    /// project. Must include all transitive
572    /// dependencies as well as sysroot crate (libstd,
573    /// libcore and such).
574    crates: Crate[];
575}
576
577interface Crate {
578    /// Optional crate name used for display purposes,
579    /// without affecting semantics. See the `deps`
580    /// key for semantically-significant crate names.
581    display_name?: string;
582    /// Path to the root module of the crate.
583    root_module: string;
584    /// Edition of the crate.
585    edition: "2015" | "2018" | "2021";
586    /// Dependencies
587    deps: Dep[];
588    /// Should this crate be treated as a member of
589    /// current "workspace".
590    ///
591    /// By default, inferred from the `root_module`
592    /// (members are the crates which reside inside
593    /// the directory opened in the editor).
594    ///
595    /// Set this to `false` for things like standard
596    /// library and 3rd party crates to enable
597    /// performance optimizations (rust-analyzer
598    /// assumes that non-member crates don't change).
599    is_workspace_member?: boolean;
600    /// Optionally specify the (super)set of `.rs`
601    /// files comprising this crate.
602    ///
603    /// By default, rust-analyzer assumes that only
604    /// files under `root_module.parent` can belong
605    /// to a crate. `include_dirs` are included
606    /// recursively, unless a subdirectory is in
607    /// `exclude_dirs`.
608    ///
609    /// Different crates can share the same `source`.
610    ///
611    /// If two crates share an `.rs` file in common,
612    /// they *must* have the same `source`.
613    /// rust-analyzer assumes that files from one
614    /// source can't refer to files in another source.
615    source?: {
616        include_dirs: string[],
617        exclude_dirs: string[],
618    },
619    /// The set of cfgs activated for a given crate, like
620    /// `["unix", "feature=\"foo\"", "feature=\"bar\""]`.
621    cfg: string[];
622    /// Target triple for this Crate.
623    ///
624    /// Used when running `rustc --print cfg`
625    /// to get target-specific cfgs.
626    target?: string;
627    /// Environment variables, used for
628    /// the `env!` macro
629    env: { [key: string]: string; },
630
631    /// Whether the crate is a proc-macro crate.
632    is_proc_macro: boolean;
633    /// For proc-macro crates, path to compiled
634    /// proc-macro (.so file).
635    proc_macro_dylib_path?: string;
636}
637
638interface Dep {
639    /// Index of a crate in the `crates` array.
640    crate: number,
641    /// Name as should appear in the (implicit)
642    /// `extern crate name` declaration.
643    name: string,
644}
645----
646
647This format is provisional and subject to change.
648Specifically, the `roots` setup will be different eventually.
649
650There are three ways to feed `rust-project.json` to rust-analyzer:
651
652* Place `rust-project.json` file at the root of the project, and rust-analyzer will discover it.
653* Specify `"rust-analyzer.linkedProjects": [ "path/to/rust-project.json" ]` in the settings (and make sure that your LSP client sends settings as a part of initialize request).
654* Specify `"rust-analyzer.linkedProjects": [ { "roots": [...], "crates": [...] }]` inline.
655
656Relative paths are interpreted relative to `rust-project.json` file location or (for inline JSON) relative to `rootUri`.
657
658See https://github.com/rust-analyzer/rust-project.json-example for a small example.
659
660You can set the `RA_LOG` environment variable to `rust_analyzer=info` to inspect how rust-analyzer handles config and project loading.
661
662Note that calls to `cargo check` are disabled when using `rust-project.json` by default, so compilation errors and warnings will no longer be sent to your LSP client. To enable these compilation errors you will need to specify explicitly what command rust-analyzer should run to perform the checks using the `checkOnSave.overrideCommand` configuration. As an example, the following configuration explicitly sets `cargo check` as the `checkOnSave` command.
663
664[source,json]
665----
666{ "rust-analyzer.checkOnSave.overrideCommand": ["cargo", "check", "--message-format=json"] }
667----
668
669The `checkOnSave.overrideCommand` requires the command specified to output json error messages for rust-analyzer to consume. The `--message-format=json` flag does this for `cargo check` so whichever command you use must also output errors in this format. See the <<Configuration>> section for more information.
670
671== Security
672
673At the moment, rust-analyzer assumes that all code is trusted.
674Here is a **non-exhaustive** list of ways to make rust-analyzer execute arbitrary code:
675
676* proc macros and build scripts are executed by default
677* `.cargo/config` can override `rustc` with an arbitrary executable
678* `rust-toolchain.toml` can override `rustc` with an arbitrary executable
679* VS Code plugin reads configuration from project directory, and that can be used to override paths to various executables, like `rustfmt` or `rust-analyzer` itself.
680* rust-analyzer's syntax trees library uses a lot of `unsafe` and hasn't been properly audited for memory safety.
681
682== Privacy
683
684The LSP server performs no network access in itself, but runs `cargo metadata` which will update or download the crate registry and the source code of the project dependencies.
685If enabled (the default), build scripts and procedural macros can do anything.
686
687The Code extension does not access the network.
688
689Any other editor plugins are not under the control of the `rust-analyzer` developers. For any privacy concerns, you should check with their respective developers.
690
691For `rust-analyzer` developers, `cargo xtask release` uses the GitHub API to put together the release notes.
692
693== Features
694
695include::./generated_features.adoc[]
696
697== Assists (Code Actions)
698
699Assists, or code actions, are small local refactorings, available in a particular context.
700They are usually triggered by a shortcut or by clicking a light bulb icon in the editor.
701Cursor position or selection is signified by `┃` character.
702
703include::./generated_assists.adoc[]
704
705== Diagnostics
706
707While most errors and warnings provided by rust-analyzer come from the `cargo check` integration, there's a growing number of diagnostics implemented using rust-analyzer's own analysis.
708Some of these diagnostics don't respect `\#[allow]` or `\#[deny]` attributes yet, but can be turned off using the `rust-analyzer.diagnostics.enable`, `rust-analyzer.diagnostics.enableExperimental` or `rust-analyzer.diagnostics.disabled` settings.
709
710include::./generated_diagnostic.adoc[]
711
712== Editor Features
713=== VS Code
714
715==== Color configurations
716
717It is possible to change the foreground/background color and font family/size of inlay hints.
718Just add this to your `settings.json`:
719
720[source,jsonc]
721----
722{
723  "editor.inlayHints.fontFamily": "Courier New",
724  "editor.inlayHints.fontSize": 11,
725
726  "workbench.colorCustomizations": {
727    // Name of the theme you are currently using
728    "[Default Dark+]": {
729      "editorInlayHint.foreground": "#868686f0",
730      "editorInlayHint.background": "#3d3d3d48",
731
732      // Overrides for specific kinds of inlay hints
733      "editorInlayHint.typeForeground": "#fdb6fdf0",
734      "editorInlayHint.parameterForeground": "#fdb6fdf0",
735    }
736  }
737}
738----
739
740==== Semantic style customizations
741
742You can customize the look of different semantic elements in the source code.
743For example, mutable bindings are underlined by default and you can override this behavior by adding the following section to your `settings.json`:
744
745[source,jsonc]
746----
747{
748  "editor.semanticTokenColorCustomizations": {
749    "rules": {
750      "*.mutable": {
751        "fontStyle": "", // underline is the default
752      },
753    }
754  },
755}
756----
757
758Most themes doesn't support styling unsafe operations differently yet. You can fix this by adding overrides for the rules `operator.unsafe`, `function.unsafe`, and `method.unsafe`:
759
760[source,jsonc]
761----
762{
763   "editor.semanticTokenColorCustomizations": {
764         "rules": {
765             "operator.unsafe": "#ff6600",
766             "function.unsafe": "#ff6600",
767             "method.unsafe": "#ff6600"
768         }
769    },
770}
771----
772
773In addition to the top-level rules you can specify overrides for specific themes. For example, if you wanted to use a darker text color on a specific light theme, you might write:
774
775[source,jsonc]
776----
777{
778   "editor.semanticTokenColorCustomizations": {
779         "rules": {
780             "operator.unsafe": "#ff6600"
781         },
782         "[Ayu Light]": {
783            "rules": {
784               "operator.unsafe": "#572300"
785            }
786         }
787    },
788}
789----
790
791Make sure you include the brackets around the theme name. For example, use `"[Ayu Light]"` to customize the theme Ayu Light.
792
793==== Special `when` clause context for keybindings.
794You may use `inRustProject` context to configure keybindings for rust projects only.
795For example:
796
797[source,json]
798----
799{
800  "key": "ctrl+alt+d",
801  "command": "rust-analyzer.openDocs",
802  "when": "inRustProject"
803}
804----
805More about `when` clause contexts https://code.visualstudio.com/docs/getstarted/keybindings#_when-clause-contexts[here].
806
807==== Setting runnable environment variables
808You can use "rust-analyzer.runnableEnv" setting to define runnable environment-specific substitution variables.
809The simplest way for all runnables in a bunch:
810```jsonc
811"rust-analyzer.runnableEnv": {
812    "RUN_SLOW_TESTS": "1"
813}
814```
815
816Or it is possible to specify vars more granularly:
817```jsonc
818"rust-analyzer.runnableEnv": [
819    {
820        // "mask": null, // null mask means that this rule will be applied for all runnables
821        env: {
822             "APP_ID": "1",
823             "APP_DATA": "asdf"
824        }
825    },
826    {
827        "mask": "test_name",
828        "env": {
829             "APP_ID": "2", // overwrites only APP_ID
830        }
831    }
832]
833```
834
835You can use any valid regular expression as a mask.
836Also note that a full runnable name is something like *run bin_or_example_name*, *test some::mod::test_name* or *test-mod some::mod*, so it is possible to distinguish binaries, single tests, and test modules with this masks: `"^run"`, `"^test "` (the trailing space matters!), and `"^test-mod"` respectively.
837
838==== Compiler feedback from external commands
839
840Instead of relying on the built-in `cargo check`, you can configure Code to run a command in the background and use the `$rustc-watch` problem matcher to generate inline error markers from its output.
841
842To do this you need to create a new https://code.visualstudio.com/docs/editor/tasks[VS Code Task] and set `rust-analyzer.checkOnSave.enable: false` in preferences.
843
844For example, if you want to run https://crates.io/crates/cargo-watch[`cargo watch`] instead, you might add the following to `.vscode/tasks.json`:
845
846```json
847{
848    "label": "Watch",
849    "group": "build",
850    "type": "shell",
851    "command": "cargo watch",
852    "problemMatcher": "$rustc-watch",
853    "isBackground": true
854}
855```