Conform.nvim 配置技巧：如何排除特定文件模式的自动格式化

问题背景

在使用 Neovim 进行 Markdown 文件编辑时，许多开发者会选择使用 conform.nvim 插件来自动格式化文档内容。然而，在实际开发过程中，我们可能会遇到一些特殊情况需要排除自动格式化功能，例如处理临时文件时。

临时文件的格式化问题

当使用 GitHub CLI (gh) 等工具时，系统会创建临时 Markdown 文件（通常位于 /tmp/ 目录下）作为编辑缓冲区。这些文件最终会被上传到 GitHub 服务器并在 Web UI 中渲染。如果对这些临时文件应用了本地格式化规则，可能会导致在 GitHub 上显示效果与预期不符。

解决方案

conform.nvim 提供了灵活的配置选项，允许用户通过编写 Lua 函数来自定义格式化行为。我们可以利用这一特性，在格式化前检查文件路径，对特定模式的文件跳过格式化过程。

实现代码示例

以下是一个实用的配置示例，它会跳过 /tmp/ 目录下的所有文件：

format_on_save = function(bufnr)
  local bufname = vim.api.nvim_buf_get_name(bufnr)

  -- 跳过/tmp/目录下的所有文件
  if bufname:match("/tmp/") then
    return
  else
    return {
      timeout_ms = 2500,
      lsp_fallback = true,
    }
  end
end

配置解析

1. 函数参数：bufnr 表示当前缓冲区的编号
2. 获取文件名：使用 vim.api.nvim_buf_get_name 获取完整文件路径
3. 模式匹配：使用 Lua 的字符串匹配功能检查文件路径
4. 条件返回：
   • 匹配到目标模式时返回 nil，跳过格式化
   • 否则返回格式化配置对象

扩展应用

这种模式不仅适用于临时文件，还可以扩展到其他场景：

1. 版本控制忽略文件：跳过 .gitignore 中指定的文件
2. 特定项目文件：对某些项目采用不同的格式化规则
3. 只读文件：跳过系统或只读文件的格式化

最佳实践建议

1. 明确匹配规则：确保文件路径匹配规则足够精确，避免意外跳过需要格式化的文件
2. 日志记录：可以添加日志输出，便于调试格式化排除行为
3. 多条件组合：支持多个排除条件的组合判断

通过这种灵活的配置方式，conform.nvim 可以更好地适应各种复杂的开发场景，在保持自动化优势的同时，避免了不必要或有害的格式化操作。