如何在Neovim中配置ruff-lsp？超简单步骤让Python开发效率翻倍

【免费下载链接】ruff-lsp A Language Server Protocol implementation for Ruff. 项目地址: https://gitcode.com/gh_mirrors/ru/ruff-lsp

ruff-lsp是一款为Python开发者打造的Language Server Protocol实现工具，能显著提升代码检查和格式化效率。本文将带你通过简单步骤在Neovim中完成配置，让Python开发更流畅高效。

一、准备工作：安装ruff-lsp核心组件

1.1 安装ruff-lsp包

首先确保系统已安装Python环境，通过pip命令快速安装ruff-lsp：

pip install ruff-lsp

1.2 验证安装结果

安装完成后，可通过以下命令检查版本：

ruff-lsp --version

若显示版本信息，则说明安装成功。

二、Neovim配置核心步骤

2.1 配置LSP客户端

在Neovim的配置文件（通常位于~/.config/nvim/init.lua）中添加以下配置：

require('lspconfig').ruff_lsp.setup{
  on_attach = function(client, bufnr)
    -- 配置按键映射
    vim.keymap.set('n', 'K', vim.lsp.buf.hover, {buffer = bufnr})
    vim.keymap.set('n', 'gd', vim.lsp.buf.definition, {buffer = bufnr})
  end,
  settings = {
    ruff = {
      -- 启用自动修复
      fixOnSave = true,
      -- 设置Python解释器路径
      pythonPath = '/usr/bin/python3'
    }
  }
}

2.2 配置自动格式化

在Neovim中添加自动保存格式化功能，编辑~/.config/nvim/init.lua：

vim.api.nvim_create_autocmd('BufWritePre', {
  pattern = '*.py',
  callback = function()
    vim.lsp.buf.format({async = false})
  end
})

三、功能验证与使用技巧

3.1 验证LSP服务状态

打开Python文件后，通过以下命令检查LSP是否正常运行：

:LspInfo

在输出信息中应能看到ruff_lsp服务处于"running"状态。

3.2 常用操作快捷键

• K：查看光标处代码的文档说明
• gd：跳转到定义位置
• :LspRestart：重启LSP服务
• :LspLog：查看LSP运行日志

四、高级配置选项

4.1 自定义规则配置

在项目根目录创建.ruff.toml文件，可自定义检查规则：

[tool.ruff]
line-length = 120
select = ["E", "F", "W"]
ignore = ["E501"]

4.2 集成其他工具

如需与mason.nvim集成管理LSP，可在mason配置中添加：

require("mason").setup()
require("mason-lspconfig").setup({
  ensure_installed = { "ruff_lsp" }
})

五、常见问题解决

5.1 LSP启动失败

检查Python环境变量配置，确保ruff-lsp可被Neovim访问：

which ruff-lsp

若未找到命令，需将Python的bin目录添加到PATH。

5.2 格式化不生效

确认配置文件中fixOnSave已设置为true，并检查文件类型是否为Python。

通过以上步骤，你已成功在Neovim中配置ruff-lsp。这款工具将为你的Python开发提供实时语法检查、自动格式化和代码导航功能，让开发效率显著提升。开始体验吧！

【免费下载链接】ruff-lsp A Language Server Protocol implementation for Ruff. 项目地址: https://gitcode.com/gh_mirrors/ru/ruff-lsp