Coc.nvim 中 TypeScript 导入排序与 ESLint 规则冲突的解决方案

在 TypeScript 开发中，代码格式化工具和 ESLint 规则之间的冲突是一个常见问题。本文将深入分析 Coc.nvim 项目中导入排序功能与 ESLint 规则不一致的原因，并提供多种解决方案。

问题背景

当使用 Coc.nvim 的 editor.action.organizeImport 命令整理 TypeScript 文件导入时，可能会发现排序结果与项目中配置的 ESLint import/order 规则不一致。例如，内置模块 net 应该排在第三方模块 chalk 之前，但 Coc.nvim 的排序功能会按照字母顺序排列，导致 ESLint 报错。

技术原理分析

这一问题的根源在于 Coc.nvim 的导入排序功能实际上是由 TypeScript 语言服务器(tsserver)提供的。具体流程如下：

1. 当调用 editor.action.organizeImport 命令时，Coc.nvim 会请求 tsserver 提供代码操作
2. tsserver 返回一个类型为 source.organizeImports 的操作
3. Coc.nvim 应用这个排序操作

TypeScript 语言服务器的排序逻辑是硬编码的，主要基于字母顺序，无法直接读取或遵循项目中的 ESLint 配置。

解决方案比较

方案一：启用 ESLint 自动修复

在 Coc.nvim 配置中启用 eslint.autoFixOnSave，这样在保存文件时会自动应用 ESLint 的修复规则。这种方法简单但不够灵活，会修复所有可自动修复的问题，而不仅仅是导入排序问题。

方案二：组合命令执行

更精细的控制方式是创建一个自定义命令，依次执行两个操作：

1. 首先执行 tsserver 的导入排序
2. 然后执行 ESLint 的自动修复

在 Lua 配置中可以这样实现：

vim.api.nvim_create_user_command('OrganizeImports', function()
    vim.cmd("call CocAction('runCommand', 'editor.action.organizeImport')")
    -- 需要添加延迟确保第一个操作完成
    vim.defer_fn(function()
        vim.cmd("call CocAction('runCommand', 'eslint.executeAutofix')")
    end, 500)
end, { bang = true, nargs = 0, desc = '整理导入并应用ESLint修复' })

方案三：直接使用 ESLint CLI

对于需要更精确控制的情况，可以直接调用 ESLint 命令行工具：

vim.api.nvim_create_user_command('FixImports', function()
    vim.cmd("!npx eslint --fix %")
end, { bang = true, desc = '使用ESLint修复导入顺序' })

最佳实践建议

1. 对于新项目，建议统一使用 ESLint 的排序规则，并禁用 tsserver 的自动排序功能
2. 在现有项目中，采用组合命令方案，确保代码风格一致
3. 考虑在项目级配置中明确文档说明导入排序规则，避免团队成员混淆

通过理解这些工具的工作原理和交互方式，开发者可以更好地配置 Coc.nvim 来满足项目的代码风格要求，同时保持高效的开发体验。