Conform.nvim 格式化插件配置陷阱：多次调用 setup 导致的问题分析

问题现象

在使用 Conform.nvim 这个 Neovim 格式化插件时，用户发现 format_on_save 自动保存格式化功能失效。经过排查发现，当注释掉插件源码中 autocmd 的 group 参数后，功能恢复正常。这实际上反映了一个常见的配置陷阱。

根本原因

问题的核心在于用户配置文件中多次调用了 require("conform").setup()，这会导致以下连锁反应：

1. 第一次 setup 调用配置了 formatters_by_ft，但未设置 format_on_save，因此不会创建 autocmd
2. 第二次 setup 调用配置了 format_on_save，此时创建了 autocmd
3. 第三次 setup 调用（通过 packer 配置）清除了之前创建的所有 autocmd

技术原理

Conform.nvim 的设计中，每次调用 setup() 都会执行以下操作：

• 清除之前创建的所有 autocmd
• 根据当前配置决定是否创建新的 autocmd

这种设计确保了配置的干净状态，但也意味着多次调用 setup() 时，只有最后一次的配置会生效。

最佳实践解决方案

正确的配置方式应该是一次性完成所有配置，将 formatters_by_ft 和 format_on_save 等所有选项合并到一个 setup 调用中：

require("conform").setup({
  formatters_by_ft = {
    lua = { "stylua" },
    python = { "isort", "black" },
    rust = { "rustfmt", lsp_format = "fallback" },
    javascript = { "prettierd", "prettier", stop_after_first = true },
    go = { "gofumpt" },
  },
  format_on_save = {
    timeout_ms = 10000,
    lsp_format = "fallback",
  }
})

扩展建议

1. 配置合并原则：对于大多数 Neovim 插件，都应该遵循"一次性配置"原则，避免多次调用 setup

2. 调试技巧：当插件行为不符合预期时，可以：

   • 检查是否有多余的 setup 调用
   • 使用 :au BufWritePre 查看 autocmd 是否被正确创建
   • 启用插件的 debug 日志

3. 性能考虑：多次调用 setup 不仅会导致功能异常，还会带来不必要的性能开销

通过理解插件的工作机制和遵循正确的配置方式，可以避免这类问题，确保 Conform.nvim 的自动格式化功能稳定工作。