TypeScript语言服务器中字符位置参数的正确使用方式

在开发LSP客户端对接TypeScript语言服务器时，一个常见的错误是错误地指定了代码补全请求中的位置参数。本文将通过一个实际案例，分析TypeScript语言服务器返回意外补全结果的原因，并给出正确的参数配置方式。

问题现象分析

当开发者向TypeScript语言服务器发送代码补全请求时，如果收到包含大量无关建议的响应（如170KB以上的补全列表），这通常表明位置参数配置存在问题。典型场景是：

1. 请求内容为console.时，预期应返回log、error等console对象的方法
2. 实际却返回了全局作用域下的所有可能标识符（如AbortController、ArrayBuffer等）

根本原因

经过排查发现，这是由于补全请求中的位置参数使用了错误的字段名。在LSP协议规范中，位置参数应使用character字段，但开发者错误地使用了char缩写。这导致服务器无法正确解析光标位置，默认使用位置0，从而返回全局作用域的所有可能补全项。

正确的请求格式

有效的代码补全请求应包含以下关键字段：

{
  "textDocument": {
    "uri": "file:///path/to/file.ts"
  },
  "position": {
    "line": 0,
    "character": 8  // 注意必须使用character而非char
  },
  "context": {
    "triggerKind": 2,
    "triggerCharacter": "."
  }
}

调试建议

当遇到类似问题时，可以采用以下调试方法：

1. 启用TypeScript服务器的详细日志：

   "initializationOptions": {
     "tsserver": {
       "logVerbosity": "verbose"
     }
   }
   

2. 检查服务器工作目录下的.log文件
3. 验证请求参数是否符合LSP协议规范

经验总结

1. 严格遵循LSP协议规范，特别注意字段名称的完整性
2. 位置参数中的character表示从0开始的列号（UTF-16代码单元）
3. 触发字符为.时，服务器会特别处理成员访问表达式的补全
4. 错误的参数可能导致服务器回退到默认行为，返回全局补全建议

通过正确理解和使用LSP协议参数，可以确保TypeScript语言服务器返回精确的代码补全结果，提高开发效率。