typescript-tools.nvim 中格式化与导入组织的同步问题解决方案

在 Neovim 中使用 typescript-tools.nvim 进行 TypeScript 开发时，开发者可能会遇到一个常见问题：当同时启用自动格式化（如 Prettier）和导入组织功能时，保存文件后可能会出现导入语句损坏的情况。本文将深入分析这一问题的成因，并提供专业可靠的解决方案。

问题现象分析

当开发者配置了以下两种自动化功能时：

1. 通过 LazyVim 或其他插件集成的 Prettier 自动格式化
2. 使用 typescript-tools.nvim 的自动移除未使用导入功能

在保存 TypeScript 文件时，可能会出现导入语句被破坏的情况，导致代码无法正常编译。这种情况通常发生在两个自动化过程同时或交错执行时。

根本原因

问题的核心在于执行时序的竞争条件。默认情况下，TSToolsRemoveUnusedImports 命令以异步方式执行，而 Prettier 格式化也是异步进行的。当两个进程同时操作同一个文件时，就可能出现以下情况：

1. Prettier 开始格式化文件
2. 同时导入组织开始移除未使用的导入
3. 两个进程对文件的修改产生冲突
4. 最终导致导入语句损坏

解决方案

同步执行方案

最直接的解决方案是强制导入组织命令以同步方式执行，确保它在格式化之前完成：

vim.api.nvim_create_autocmd("BufWritePre", {
  pattern = "*.ts*",
  command = ":TSToolsRemoveUnusedImports sync",  -- 关键修改：添加 sync 参数
})

这个修改确保了：

1. 导入组织操作会完全执行完毕
2. 后续的格式化操作会在整洁的代码基础上进行
3. 避免了两个进程对文件的并发修改

进阶集成方案

对于需要更复杂自动化流程的开发者，可以采用更精细的控制策略。以下是一个专业推荐的实现模式：

local function format_with_integration(bufnr)
  -- 先执行TS相关操作
  vim.cmd("TSToolsFixAll sync")
  vim.cmd("TSToolsRemoveUnused sync")
  
  -- 然后执行常规格式化
  require("conform").format({
    lsp_fallback = true,
    timeout_ms = 2000,
    bufnr = bufnr
  })
end

vim.api.nvim_create_autocmd("BufWritePre", {
  pattern = "*.ts*",
  callback = function(event)
    format_with_integration(event.buf)
  end,
})

这种方案的优势在于：

1. 明确控制执行顺序
2. 将多个自动化操作封装为单一流程
3. 便于维护和调试
4. 可以轻松扩展其他预处理操作

注意事项

1. 使用同步模式时，大型项目可能会有轻微的性能影响
2. 确保你的 typescript-tools.nvim 版本支持 sync 参数
3. 如果遇到 LSP 重启后自动命令失效的问题，可能需要重新注册自动命令
4. 在团队协作环境中，建议统一编辑器的自动化配置

总结

通过理解 Neovim 中自动化操作的执行机制，我们可以有效解决 typescript-tools.nvim 与其他格式化工具的冲突问题。同步执行策略提供了简单可靠的解决方案，而集成控制方案则为复杂场景提供了更大的灵活性。开发者应根据项目需求选择合适的实现方式，确保开发体验的流畅性和代码质量的一致性。