LSP 服务器
OpenCode 与你的 LSP 服务器集成。
OpenCode 与语言服务器协议 (LSP) 集成,帮助 LLM 与你的代码库交互。它使用诊断信息为 LLM 提供反馈。
内置支持
OpenCode 为流行语言内置了多个 LSP 服务器:
| LSP 服务器 | 扩展名 | 要求 |
|---|---|---|
| astro | .astro | Astro 项目自动安装 |
| bash | .sh, .bash, .zsh, .ksh | 自动安装 bash-language-server |
| clangd | .c, .cpp, .cc, .cxx, .c++, .h, .hpp, .hh, .hxx, .h++ | C/C++ 项目自动安装 |
| csharp | .cs | 需要安装 .NET SDK |
| clojure-lsp | .clj, .cljs, .cljc, .edn | 需要 clojure-lsp 命令可用 |
| dart | .dart | 需要 dart 命令可用 |
| deno | .ts, .tsx, .js, .jsx, .mjs | 需要 deno 命令可用(自动检测 deno.json/deno.jsonc) |
| elixir-ls | .ex, .exs | 需要 elixir 命令可用 |
| eslint | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vue | 项目中需要 eslint 依赖 |
| fsharp | .fs, .fsi, .fsx, .fsscript | 需要安装 .NET SDK |
| gleam | .gleam | 需要 gleam 命令可用 |
| gopls | .go | 需要 go 命令可用 |
| hls | .hs, .lhs | 需要 haskell-language-server-wrapper 命令可用 |
| jdtls | .java | 需要安装 Java SDK (21+ 版本) |
| kotlin-ls | .kt, .kts | Kotlin 项目自动安装 |
| lua-ls | .lua | Lua 项目自动安装 |
| nixd | .nix | 需要 nixd 命令可用 |
| ocaml-lsp | .ml, .mli | 需要 ocamllsp 命令可用 |
| oxlint | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vue, .astro, .svelte | 项目中需要 oxlint 依赖 |
| php intelephense | .php | PHP 项目自动安装 |
| prisma | .prisma | 需要 prisma 命令可用 |
| pyright | .py, .pyi | 需要安装 pyright 依赖 |
| ruby-lsp (rubocop) | .rb, .rake, .gemspec, .ru | 需要 ruby 和 gem 命令可用 |
| rust | .rs | 需要 rust-analyzer 命令可用 |
| sourcekit-lsp | .swift, .objc, .objcpp | 需要安装 swift(macOS 上需要 xcode) |
| svelte | .svelte | Svelte 项目自动安装 |
| terraform | .tf, .tfvars | 从 GitHub releases 自动安装 |
| tinymist | .typ, .typc | 从 GitHub releases 自动安装 |
| typescript | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts | 项目中需要 typescript 依赖 |
| vue | .vue | Vue 项目自动安装 |
| yaml-ls | .yaml, .yml | 自动安装 Red Hat yaml-language-server |
| zls | .zig, .zon | 需要 zig 命令可用 |
当检测到上述文件扩展名且满足要求时,LSP 服务器会自动启用。
注意: 你可以通过将
OPENCODE_DISABLE_LSP_DOWNLOAD环境变量设置为true来禁用自动下载 LSP 服务器。
工作原理
当 opencode 打开文件时,它会:
- 检查文件扩展名是否匹配已启用的 LSP 服务器。
- 如果尚未运行,则启动相应的 LSP 服务器。
配置
你可以通过 opencode 配置中的 lsp 部分自定义 LSP 服务器。
opencode.json
{
"$schema": "https://opencode.ai/config.json",
"lsp": {}
}每个 LSP 服务器支持以下配置:
| 属性 | 类型 | 描述 |
|---|---|---|
disabled | boolean | 设置为 true 以禁用该 LSP 服务器 |
command | string[] | 启动 LSP 服务器的命令 |
extensions | string[] | 该 LSP 服务器应处理的文件扩展名 |
env | object | 启动服务器时设置的环境变量 |
initialization | object | 发送给 LSP 服务器的初始化选项 |
让我们看一些示例。
环境变量
使用 env 属性在启动 LSP 服务器时设置环境变量:
opencode.json
{
"$schema": "https://opencode.ai/config.json",
"lsp": {
"rust": {
"env": {
"RUST_LOG": "debug"
}
}
}
}初始化选项
使用 initialization 属性向 LSP 服务器传递初始化选项。这些是在 LSP initialize 请求期间发送的服务器特定设置:
opencode.json
{
"$schema": "https://opencode.ai/config.json",
"lsp": {
"typescript": {
"initialization": {
"preferences": {
"importModuleSpecifierPreference": "relative"
}
}
}
}
}注意: 初始化选项因 LSP 服务器而异。请查阅你的 LSP 服务器文档了解可用选项。
禁用 LSP 服务器
要全局禁用所有 LSP 服务器,将 lsp 设置为 false:
opencode.json
{
"$schema": "https://opencode.ai/config.json",
"lsp": false
}要禁用特定 LSP 服务器,将 disabled 设置为 true:
opencode.json
{
"$schema": "https://opencode.ai/config.json",
"lsp": {
"typescript": {
"disabled": true
}
}
}自定义 LSP 服务器
你可以通过指定命令和文件扩展名来添加自定义 LSP 服务器:
opencode.json
{
"$schema": "https://opencode.ai/config.json",
"lsp": {
"custom-lsp": {
"command": ["custom-lsp-server", "--stdio"],
"extensions": [".custom"]
}
}
}附加信息
PHP Intelephense
PHP Intelephense 通过许可证密钥提供高级功能。你可以将许可证密钥放在以下位置的文本文件中(文件中只包含密钥):
- macOS/Linux:
$HOME/intelephense/licence.txt - Windows:
%USERPROFILE%/intelephense/licence.txt
文件应仅包含许可证密钥,不要有其他内容。