Conform.nvim 中 Ruff 格式化工具的深度解析与配置指南

前言

Conform.nvim 作为 Neovim 生态中优秀的代码格式化插件，为开发者提供了灵活的格式化配置方案。本文将深入探讨如何在该插件中合理配置 Ruff 工具链，实现 Python 代码的高效格式化与导入排序。

Ruff 工具链的两种工作模式

Ruff 提供了两种主要的工作方式：

1. 命令行工具模式：

   • 通过直接调用 ruff 可执行文件进行操作
   • 包含三个核心功能：
     • ruff_fix：修复可自动修复的问题
     • ruff_format：代码格式化
     • ruff_organize_imports：导入排序

2. LSP 服务器模式：

   • 通过语言服务器协议提供更智能的代码操作
   • 支持格式化、导入排序等操作
   • 响应速度更快，集成度更高

配置方案对比

方案一：纯命令行工具配置

require("conform").setup({
  formatters_by_ft = {
    python = {'ruff_organize_imports', 'ruff_format'},
  }
})

特点：

• 完全依赖 Ruff CLI
• 执行顺序明确
• 需要确保 ruff 可执行文件在 PATH 中

方案二：混合模式配置

require("conform").setup({
  formatters_by_ft = {
    python = { "ruff_organize_imports", lsp_format = "last" }
  },
  format_after_save = {
    lsp_format = "fallback",
  }
})

特点：

• 导入排序使用 CLI
• 格式化使用 LSP
• 利用了两种模式的优势

高级配置技巧

选择性启用格式化

可以通过函数实现按文件类型选择性格式化：

format_after_save = function(bufnr)
  local ft = vim.bo[bufnr].filetype
  if ft == "python" then
    return { lsp_fallback = true }
  end
  return false
end

导入排序的自动化

虽然 Conform 目前不支持直接使用 LSP 的代码动作进行导入排序，但可以通过自动命令实现：

vim.api.nvim_create_autocmd({ "BufWritePost" }, {
  pattern = { "*.py" },
  callback = function()
    vim.lsp.buf.code_action {
      context = { only = { 'source.organizeImports.ruff' } },
      apply = true,
    }
  end,
})

技术实现原理

Conform.nvim 的设计哲学是将格式化工具视为"黑盒"，通过统一的接口处理各种格式化工具的输出。这种设计带来了几个关键特性：

1. 原子性操作：每个格式化工具独立运行，互不干扰
2. 结果合并：多个格式化工具的结果会智能合并
3. 错误隔离：单个工具失败不会影响其他工具

对于 LSP 格式化，插件采用了特殊处理机制，因为 LSP 的格式化 API 与 CLI 工具有本质区别：

• LSP 直接操作缓冲区内容
• CLI 工具通过标准输入输出通信
• 代码动作无法像格式化工具那样进行结果合并

最佳实践建议

1. 性能优先：对于 Python 项目，推荐使用 Ruff LSP 进行格式化
2. 稳定性优先：对于导入排序，使用 CLI 工具更可靠
3. 渐进式配置：从简单配置开始，逐步添加复杂功能
4. 错误处理：始终启用 notify_on_error 以便及时发现问题

通过合理配置 Conform.nvim 和 Ruff 工具链，开发者可以获得既高效又稳定的代码格式化体验，显著提升 Python 开发效率。