The documentation has stale configuration guidance and a few examples that do not work as written. Clarify the prose and correct editor configuration precedence, user-level configuration discovery, rule descriptions, and the tutorial and configuration examples. --------- Co-authored-by: Zanie Blue <zanie@openai.com>
1.3 KiB
Editor Integrations
Ruff can be integrated with various editors and IDEs to provide a seamless development experience. This section provides instructions on how to set up Ruff with your editor and configure it to your liking.
Language Server Protocol
The editor integration is mainly powered by the Ruff Language Server which implements the
Language Server Protocol. The server is
written in Rust and is available as part of the ruff CLI via ruff server. It is a single, common
backend built directly into Ruff, and a direct replacement for ruff-lsp,
our previous language server. You can read more about ruff server in the
v0.4.5 blog post.
The server provides Ruff diagnostics, Code Actions to fix them, and formatting using Ruff's built-in formatter. For features like navigation and autocompletion, we recommend using the ty language server alongside Ruff.
The Ruff Language Server was available first in Ruff v0.4.5 in beta and stabilized in Ruff v0.5.3.