Skip to content

Commit 2ab6fbc

Browse files
authored
Add Neovim configuration information (#1545)
* Add Neovim configuration information The JSON provided for VSCode works with coc and nlsp-settings. This is verified by https://github.com/fannheyward/coc-rust-analyzer/blob/9d8bdb9290e2a9644367594a1ceed0288506efcd/README.md for coc, and feeding the JSON in to this schema https://github.com/tamago324/nlsp-settings.nvim/blob/215b537cfb3fad7c9c2e352fe47a10698b0993e0/schemas/_generated/rust_analyzer.json for validating nlsp-settings. * Make the steps clear First open a Rust buffer Then update RA settings If you don't open a buffer first then nothing will happen. This is because the plugin makes a raw LSP RPC, so RA must be attached. * Use separate sections for VSCode and Nvim * Add a short section on the VSCode tasks.
1 parent 41a96ab commit 2ab6fbc

File tree

2 files changed

+32
-4
lines changed

2 files changed

+32
-4
lines changed

Diff for: README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ rustdocs][rustdocs].
4343
To build a local static HTML site, install [`mdbook`](https://github.com/rust-lang/mdBook) with:
4444

4545
```
46-
> cargo install mdbook mdbook-linkcheck mdbook-toc
46+
> cargo install mdbook mdbook-linkcheck mdbook-toc mdbook-mermaid
4747
```
4848

4949
and execute the following command in the root of the repository:

Diff for: src/building/suggested.md

+31-3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ You can also install the hook as a step of running `./x.py setup`!
1919

2020
## Configuring `rust-analyzer` for `rustc`
2121

22+
### Visual Studio Code
23+
2224
`rust-analyzer` can help you check and format your code whenever you save
2325
a file. By default, `rust-analyzer` runs the `cargo check` and `rustfmt`
2426
commands, but you can override these commands to use more adapted versions
@@ -31,9 +33,6 @@ If you have enough free disk space and you would like to be able to run `x.py` c
3133
rust-analyzer runs in the background, you can also add `--build-dir build-rust-analyzer` to the
3234
`overrideCommand` to avoid x.py locking.
3335

34-
If you're running `coc.nvim`, you can use `:CocLocalConfig` to create a
35-
`.vim/coc-settings.json` and copy the settings from [this file](https://github.com/rust-lang/rust/blob/master/src/etc/vscode_settings.json).
36-
3736
If running `./x.py check` on save is inconvenient, in VS Code you can use a [Build
3837
Task] instead:
3938

@@ -56,6 +55,35 @@ Task] instead:
5655

5756
[Build Task]: https://code.visualstudio.com/docs/editor/tasks
5857

58+
59+
### Neovim
60+
61+
For Neovim users there are several options for configuring for rustc. The easiest way is by using
62+
[neoconf.nvim](https://github.com/folke/neoconf.nvim/), which allows for project-local
63+
configuration files with the native LSP. The steps for how to use it are below. Note that requires
64+
Rust-Analyzer to already be configured with Neovim. Steps for this can be
65+
[found here](https://rust-analyzer.github.io/manual.html#nvim-lsp).
66+
67+
1. First install the plugin. This can be done by following the steps in the README.
68+
2. Run `x.py setup`, which will have a prompt for it to create a `.vscode/settings.json` file.
69+
`neoconf` is able to read and update Rust-Analyzer settings automatically when the project is
70+
opened when this file is detected.
71+
72+
If you're running `coc.nvim`, you can use `:CocLocalConfig` to create a
73+
`.vim/coc-settings.json` and copy the settings from
74+
[this file](https://github.com/rust-lang/rust/blob/master/src/etc/vscode_settings.json).
75+
76+
Another way is without a plugin, and creating your own logic in your configuration. To do this you
77+
must translate the JSON to Lua yourself. The translation is 1:1 and fairly straight-forward. It
78+
must be put in the `["rust-analyzer"]` key of the setup table, which is
79+
[shown here](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#rust_analyzer)
80+
81+
If you would like to use the build task that is described above, you may either make your own
82+
command in your config, or you can install a plugin such as
83+
[overseer.nvim](https://github.com/stevearc/overseer.nvim) that can [read VSCode's `task.json`
84+
files](https://github.com/stevearc/overseer.nvim/blob/master/doc/guides.md#vs-code-tasks), and
85+
follow the same instructions as above.
86+
5987
## Check, check, and check again
6088

6189
When doing simple refactorings, it can be useful to run `./x.py check`

0 commit comments

Comments
 (0)