Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ruff server: Write a setup guide for Neovim #10987

Merged
merged 9 commits into from
Apr 18, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
NeoVim -> Neovim
snowsignal committed Apr 17, 2024

Verified

This commit was signed with the committer’s verified signature. The key has expired.
renovate-bot Mend Renovate
commit 5ed61cce6deda319c9c59af6abb4b31df2845961
2 changes: 1 addition & 1 deletion crates/ruff_server/README.md
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ files in your editor's workspace, and will refresh its in-memory configuration w
We have specific setup instructions depending on your editor. If you don't see your editor on this list and would like a setup guide, please open an issue.

- Visual Studio Code: install the [Ruff extension from the VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff). The language server used by the extension will be, by default, the one in your actively-installed `ruff` binary. If you don't have `ruff` installed and haven't provided a path to the extension, it comes with a bundled `ruff` version that it will use instead. Since the new Ruff language server has not yet been stabilized, you will need to use the pre-release version of the extension and enable the `Experimental Server` setting.
snowsignal marked this conversation as resolved.
Show resolved Hide resolved
- NeoVim: see the [NeoVim setup guide](docs/setup/NEOVIM.md).
- Neovim: see the [Neovim setup guide](docs/setup/NEOVIM.md).

### Contributing

4 changes: 2 additions & 2 deletions crates/ruff_server/docs/setup/NEOVIM.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## NeoVim Setup Guide for `ruff server`
## Neovim Setup Guide for `ruff server`

### Using `nvim-lspconfig`

@@ -13,7 +13,7 @@ require'lspconfig'.ruff.setup{}
See [`nvim-lspconfig`'s server configuration guide](https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#ruff) for more details
on how to configure the server from there.

**Important note**: If you have the older language server (`ruff-lsp`) configured in NeoVim, make sure to disable it to prevent any conflicts.
**Important note**: If you have the older language server (`ruff-lsp`) configured in Neovim, make sure to disable it to prevent any conflicts.

#### Tips