Conform.nvim 中 formatexpr 选项配置的注意事项

Conform.nvim 是一个强大的 Neovim 格式化插件，它允许用户为不同文件类型配置多个格式化工具。在使用过程中，有一个关于 formatexpr 选项配置的细节需要特别注意。

问题背景

在 Conform.nvim 中，用户可以通过 formatexpr 选项来指定格式化行为。然而，当尝试通过 formatexpr 选择特定格式化工具时，可能会遇到配置不生效的情况。

关键发现

经过分析，发现问题的根源在于 formatexpr 选项的配置方式。正确的做法是使用 Vimscript 语法而非 Lua 语法来传递参数：

-- 正确的配置方式（使用 Vimscript 语法）
vim.o.formatexpr = "v:lua.require'conform'.formatexpr({ 'formatters': [ 'ocamlformat' ]})"

而非：

-- 错误的配置方式（使用 Lua 语法）
vim.o.formatexpr = "v:lua.require'conform'.formatexpr({ formatters = { 'ocamlformat' }})"

技术原理

这个问题的出现是因为 formatexpr 是 Vim 的一个选项，它期望接收的是 Vimscript 表达式。当我们在 Lua 中设置这个选项时，需要确保传递的字符串是有效的 Vimscript 代码。

在 Vimscript 中：

• 字典使用冒号 : 而非等号 = 来分隔键值对
• 数组使用方括号 [] 而非花括号 {}
• 字符串键名需要引号

实际应用场景

这个技巧在需要选择性使用格式化工具时特别有用。例如，在 OCaml 开发中：

• 可能同时配置了 ocp-indent 和 ocamlformat 两个格式化工具
• 希望在保存文件时自动使用较温和的 ocp-indent
• 而在手动格式化时（通过 gq 命令）使用更激进的 ocamlformat

最佳实践建议

1. 当需要在 Lua 中设置 Vim 选项时，特别是那些接受表达式或函数的选项，要特别注意语法差异
2. 对于复杂的配置，可以先在 Vimscript 中测试表达式，确认无误后再转换为 Lua 字符串
3. 使用 :echo &formatexpr 命令可以检查当前设置的表达式是否正确

通过理解这个细节，用户可以更灵活地配置 Conform.nvim 的格式化行为，实现不同场景下的差异化格式化需求。