Conform.nvim 中 Yarn 环境下 Prettier 格式化问题的解决方案

问题背景

在使用 Conform.nvim 插件时，许多开发者遇到了在 Yarn 环境下无法正确调用 Prettier 进行代码格式化的问题。这一问题尤其在使用 Yarn 4 版本、Volta 版本管理工具或 Yarn PnP (Plug'n'Play) 特性时更为常见。

核心问题分析

问题的本质在于 Conform.nvim 默认会尝试从 node_modules/.bin/ 目录下寻找 Prettier 可执行文件。但在不同环境下，这一路径可能不可用或权限不足：

1. Yarn PnP 模式：完全移除了 node_modules 目录，改用 JavaScript 包装器解析包
2. 符号链接问题：某些情况下 .bin/prettier 是指向 .cjs 文件的符号链接，导致执行权限问题
3. Volta 管理：Yarn 版本被 Volta 固定，可能导致路径解析异常

解决方案

标准 Yarn 项目解决方案

对于使用标准 Yarn (非 PnP 模式) 的项目，确保以下配置：

{
  formatters_by_ft = {
    typescript = { 'prettier' },
    typescriptreact = { 'prettier' },
  },
}

Conform.nvim 会自动从 node_modules/.bin/ 查找 Prettier。如果仍不工作，检查 :ConformInfo 输出确认问题。

Yarn PnP 模式解决方案

对于使用 Yarn PnP 的项目，需要特殊配置：

1. 首先运行 Yarn SDK 生成命令：

yarn dlx @yarnpkg/sdks base

2. 然后使用以下 Lua 配置：

local util = require("conform.util")
local fs = require("conform.fs")

return {
  "stevearc/conform.nvim",
  opts = {
    formatters = {
      prettier = {
        command = function(self, bufnr)
          local cmd = util.find_executable({ ".yarn/sdks/prettier/bin-prettier.js" }, "")(self, bufnr)
          if cmd ~= "" then
            return cmd
          end
          return util.from_node_modules(fs.is_windows and "prettier.cmd" or "prettier")(self, bufnr)
        end,
      },
    },
  },
}

直接使用 Yarn 执行

如果上述方法都不适用，可以直接配置通过 Yarn 调用 Prettier：

{
  formatters = {
    typescriptreact = {
      inherit = false,
      command = 'yarn',
      args = { 'prettier', '--stdin-filepath', '$FILENAME' },
    },
  },
}

常见问题排查

1. 权限问题：检查 node_modules/.bin/prettier 是否具有可执行权限
2. 路径问题：确认项目根目录是否正确识别
3. 文件类型识别：确保文件扩展名正确，如 .component.html 与 .handler.html 可能导致不同解析
4. Angular 特殊语法：确保已安装支持 Angular 模板语法的 Prettier 插件

最佳实践建议

1. 对于团队项目，统一使用标准 Yarn 配置而非 PnP
2. 在项目根目录添加 .editorconfig 文件统一编辑器行为
3. 考虑使用 prettierd 作为替代，提高格式化性能
4. 定期检查 :ConformInfo 输出确认格式化器状态

通过以上方法，开发者可以解决大多数在 Yarn 环境下使用 Conform.nvim 和 Prettier 的格式化问题，确保代码风格的一致性。