Conform.nvim 中按文件类型自定义格式化器参数的最佳实践

Conform.nvim 是一个强大的 Neovim 插件，用于代码格式化。在实际开发中，我们经常需要对不同文件类型使用相同的格式化工具但配置不同的参数。本文将详细介绍如何优雅地实现这一需求。

需求场景分析

假设我们使用 Prettier 格式化多种文件类型：

• JSON、CSS、YAML 使用默认 Prettier 配置
• Markdown 文件需要特殊配置：
  • 自动换行(--prose-wrap always)
  • 80字符宽度(--print-width 80)

解决方案

方法一：创建独立格式化器配置

通过深度复制默认 Prettier 配置并修改参数，我们可以创建专用于 Markdown 的格式化器：

-- 复制默认配置
local markdown_formatter = vim.deepcopy(require("conform.formatters.prettier"))

-- 添加前置参数
require("conform.util").add_formatter_args(markdown_formatter, {
  "--prose-wrap",
  "always",
  "--print-width",
  "80",
}, { append = false })

-- 注册新格式化器
require("conform").formatters.prettier_markdown = markdown_formatter

配置说明

1. vim.deepcopy 确保我们获得 Prettier 格式化器的完整副本而不影响原始配置
2. add_formatter_args 是 Conform.nvim 提供的工具函数，用于安全地添加参数
3. { append = false } 选项确保参数添加到命令开头

完整配置示例

return {
  "stevearc/conform.nvim",
  opts = {
    formatters_by_ft = {
      json = { "prettier" },
      markdown = { "prettier_markdown" },
    },
    formatters = {
      prettier = { prepend_args = { "--tab-width", "2" } },
    },
  },
  config = function(_, opts)
    require("conform").setup(opts)
    
    -- 添加Markdown专用格式化器
    local markdown_formatter = vim.deepcopy(require("conform.formatters.prettier"))
    require("conform.util").add_formatter_args(markdown_formatter, {
      "--prose-wrap",
      "always",
      "--print-width",
      "80",
    }, { append = false })
    require("conform").formatters.prettier_markdown = markdown_formatter
  end,
}

技术原理

Conform.nvim 的格式化器系统设计允许：

1. 每个文件类型可以指定不同的格式化器
2. 相同工具的不同配置可以注册为不同的格式化器
3. 参数系统支持前置(prepend)和后置(append)两种添加方式

这种设计既保持了配置的灵活性，又避免了不同文件类型配置间的相互干扰。

最佳实践建议

1. 优先使用 add_formatter_args 而非直接修改 args 数组，更安全可靠
2. 对于复杂配置，考虑将格式化器定义提取到单独模块
3. 使用类型注解(---@cast)提高代码可维护性
4. 为不同场景创建专用格式化器，而非通过条件判断修改参数