From there, ruff-lsp can be used with any editor that supports the Language Server Protocol,
including Neovim, Emacs, Sublime Text, and more.
Example: Neovim
For example, to use ruff-lsp with Neovim, install ruff-lsp from PyPI along with
nvim-lspconfig. Then, add something like the following
to your init.lua:
-- See: https://github.com/neovim/nvim-lspconfig/tree/54eb2a070a4f389b1be0f98070f81d23e2b1a715#suggested-configurationlocal opts = { noremap=true, silent=true }
vim.keymap.set('n', '<space>e', vim.diagnostic.open_float, opts)
vim.keymap.set('n', '[d', vim.diagnostic.goto_prev, opts)
vim.keymap.set('n', ']d', vim.diagnostic.goto_next, opts)
vim.keymap.set('n', '<space>q', vim.diagnostic.setloclist, opts)
-- Use an on_attach function to only map the following keys-- after the language server attaches to the current bufferlocal on_attach =function(client, bufnr)
-- Enable completion triggered by <c-x><c-o>
vim.api.nvim_buf_set_option(bufnr, 'omnifunc', 'v:lua.vim.lsp.omnifunc')
-- Mappings.-- See `:help vim.lsp.*` for documentation on any of the below functionslocal bufopts = { noremap=true, silent=true, buffer=bufnr }
vim.keymap.set('n', 'gD', vim.lsp.buf.declaration, bufopts)
vim.keymap.set('n', 'gd', vim.lsp.buf.definition, bufopts)
vim.keymap.set('n', 'K', vim.lsp.buf.hover, bufopts)
vim.keymap.set('n', 'gi', vim.lsp.buf.implementation, bufopts)
vim.keymap.set('n', '<C-k>', vim.lsp.buf.signature_help, bufopts)
vim.keymap.set('n', '<space>wa', vim.lsp.buf.add_workspace_folder, bufopts)
vim.keymap.set('n', '<space>wr', vim.lsp.buf.remove_workspace_folder, bufopts)
vim.keymap.set('n', '<space>wl', function()
print(vim.inspect(vim.lsp.buf.list_workspace_folders()))
end, bufopts)
vim.keymap.set('n', '<space>D', vim.lsp.buf.type_definition, bufopts)
vim.keymap.set('n', '<space>rn', vim.lsp.buf.rename, bufopts)
vim.keymap.set('n', '<space>ca', vim.lsp.buf.code_action, bufopts)
vim.keymap.set('n', 'gr', vim.lsp.buf.references, bufopts)
vim.keymap.set('n', '<space>f', function() vim.lsp.buf.format { async =true } end, bufopts)
end-- Configure `ruff-lsp`.-- See: https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#ruff_lsp-- For the default config, along with instructions on how to customize the settingsrequire('lspconfig').ruff_lsp.setup {
on_attach = on_attach,
init_options = {
settings = {
-- Any extra CLI arguments for `ruff` go here.
args = {},
}
}
}
Upon successful installation, you should see Ruff's diagnostics surfaced directly in your editor:
Note that if you're using Ruff alongside another LSP (like Pyright), you may want to defer to that
LSP for certain capabilities, like textDocument/hover:
local on_attach =function(client, bufnr)
-- Disable hover in favor of Pyright
client.resolved_capabilities.hover=falseendrequire('lspconfig').ruff_lsp.setup {
on_attach = on_attach,
}
charliermarsh/ruff-lsp
ruff-lsp
A Language Server Protocol implementation for Ruff, an extremely fast Python linter and code transformation tool, written in Rust.
Enables Ruff to be used in any editor that supports the LSP, including Neovim, Sublime Text, Emacs and more.
For Visual Studio Code, check out the Ruff VS Code extension.
Highlights
"Quick Fix" actions for auto-fixable violations (like unused imports)
"Fix all": automatically fix all auto-fixable violations
"Organize Imports":
isort
-compatible import sortingInstallation and Usage
ruff-lsp
is available asruff-lsp
on PyPI:From there,
ruff-lsp
can be used with any editor that supports the Language Server Protocol, including Neovim, Emacs, Sublime Text, and more.Example: Neovim
For example, to use
ruff-lsp
with Neovim, installruff-lsp
from PyPI along withnvim-lspconfig
. Then, add something like the following to yourinit.lua
:Upon successful installation, you should see Ruff's diagnostics surfaced directly in your editor:
Note that if you're using Ruff alongside another LSP (like Pyright), you may want to defer to that LSP for certain capabilities, like
textDocument/hover
:Ruff also integrates with
coc.nvim
:Example: Sublime Text
To use
ruff-lsp
with Sublime Text, install Sublime Text's LSP and LSP-ruff package.Upon successful installation, you should see errors surfaced directly in your editor:
Example: Helix
To use
ruff-lsp
with Helix, add something like the following to~/.config/helix/languages.toml
:Upon successful installation, you should see errors surfaced directly in your editor:
Example: Lapce
To use
ruff-lsp
with Lapce, install thelapce-ruff-lsp
plugin (which wrapsruff-lsp
) from the Lapce plugins panel.Upon successful installation, you should see errors surfaced directly in your editor:
Settings
The exact mechanism by which settings will be passed to
ruff-lsp
will vary by editor. However, the following settings are supported:[]
ruff
. E.g"args": ["--config=/path/to/pyproject.toml"]
.error
[]
ruff
executables, to try in order. E.g.["/path/to/ruff"]
.[]
off
true
source.organizeImports
actions.true
source.fixAll
actions.Development
just
, or see thejustfile
for corresponding commands.python -m venv .venv && source .venv/bin/activate
).just install
).just fmt
.just check
.just test
.License
MIT