Skip to content

Commit 74afdfc

Browse files
authored
Add link to vscode settings in Rust repo (#1591)
1 parent d0ee17f commit 74afdfc

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/building/suggested.md

+6
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,17 @@ of these tools when hacking on `rustc`. For example, `x.py setup` will prompt
2828
you to create a `.vscode/settings.json` file which will configure Visual Studio code.
2929
This will ask `rust-analyzer` to use `./x.py check` to check the sources, and the
3030
stage 0 rustfmt to format them.
31+
The recommended `rust-analyzer` settings live at [`src/etc/vscode_settings.json`].
3132

3233
If you have enough free disk space and you would like to be able to run `x.py` commands while
3334
rust-analyzer runs in the background, you can also add `--build-dir build-rust-analyzer` to the
3435
`overrideCommand` to avoid x.py locking.
3536

37+
If you're running `coc.nvim`, you can use `:CocLocalConfig` to create a
38+
`.vim/coc-settings.json` and copy the settings from [`src/etc/vscode_settings.json`].
39+
40+
[`src/etc/vscode_settings.json`]: https://github.com/rust-lang/rust/blob/master/src/etc/vscode_settings.json
41+
3642
If running `./x.py check` on save is inconvenient, in VS Code you can use a [Build
3743
Task] instead:
3844

0 commit comments

Comments
 (0)