Conform.nvim 中如何智能启用 Prettier 格式化

项目背景

Conform.nvim 是一个强大的 Neovim 插件，用于统一管理代码格式化工具。它支持多种格式化程序，包括 Prettier、ESLint 等，能够根据项目配置自动选择合适的格式化方式。

问题场景

在实际开发中，我们经常会遇到以下情况：

1. 某些项目使用 Prettier 作为主要格式化工具
2. 另一些项目则完全依赖 ESLint 进行代码风格管理
3. 还有一些项目可能混合使用多种工具

理想情况下，我们希望 Conform.nvim 能够智能识别项目配置，只在项目确实使用 Prettier 时才启用它，否则回退到 LSP 或其他格式化方案。

解决方案

Conform.nvim 提供了灵活的配置选项来实现这一需求。核心思路是通过 require_cwd 和 cwd 参数来控制 Prettier 的启用条件。

基础配置

local conform = require("conform")

conform.setup({
    formatters = {
        prettier = {
            require_cwd = true,
            cwd = require("conform.util").root_file({
                ".prettierrc",
                ".prettierrc.json",
                ".prettierrc.yml",
                -- 其他 Prettier 配置文件
            }),
        },
    },
})

配置说明

1. require_cwd: 设置为 true 时，只有在找到指定配置文件时才会启用 Prettier
2. cwd: 定义 Prettier 配置文件的查找规则，默认会检查 package.json

新版简化配置

在 Conform.nvim 8.3.0 及以上版本中，配置可以进一步简化：

conform.setup({
    formatters = {
        prettier = {
            require_cwd = true,
        },
    },
})

工作原理

1. Conform.nvim 会按照以下顺序检查 Prettier 配置：

   • 首先查找项目根目录下的各种 Prettier 配置文件
   • 如果没有找到，则检查 package.json 中的 Prettier 配置
   • 如果设置了 require_cwd=true 且未找到配置，则禁用 Prettier

2. 当 Prettier 被禁用时，Conform.nvim 会自动回退到 LSP 格式化（如 ESLint LSP）

高级技巧

1. 自定义配置文件路径：如果需要指定非标准的 Prettier 配置文件位置，可以修改 cwd 参数
2. 多格式化程序协作：可以同时配置 Prettier 和 ESLint，让 Conform.nvim 根据项目配置自动选择
3. 项目特定配置：结合 .nvim.lua 等本地配置文件，实现不同项目的差异化设置

最佳实践

1. 对于新项目，建议明确使用 Prettier 或 ESLint，避免混用
2. 在团队项目中，确保所有成员使用相同的格式化配置
3. 定期检查格式化配置，确保与项目最新需求保持一致

通过合理配置 Conform.nvim，开发者可以获得智能、灵活的代码格式化体验，无需手动切换不同项目的格式化工具，大大提升了开发效率和代码一致性。