Conform.nvim 配置：实现 LSP 自动格式化回退机制的最佳实践

问题背景

在使用 Conform.nvim 进行代码格式化时，开发者经常会遇到这样的需求：当某个文件类型没有明确配置格式化工具时，希望自动回退到 LSP 提供的格式化功能。同时，还希望保留一些基本的格式化操作，如去除多余空白和换行符。

配置挑战

在 Conform.nvim 中，formatters_by_ft 配置项有两个特殊的键值：

1. "*" - 表示对所有文件类型都应用这些格式化工具
2. "_" - 表示对没有明确配置的文件类型应用这些格式化工具

最初的设计中，"*" 和 "_" 不能指定格式化选项（如 lsp_format），这导致了一个常见问题：当开发者配置了 "*" 包含基本格式化工具时，LSP 格式化功能会被完全覆盖，无法实现回退机制。

解决方案演变

1. 初始方案：开发者尝试在 format_on_save 中设置 lsp_format = 'fallback'，但由于 "*" 的优先级，LSP 格式化无法生效。

2. 改进方案：使用 "_" 键来指定 LSP 回退，如 ['_'] = { lsp_fallback = "last" }。但这样会导致基本格式化工具（如去除空白）被忽略。

3. 最终方案：Conform.nvim 的最新更新允许在 "_" 中同时指定格式化工具和选项，实现了完整的回退机制。

最佳实践配置

{
  'stevearc/conform.nvim',
  opts = {
    formatters_by_ft = {
      ['*'] = { 'trim_whitespace', 'trim_newlines' },
      ['_'] = { lsp_fallback = "last" },
      -- 其他文件类型配置...
    },
    default_format_opts = {
      lsp_format = 'fallback'
    },
    format_on_save = function(bufnr)
      -- 各种条件判断...
      return { timeout_ms = 500 }
    end,
  }
}

关键点说明

1. "*" 配置确保所有文件类型都会执行基本的空白处理
2. "_" 配置确保未明确配置的文件类型会回退到 LSP 格式化
3. default_format_opts 中设置全局的 LSP 回退策略
4. format_on_save 只需关注触发条件和超时设置

技术原理

Conform.nvim 的格式化流程遵循以下顺序：

1. 检查文件类型是否有明确配置的格式化工具
2. 如果没有，检查 "_" 配置
3. 应用 "*" 中配置的通用格式化工具
4. 根据 lsp_format 设置决定是否尝试 LSP 格式化

最新版本的优化使得这个流程更加灵活，允许在回退路径中同时保留基本格式化和 LSP 格式化功能。

总结

通过合理配置 Conform.nvim 的特殊键值和格式化选项，开发者可以实现既保留基本格式化功能，又能智能回退到 LSP 格式化的自动化流程。这种配置方式特别适合需要支持多种文件类型但又不想为每种类型都明确配置格式化工具的开发环境。