typescript-tools.nvim 项目：如何智能配置 TypeScript LSP 根目录

背景介绍

在开发包含多种技术栈的项目时，我们经常会遇到需要为不同目录配置不同语言服务器的情况。typescript-tools.nvim 是一个 Neovim 插件，它提供了对 TypeScript 语言服务器的增强支持。本文将介绍如何通过合理配置来解决混合项目中 TypeScript 和 Deno 环境共存的问题。

问题场景

假设我们有一个 React 项目，目录结构如下：

├── src/          # 前端 React 代码
├── supabase/     # Supabase 后端代码
├── tsconfig.json # TypeScript 配置
└── vite.config.ts

在这个项目中，我们希望：

1. 在前端代码目录中使用 TypeScript 语言服务器
2. 在后端代码目录中不使用 TypeScript 语言服务器（可能使用 Deno 或其他工具）

解决方案

通过配置 typescript-tools.nvim 的 root_dir 函数，我们可以智能地判断何时启用 TypeScript 语言服务器。以下是完整的配置示例：

return {
    "pmizio/typescript-tools.nvim",
    dependencies = {
        "kyoh86/climbdir.nvim",
    },
    lazy = false,
    config = function()
        require("typescript-tools").setup {
            on_attach = function(client)
                -- 禁用文档格式化功能
                client.server_capabilities.documentFormattingProvider = false
                client.server_capabilities.documentRangeFormattingProvider = false
            end,
            root_dir = function(path)
                local marker = require("climbdir.marker")
                -- 根据 package.json 或 node_modules 确定根目录
                return require("climbdir").climb(path,
                    marker.one_of(
                        marker.has_readable_file("package.json"),
                        marker.has_directory("node_modules")
                    ), {
                        -- 当遇到以下文件/目录时停止搜索
                        halt = marker.one_of(
                            marker.has_readable_file("deno.json"),
                            marker.has_readable_file("deno.jsonc"),
                            marker.has_readable_file("import_map.json"),
                            marker.has_directory("denops")
                        ),
                    })
            end,
            single_file_support = false,
        }
    end,
}

配置解析

1. 依赖管理：

   • 使用了 climbdir.nvim 插件来帮助智能查找项目根目录

2. 根目录判断逻辑：

   • 从当前文件路径向上查找，直到找到 package.json 或 node_modules 目录
   • 如果在查找过程中遇到 Deno 相关文件（如 deno.json、deno.jsonc、import_map.json）或 denops 目录，则停止搜索

3. 其他配置：

   • 禁用了文档格式化功能（可根据需要开启）
   • 关闭了单文件支持模式

实际效果

这种配置方式能够：

• 在前端代码目录中正常启用 TypeScript 语言服务器
• 在后端代码目录（如 supabase 目录）中自动禁用 TypeScript 语言服务器
• 保持配置的灵活性和可维护性

扩展思考

这种基于目录标记的判断方法可以推广到其他类似场景：

1. 混合 Node.js 和 Deno 项目
2. 多语言项目（如 TypeScript + Python）
3. 微服务架构中的不同服务目录

通过合理配置语言服务器的根目录判断逻辑，可以显著提升开发体验，避免不必要的语言服务器冲突或错误提示。