ruff-lsp is deprecated; please upgrade to the native language server (ruff server)

[dhruvmanila]

Hey everyone,

ruff-lsp is marked as deprecated with the upcoming Ruff release, it will be archived with the release of Ruff 0.11. We suggest everyone to upgrade to the native server (⚡ ruff server ⚡).

ruff server supports the same feature set as ruff-lsp, but with superior performance and no installation required. It was first released in Ruff v0.3.5, announced as beta in Ruff 0.4.5 and marked as stable in Ruff 0.5.3.

Refer to the setup guide on how to set up the native language server for multiple editors and the migration guide on how to migrate the deprecated settings.

If you're unable to upgrade to the native server, feel free to comment on this discussion so that we can help.

[ilCatania]

I have this in my VScode settings.json, how do I convert it please?
Thank you

"ruff.lint.args": [ "--unfixable=F841,T201"]

I tried ctrl+space, copilot, migration guide, but couldn't figure it out. Sorry!

[dhruvmanila]

Currently, we support limited subset of the settings that can be set directly in the editor, they're mentioned on this page: https://docs.astral.sh/ruff/editors/settings/.

For your specific case, you could either set it on a per-project basis in a local pyproject.toml / ruff.toml file or set it globally using ruff.configuration setting i.e., create a file that has the common options for all the project (e.g., in ~/.config/ruff.toml) and provide the path as in "ruff.configuration": "~/.config/ruff.toml".

[ilCatania]

Ok, however my use case is slightly subtle: I want to set some settings only for the editor (VScode) but not in pyproject.toml nor in the global config, because I don't want the editor to remove unused variables or print statements when my users write exploratory code, but I do want them gone when they commit and trigger the pre commit hook.

So I guess I could put a ruff.toml in my project's .vscode/ directory, but then I am not sure how to specify a relative path in the settings.json sitting alongside it? My users might be checking out my project in an arbitrary directory...

[dhruvmanila]

I see, so it's more like project specific settings for the everyone working on it but only in an editor context.

So I guess I could put a ruff.toml in my project's .vscode/ directory, but then I am not sure how to specify a relative path in the settings.json sitting alongside it? My users might be checking out my project in an arbitrary directory...

I'd recommend doing this and providing the path using VS Code variables like:

{
	"ruff.configuration": "${workspaceFolder}/.vscode/ruff.toml"
}

[ilCatania]

Of course! That will work! Thank you

[kleynjan]

I am currently using ruff only by way of the official Ruff extension in VScode and fully configured in settings.json. I have looked at the ruff extension docs and the setup and migration guides but despite that it's not exactly clear to me how I should move to the 'native' ruff server and how I should migrate the settings I've built up over the years. In general, I'd appreciate it if we could have some stability and predictability in configuring Python extensions.

While I'm waiting for this mist to clear: is there a way to suppress the ruff-lsp deprecation warning?

[kleynjan]

For example, the docs say to add "ruff.nativeServer": "on" to the config.
The VScode settings editor reacts to this with the warning: "Deprecated: This setting has been deprecated with the deprecation of ruff-lsp. It was mainly used to provide a way to switch between the native language server and ruff-lsp during the transition period."

[MichaReiser]

Hmm, yeah, the warning about the setting isn't great. We should probably omit the warning if it is set to on.

[dhruvmanila]

Thanks for the feedback. I discussed this with Micha on Discord and we think it might be best to un-deprecate ruff.nativeServer specifically as it might still be useful during the deprecation period. Later, when ruff-lsp is actually removed, this setting will then be deprecated. Sorry for the churn.

[ksylvan]

Okay, here's a puzzle that I don't see how to fix with the new settings.

I have the following in VSCode settings:

"ruff.lint.args": [
            "--extend-select=DJ001,INP001,ANN201",
            "--config",
             "lint.flake8-annotations.ignore-fully-untyped=false"
]

because I want to see squiggles in VSCode for the flake8 untyped functions, and, at the same time, I have this in my ruff.toml because I want the CLI (and CI scripts) to pass without errors.

[lint.flake8-annotations]
ignore-fully-untyped = true 

How do I fix this?

[ksylvan]

I guess the best way is to add the arguments --config lint.flake8-annotations.ignore-fully-untyped=false when running the ruff cli (or in CI scripts)

[dhruvmanila]

I have the following in VSCode settings:

Assuming that these VS Code settings needs to be applied for all projects, you can create a central Ruff config file and provide a path to it via ruff.configuration:

{
	"ruff.configuration": "/path/to/ruff.toml"
}

The configuration file will only been seen by the editor and it'll merge the settings with the one in the project, if there is any. So, what you'll get is that in the editor, ignore-fully-untyped will be false while on the command-line it'll be true.

[tylerlaprade]

I see - the config-merging behavior wasn't clear to me from the migration guide. That should work, moving our existing overrides to a VSCode-only 2nd config file. Thanks @dhruvmanila!

[Aran-Fey]

I find the warning displayed in vscode very cryptic. My language server is set to "Pylance", and I only use ruff for formatting. I honestly have no clue why I'm seeing this warning at all or how to get rid of it. The setup guide pretty much just says to install the ruff extension and that's it. I can't find any useful information anywhere.

[dhruvmanila]

