
## Summary Introduces a migration guide from `ruff-lsp` to `ruff server` and makes small updates to the `README.md`.
2 KiB
Helix Setup Guide for ruff server
First, open the language configuration file for Helix. On Linux and macOS, this will be at ~/.config/helix/languages.toml
,
and on Windows this will be at %AppData%\helix\languages.toml
.
Add the language server by adding:
[language-server.ruff]
command = "ruff"
args = ["server", "--preview"]
Then, you'll register the language server as the one to use with Python.
If you don't already have a language server registered to use with Python, add this to languages.toml
:
[[language]]
name = "python"
language-servers = ["ruff"]
Otherwise, if you already have language-servers
defined, you can simply add "ruff"
to the list. For example,
if you already have pylsp
as a language server, you can modify the language entry as follows:
[[language]]
name = "python"
language-servers = ["ruff", "pylsp"]
!NOTE
Multiple language servers for a single language are only supported in Helix version
23.10
and later.
Once you've set up the server, you should see diagnostics in your Python files. Code actions and other LSP features should also be available.
This screenshot is using
select=["ALL]"
for demonstration purposes.
If you want to, as an example, turn on auto-formatting, add auto-format = true
:
[[language]]
name = "python"
language-servers = ["ruff", "pylsp"]
auto-format = true
See the Helix documentation for more settings you can use here.
You can pass settings into ruff server
using [language-server.ruff.config.settings]
. For example:
[language-server.ruff.config.settings]
line-length = 80
[language-server.ruff.config.settings.lint]
select = ["E4", "E7"]
preview = false
[language-server.ruff.config.settings.format]
preview = true