pyright + ruff

[predmijat]

Is there a way to use ruff with pyright? I read that ruff should probably be used with an LSP, but I've only found examples for pylsp, not pyright.

[alphastrata]

just change the args from the pylsp to ruff & make sure it's installed on path (both ruff and ruff-lsp)

[vazw]

Hey now that Helix support multi LSP. my setting are working well with Pyright + ruff as LSP and black + ruff as formatter

[language-server.pyright]
command = "pyright-langserver"
args = ["--stdio"]

[language-server.pyright.config]
python.analysis.venvPath = "."
python.analysis.venv = ".venv"
python.analysis.lint = true
python.analysis.inlayHint.enable = true
python.analysis.autoSearchPaths = true
python.analysis.diagnosticMode = "workspace"
python.analysis.useLibraryCodeForType = true
python.analysis.logLevel = "Error"
python.analysis.typeCheckingMode = "off"
python.analysis.autoImoprtCompletion = true
python.analysis.reportOptionalSubscript = false
python.analysis.reportOptionalMemberAccess = false


[language-server.ruff]
command = "ruff"
args = ["server", "-q", "--preview"] 


[[language]]
name = "python"
scope = "source.python"
injection-regex = "python"
file-types = ["py", "pyi", "py3", "pyw", "ptl", "rpy", "cpy", "ipy", "pyt", { glob = ".python_history" }, { glob = ".pythonstartup" }, { glob = ".pythonrc" }, { glob = "SConstruct" }, { glob = "SConscript" }]
shebangs = ["python"]
roots = ["pyproject.toml", "setup.py", "poetry.lock", "pyrightconfig.json", "requirements.txt", ".venv/"]
comment-token = "#"
language-servers = [ {name = "pyright", except-features=["diagnostics"]}, "ruff" ]
indent = { tab-width = 4, unit = "    " }
auto-format = true
formatter =  { command = "bash", args = ["-c", "ruff format --line-length 80 -q . && black --line-length 80 -q -"] }

[lemontheme]

Simply out of curiosity: what's the reason for using both Ruff and Black for formatting? Doesn't Ruff's formatter more or less mirror Black already?

Also, check out https://github.com/DetachHead/basedpyright if you haven't already. It's like pyright but without the arbitrary restrictions on features that for some reason belong in Pylance instead.

[vazw]

ruff format just deleted all my code while formatting with helix I think it doesn't support stdout format yet

[lemontheme]

Sure it does! Just need to add a - to the args list, which pipes the stdin in.

formatter = { command = "ruff", args = ["format", "-" ] }

[vazw]

oh that it's 😆🙏

[schlich]

a lot of people are gonna run into this problem, i think it's worth adding to the wiki

[j-dominguez9]

This is my current setup that works nicely, in case anybody wants to see a full example:

[[language]]
name = "python"
language-id = "python"
roots = ["pyproject.toml", "setup.py", "poetry.lock", ".git", ".jj", ".venv/"]
language-servers = ["ruff", "pyright"]
auto-format = true
# formatter = { command = "black", args = ["--quiet", "-", "--line-length=80"] }
formatter = { command = "ruff", args = ["format", "-" ] }
file-types = ["py", "ipynb"]
comment-token = "#"
shebangs = ["python"]

[language-server.pyright]
command = "pyright-langserver"
args = ["--stdio"]

[language-server.ruff]
command = "ruff"
args = ["server"]
environment = { "RUFF_TRACE" = "messages" }

[language-server.ruff.config.settings]
lineLength = 80
logLevel = "debug"

[language-server.ruff.config.settings.lint]
select = ["E", "F", "W", "B", "I", "RUF", "N", "LOG", "ERA", "W", "D", "UP", "ANN", "ASYNC", "S", "RET", "TCH", "ARG", "PTH", "DOC"]
preview = true

[language-server.ruff.config.settings.format]
preview = true
quote-style = "double"
docstring-code-format = true
indent-style = "space"

[j-dominguez9]

Actually, i just figured it out (at least, for my use case). I'm using uv intstead of poetry, which lets you install system-wide tools. So I install ruff and basedpyright as a tool and then in the languages.toml file instead of formatter = { command = "ruff", args = ["format", "-" ] } , I just do formatter = { command = "uvx ruff", args = ["format", "-" ] }. And the equivalent for basedpyright command. This way it runs it inside the venv environment.

[j-dominguez9]

nvm, I lied, that didn't fully work, but this did:

[[language]]
name = "python"
language-id = "python"
roots = ["pyproject.toml", ".git", ".jj", ".venv/"]
language-servers = ["ruff", "basedpyright"]
auto-format = true
formatter = { command = "uvx", args = ["ruff","format", "-" ] }
file-types = ["py", "ipynb"]
comment-token = "#"
shebangs = ["python"]

[language-server.basedpyright]
command = "uv"
args = ["run", "basedpyright-langserver", "--stdio"]

[language-server.basedpyright.config]


[language-server.ruff]
command = "uvx"
args = ["ruff","server"]
environment = { "RUFF_TRACE" = "messages" }

[eliasbenaddou]

nice one! Any chance of including auto import sorting within this on save?

[j-dominguez9]

I haven't figured that out and it does bother me, as well. Im pretty sure I have it specified in my "ruff" config, but it doesn't do it. I've had to do :sh uvx ruff check --fix or :sh uvx isort while inside helix. Let me know if you come up with something

[eliasbenaddou]

This worked!
formatter = { command = "uvx", args = ["sh", "-c", "ruff check --fix - | ruff format -"] }

[nrbnlulu]

How did you guys installed pyright / ruff lsp's?

[nrbnlulu]

ended up using pipx ubuntu has no package for ruff lsp

[j-dominguez9]

You're probably better off using just ruff, as it has the lsp server + linter and formatter, as noted in their readme:

Note

As of Ruff v0.4.5, Ruff ships with a built-in language server written in Rust: ⚡ ruff server ⚡

ruff server supports the same feature set as ruff-lsp, but with superior performance and no installation required. ruff server was marked as stable in Ruff v0.5.3

And you can install it with a curl command.

[schlich]

ruff does not do type checking like pyright does. while you can use ruff server instead of ruff-lsp it is not a replacement for pyright

[nrbnlulu]

ruff does not do type checking like pyright does. while you can use ruff server instead of ruff-lsp it is not a replacement for pyright

who said it was? 👀

[schlich]

for sure nobody, just clarifying for folks at home 😉