Configuring Ruff #6669
Replies: 22 comments 20 replies
-
|
Excited to have learned about Ruff today; going to have to play with it on some projects. :) |
Beta Was this translation helpful? Give feedback.
-
|
Send me feature requests :) |
Beta Was this translation helpful? Give feedback.
-
|
Ruff is absolutely magnificent, I think I'd probably use Zed as my daily driver if Ruff-lsp support for linting was available. |
Beta Was this translation helpful? Give feedback.
-
|
Is it possible to use it in addition to Black? It seems that it's not currently possible to use several formatter at the same time. |
Beta Was this translation helpful? Give feedback.
-
|
Isn't this implementation better?
Otherwise, how do I use ruff as a linter? Are there any configs for LSP maybe? |
Beta Was this translation helpful? Give feedback.
-
|
Would like to have it working in parallel with Black.
|
Beta Was this translation helpful? Give feedback.
-
|
Here's how I got ruff fix and format working: "language_overrides": {
"Python": {
"format_on_save": "on",
"formatter": {
"external": {
"command": "bash",
"arguments": [
"-c",
"ruff check --exit-zero --fix --unsafe-fixes --stdin-filename {buffer_path} | ruff format --stdin-filename {buffer_path}"
]
}
}
}
} |
Beta Was this translation helpful? Give feedback.
-
|
Sort imports and format with ruff {
"language_overrides": {
"Python": {
"format_on_save": "on",
"formatter": {
"external": {
"command": "bash",
"arguments": [
"-c",
"ruff check --select=I --fix --stdin-filename {buffer_path} | ruff format --stdin-filename {buffer_path}"
]
}
}
}
}
} |
Beta Was this translation helpful? Give feedback.
-
|
Configured the formatter as mentioned "language_overrides": {
"Python": {
"format_on_save": "off",
"formatter": {
"external": {
"command": "bash",
"arguments": ["-c", "ruff format --exit-zero --fix --stdin-filename {buffer_path}"]
}
}
},But the content of my file is being replaced by the output of ruff. |
Beta Was this translation helpful? Give feedback.
-
|
I think you should omit |
Beta Was this translation helpful? Give feedback.
-
|
I follow with current configure spec and use this: "languages": {
"Python": {
"format_on_save": {
"external": {
"command": "ruff",
"arguments": [
"format",
"--stdin-filename",
"{buffer_path}"
]
}
}
}
}, |
Beta Was this translation helpful? Give feedback.
-
|
this worked for formatting "languages": {
"Python": {
"formatter": {
"external": {
"command": "ruff",
"arguments": ["format", "-"]
}
},
"format_on_save": "on"
}
} |
Beta Was this translation helpful? Give feedback.
-
|
this worked for me |
Beta Was this translation helpful? Give feedback.
-
|
How do I get Ruff errors / linting integrated? Will that require an extension? If so, has work started on one? Got a URL for the project (or will it be done 1st party)? |
Beta Was this translation helpful? Give feedback.
-
|
It's here |
Beta Was this translation helpful? Give feedback.
-
|
hello! for example, if I do: Thanks! PS: This is my settings.json file |
Beta Was this translation helpful? Give feedback.
-
|
Hi, I'm new to this whole zed thing and its setup. After reading some of the comments here, I stopped understanding what was going on. Ruff has two versions of the lsp server, the one written in Python — I'm sorry for my English, it's not my native language. |
Beta Was this translation helpful? Give feedback.
-
|
We need Ruff LSP + Pyright support |
Beta Was this translation helpful? Give feedback.
-
|
I wrote a custom #!/bin/bash
# Usage: ruff-combi file.py < file.py
set -eu
ruff --quiet check --exit-zero --fix --stdin-filename "$1" - \
| ruff format --stdin-filename "$1" -Used like this: {
"languages": {
"Python": {
"formatter": {
"external": {
"command": "ruff-combi",
"arguments": ["{buffer_path}"]
...This combines import sorting and formatting. I'd prefer a pylsp base solution with python-lsp-ruff. See #7296 |
Beta Was this translation helpful? Give feedback.
-
|
I agree , Ruff + PYright LSP gonna be good |
Beta Was this translation helpful? Give feedback.
-
|
You don't need a custom script if you use a shell as the command, {
"languages": {
"Python": {
"formatter": {
"external": {
"command": "zsh",
"arguments": ["-c", "ruff check --select I --fix - | ruff format -"]
}
}
}
}
} |
Beta Was this translation helpful? Give feedback.
-
|
Why don't you need |
Beta Was this translation helpful? Give feedback.
-
|
When using an external command, the buffer is passed into the program on stdin. |
Beta Was this translation helpful? Give feedback.
-
|
I'm a bit confused now since the release of the 0.146 I would like to sort import too when I save my file, how can I setup this with the new Zed language settings? |
Beta Was this translation helpful? Give feedback.
-
|
at least regarding the imports sorting, you need to call the linter with the rule set Edit: not sure if this approach is compatible with v0.146, but I'd expect so. |
Beta Was this translation helpful? Give feedback.
-
|
|
Beta Was this translation helpful? Give feedback.
-
|
Using 0.146.0 on Linux. First, you need to install zed ruff extension before using ruff language server. ruff extension does not sort imports. |
Beta Was this translation helpful? Give feedback.
-
|
We've added a setup guide for using the Ruff extension in Zed at https://docs.astral.sh/ruff/editors/setup/#zed. It includes example configuration:
|
Beta Was this translation helpful? Give feedback.
-
|
Amazing, thanks @dhruvmanila. I still can't get pyright to sod off and mind its own business though 😭 |
Beta Was this translation helpful? Give feedback.
-
|
My per-project configuration: $ cat pyrightconfig.json
{
"venvPath": "dev",
"venv": "venv-py3.6",
"pythonVersion": "3.6",
"typeCheckingMode": "off"
} |
Beta Was this translation helpful? Give feedback.
-
|
@bersace really useful, thanks for sharing! I spent a good 15 minutes, trying to figure out why pyright lingers and ruff is not complaining. |
Beta Was this translation helpful? Give feedback.
-
|
👋 I'm trying to configure the Ruff extension, but the language server doesn't seem to work. It is not available in the Any help would be appreciated. Thank you 🙏 |
Beta Was this translation helpful? Give feedback.
-
|
I have the same issue (on Linux); I use the standard configuration above but none of the LSP features work. Formatting doesn't happen whether on save or by manually running the "format" command. I also don't get any diagnostics. Formatting works fine if I configure Ruff as an external formatter instead of using the LSP server. I did some investigating by setting The only trace I'm seeing in Zed is this: This is the recording when running the "organize imports" action, but note that no organizing is actually happening: And this is the recording when running the format command in Zed, again with no formatting actually happening: |
Beta Was this translation helpful? Give feedback.
-
|
I should mention that this is with Zed 0.151.1 and Ruff 0.6.4, installed globally with pipx. |
Beta Was this translation helpful? Give feedback.
-
|
I'm using the same settings, which seem to work fine for me: zed 0.151.1-1, ruff 0.6.4 The only difference i see is pyright coming before ruff. Edit: This is on Linux with ruff and pyright being available in the $PATH, but also have the ruff extension installed in zed. |
Beta Was this translation helpful? Give feedback.
-
|
@dhruvmanila My evaluation that this configuration doesn't work is based on
|
Beta Was this translation helpful? Give feedback.
-
|
Okay, I finally discovered what the problem is. It is this issue: astral-sh/ruff#12539. In short, the Ruff server doesn't check files that don't have This is really unintuitive and essentially means that you can't use the Ruff server for extension-less scripts unless you change the |
Beta Was this translation helpful? Give feedback.
-
|
If you enable For anyone else who wants to retain this while still getting ruff's formatting, here's the latest config to do this (basically @davidagold 's but without {
"languages": {
"Python": {
"language_servers": ["pyright"], // Probably optional, but just to be explicit
"format_on_save": "on",
"formatter": [
{
"code_actions": {
"source.organizeImports.ruff": true,
"source.fixAll.ruff": true
}
},
{
"language_server": {
"name": "ruff"
}
}
]
}
}
}Note that this of course requires also installing the ruff extension in the extensions panel. |
Beta Was this translation helpful? Give feedback.
-
|
Zed version: 0.151.2 "languages": {
"Python": {
"language_servers": ["pyright", "ruff"],
"format_on_save": "on",
"formatter": [
{
"code_actions": {
"source.organizeImports.ruff": true
//"source.fixAll.ruff": false
}
},
{
"language_server": {
"name": "ruff"
}
}
]
}
},
"lsp": {
"pyright": {
"settings": {
"python.analysis": {
"diagnosticMode": "workspace",
"typeCheckingMode": "strict"
},
"python": {
"pythonPath": ".venv/bin/python"
}
}
},
"ruff": {
"initialization_options": {
"settings": {
// Ruff server settings goes here
"lineLength": 80,
"lint": {
"extendSelect": ["I"]
}
}
}
}
}However, when I brew installed ruff it all started to work! |
Beta Was this translation helpful? Give feedback.
-
|
That is how it works for most linters
…On Tue, Sep 10, 2024, 11:08 AM Jan Larres ***@***.***> wrote:
Okay, I finally discovered what the problem is. It is this issue:
astral-sh/ruff#12539 <astral-sh/ruff#12539>. In
short, the Ruff server doesn't check files that don't have .py extension,
and I was editing scripts without an extension the entire time. The same
problem happens in VS Code.
This is really unintuitive and essentially means that you can't use the
Ruff server for extension-less scripts unless you change the include
setting to include all files, which is obviously not desirable.
—
Reply to this email directly, view it on GitHub
<#6669 (reply in thread)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AADGOFWAT5RJLSIVCDLH77DZVZWDRAVCNFSM6AAAAABCOLZQQKVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTANJZG43TMNA>
.
You are receiving this because you commented.Message ID:
***@***.***>
|
Beta Was this translation helpful? Give feedback.
-
|
My current setup uses a poetry environment with ruff installed as a dev dependency and ruff config in Using Zed is it possible to use the installed version of ruff within my active poetry environment to format code on save and respect the config in |
Beta Was this translation helpful? Give feedback.
and others
-
If you're interested in using Ruff's autofix functionality within Zed, you can add it as an external formatter via the following settings snippet:
{ "language_overrides": { "Python": { "format_on_save": { "external": { "command": "ruff", "arguments": [ "check", "--exit-zero", "--fix", "--stdin-filename", "{buffer_path}", "-" ] } } } } }Here's a clip of it in action from Twitter. Thanks @JosephTLyons for encouraging this tip.
Beta Was this translation helpful? Give feedback.
All reactions