在Conform.nvim中实现ESLint与Prettier的智能切换

项目背景

Conform.nvim是一个强大的Neovim插件，专注于为开发者提供灵活的代码格式化功能。它支持多种格式化工具，并能根据项目需求进行智能配置。

核心需求分析

在实际开发中，JavaScript/TypeScript项目通常会使用两种主流格式化工具：

1. ESLint：专注于代码质量和风格检查
2. Prettier：专注于代码格式统一

开发者经常需要根据项目配置在这两种工具间切换，而Conform.nvim已经内置了支持这两种格式化器的能力。

实现方案详解

基础配置方法

在Conform.nvim中，我们可以通过修改formatters_by_ft配置来指定特定文件类型使用的格式化工具：

require('conform').setup({
  formatters_by_ft = {
    javascript = { "prettier" }, -- 默认使用prettier
    typescript = { "prettier" },
    -- 其他文件类型配置...
  }
})

动态切换机制

虽然Conform.nvim没有直接提供切换功能，但我们可以利用Lua的强大功能实现动态切换：

1. 手动切换命令：创建命令在两种格式化器间切换
2. 自动检测机制：根据项目配置文件自动选择

实现示例代码

local conform = require("conform")

-- 定义格式化器配置
local formatters = {
  prettier = { "prettier" },
  eslint = { "eslint_d" }
}

-- 当前使用的格式化器
local current_formatter = "prettier"

-- 切换命令
vim.api.nvim_create_user_command("ToggleFormatter", function()
  if current_formatter == "prettier" then
    current_formatter = "eslint"
  else
    current_formatter = "eslint"
  end
  conform.formatters_by_ft = {
    javascript = formatters[current_formatter],
    typescript = formatters[current_formatter],
    -- 其他文件类型...
  }
  print("当前格式化器: " .. current_formatter)
end, {})

自动检测实现

更智能的方案是根据项目配置文件自动选择：

local function detect_formatter()
  -- 检查项目根目录下的配置文件
  if vim.fn.filereadable(".eslintrc") == 1 or 
     vim.fn.filereadable(".eslintrc.js") == 1 then
    return "eslint"
  end
  return "prettier"
end

-- 设置自动检测
require('conform').setup({
  formatters_by_ft = {
    javascript = formatters[detect_formatter()],
    typescript = formatters[detect_formatter()],
    -- 其他文件类型...
  }
})

最佳实践建议

1. 项目级配置：建议将格式化器配置放在项目本地配置中，便于团队统一
2. 性能考虑：ESLint通常比Prettier慢，大型项目可考虑性能影响
3. 回退机制：当首选格式化器不可用时，应自动回退到备用方案

总结

Conform.nvim提供了足够的灵活性来实现ESLint和Prettier的智能切换。开发者可以根据项目需求选择手动切换或自动检测方案，打造最适合自己工作流的代码格式化体验。通过合理的配置，可以确保无论项目使用哪种工具，都能获得一致的代码格式化体验。