My problem with the warning itself is that I've never heard of ruff-lsp in my life, so I have no clue how it being deprecated affects me or why it requires me to do something. In theory it's nice that the warning links to 2 guides, but the guides themselves aren't helpful, so ultimately I'm just being sent on an odyssey to 3 different places that don't solve my problem.

Thank you, that's useful. I agree in retrospect that it was bad part of my end to include "ruff-lsp" in the deprecation warning as users might be unaware of the underlying tool that's being used in the VS Code extension. To give context, ruff-lsp is the implementation of LSP protocol which powers the VS Code extension. We introduced the same within Ruff itself which is available under the ruff server subcommand. I'll look into improving the message.

Does ruff-lsp simply refer to some legacy settings in settings.json such as "ruff.lint.args", and does migrating to the new ruff server just involve replacing these legacy settings with new ones ? Or are there any special setups ? The vscode warning message is clear to me, but I think the setup and migration guides in Ruff doc could be improved.

I've provided some context in my previous paragraph.

To some extent, yes, some settings have been deprecated and they need to be replaced with the new way of configuring. For your use-case related to ruff.lint.args, I'd suggest you to replace it with ruff.configuration. Feel free to ask any other questions you have.

[MichaReiser]

Should we update the message to differentiate between

a) Users that directly opted in using nativeServer: off and
b) Users that use deprecated settings

[FHU-yezi]

For now, what is the default settings if user removed this config?

[dhruvmanila]

@FHU-yezi Are you referring to ruff.lint.args or ruff.nativeServer? If it's the former, it should work as if you hadn't pass those arguments while invoking the ruff executable. And, if it's the latter, the extension would try to detect automatically between deprecated and the new language server based on the settings set and provide warnings if required.

[dhruvmanila]

Should we update the message to differentiate between

a) Users that directly opted in using nativeServer: off and b) Users that use deprecated settings

The setting is only relevant to the VS Code extension but the warning originates in ruff-lsp, I'll propose something tomorrow.

[copdips]

both of my vscode and ruff are on the latest version, but still got the warning, and don't know how to confirm I'm using ruff-lsp or ruff server?

In other words, how to not use ruff-lsp ?

Tried to add "ruff.nativeServer": "on" in settings.json, but got another warning:

Deprecated: This setting has been deprecated with the deprecation of ruff-lsp. It was mainly used to provide a way to switch between the native language server and ruff-lsp during the transition period.

[copdips]

ok, after replacing the legacy settings, there're no more vscode warnings, what I understand is that:

1. ruff server is auto activated with new ruff version, there's no switch button.
2. migration means removing old ruff settings in settings.json and updating them to the new sytanx

[dhruvmanila]

Tried to add "ruff.nativeServer": "on" in settings.json, but got another warning:

Deprecated: This setting has been deprecated with the deprecation of ruff-lsp. It was mainly used to provide a way to switch between the native language server and ruff-lsp during the transition period.

Refer to #15991 (comment) thread for more details on this but we've decided to un-deprecate ruff.nativeServer for now.

• ruff server is auto activated with new ruff version, there's no switch button.
• migration means removing old ruff settings in settings.json and updating them to the new sytanx

Yes, that's correct. This is useful feedback, thank you, I'll update the warning message to reflect this.

[hamdanal]

Thanks for the update. Please don't remove the old lsp before these issues with the new server astral-sh/ruff-vscode#593 and astral-sh/ruff-vscode#680 are fixed.

[charliermarsh]

We won't be able to make any progress on astral-sh/ruff-vscode#680 unless we have more information and/or a reproduction. My guess is it's an interaction with another extension, and not a Ruff LSP issue, but it's hard to say. If it's affecting you and you're able to share more information, please let us know.

[daireto]

Will you support more settings that can be set directly in the editor? For example, quote style, as well as the line length setting? I use three devices, so synchronizing these settings across all devices can be very helpful to me and those who also work on multiple devices.

[dhruvmanila]

Related astral-sh/ruff-vscode#6. Yes, we can add more settings based on user requests. Ideally, we'd want to mirror the Ruff configuration but it's a bit difficult, see astral-sh/ruff-vscode#260 (comment).

[niccokunzmann]

Hi, I just saw this message pop up:

I was hoping that I can click one of the links and then, I know what to do to remove the message.

What I did is uninstall and install of the plugin and I was hoping that then disables the message but it does not - it just should go ahead with a new config. I sadly do not have the head space at the moment to skip though discussions to see what I should do. I will disable this message now and care for it when the next message says that something is actually broken. Then, I will uninstall the plugin again, install it and hope that that solves the problem - it working with the correct default parameters.

[dhruvmanila]

Apologies for this experience, I spent some time in improving the messages which should be released today and should provide a better experience overall.

Regardless, if you don't mind sharing your VS Code settings for Ruff, I'm happy to guide you on how to migrate them.

[niccokunzmann]

Hi, I appreciate the plugin and all the work put it. There is nothing for you to help me specifically. I was asked to give feedback and so I wanted to give feedback from the point of view of someone who might otherwise consider not to engage - so that you have that type of feedback, too. All is well and thank you for putting in the effort to maintain this!

[skurfer]

Hello. The only setting I use (in VSCode) is ruff.path, which is not listed as deprecated but still seems to use ruff-lsp and trigger the alert.