跳至内容

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, .ednclojure-lsp 命令可用
dart.dartdart 命令可用
deno.ts, .tsx, .js, .jsx, .mjsdeno 命令可用(自动检测 deno.json/deno.jsonc)
elixir-ls.ex, .exselixir 命令可用
eslint.ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vue项目中存在 eslint 依赖项
fsharp.fs, .fsi, .fsx, .fsscript.NET SDK 已安装
gleam.gleamgleam 命令可用
gopls.gogo 命令可用
hls.hs, .lhshaskell-language-server-wrapper 命令可用
jdtls.javaJava SDK(版本 21+) 已安装
julials.jljuliaLanguageServer.jl 已安装
kotlin-ls.kt, .kts为 Kotlin 项目自动安装
lua-ls.lua为 Lua 项目自动安装
nixd.nixnixd 命令可用
ocaml-lsp.ml, .mliocamllsp 命令可用
oxlint.ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vue, .astro, .svelte项目中存在 oxlint 依赖项
php intelephense.php为 PHP 项目自动安装
prisma.prismaprisma 命令可用
pyright.py, .pyipyright 依赖项已安装
ruby-lsp (rubocop).rb, .rake, .gemspec, .rurubygem 命令可用
rust.rsrust-analyzer 命令可用
sourcekit-lsp.swift, .objc, .objcppswift 已安装(macOS 上为 xcode
svelte.svelte为 Svelte 项目自动安装
terraform.tf, .tfvars从 GitHub 发布版本自动安装
tinymist.typ, .typc从 GitHub 发布版本自动安装
typescript.ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts项目中存在 typescript 依赖项
vue.vue为 Vue 项目自动安装
yaml-ls.yaml, .yml自动安装 Red Hat yaml-language-server
zls.zig, .zonzig 命令可用

当检测到上述文件扩展名且满足要求时,LSP 服务器将自动启用。


工作原理

当 OpenCode 打开文件时,它会

  1. 根据所有已启用的 LSP 服务器检查文件扩展名。
  2. 如果尚未运行,则启动相应的 LSP 服务器。

配置

您可以通过 OpenCode 配置中的 lsp 部分自定义 LSP 服务器。

opencode.json
{
"$schema": "https://opencode.ac.cn/config.json",
"lsp": {}
}

每个 LSP 服务器支持以下内容

属性类型 (Type)描述
disabled(禁用)boolean将其设置为 true 以禁用 LSP 服务器
commandstring[]启动 LSP 服务器的命令
extensions(扩展名)string[]此 LSP 服务器应处理的文件扩展名
env(环境变量)object启动服务器时要设置的环境变量
initialization(初始化)object发送到 LSP 服务器的初始化选项。这些是 LSP initialize 请求期间发送的服务器特定设置

让我们看一些示例。


环境变量

使用 env 属性在启动 LSP 服务器时设置环境变量

opencode.json
{
"$schema": "https://opencode.ac.cn/config.json",
"lsp": {
"rust": {
"env": {
"RUST_LOG": "debug"
}
}
}
}

初始化选项

使用 initialization 属性向 LSP 服务器传递初始化选项。这些是在 LSP initialize 请求期间发送的服务器特定设置

opencode.json
{
"$schema": "https://opencode.ac.cn/config.json",
"lsp": {
"typescript": {
"initialization": {
"preferences": {
"importModuleSpecifierPreference": "relative"
}
}
}
}
}

禁用 LSP 服务器

要全局禁用**所有** LSP 服务器,请将 lsp 设置为 false

opencode.json
{
"$schema": "https://opencode.ac.cn/config.json",
"lsp": false
}

要禁用**特定** LSP 服务器,请将 disabled 设置为 true

opencode.json
{
"$schema": "https://opencode.ac.cn/config.json",
"lsp": {
"typescript": {
"disabled": true
}
}
}

自定义 LSP 服务器

您可以通过指定命令和文件扩展名来添加自定义 LSP 服务器

opencode.json
{
"$schema": "https://opencode.ac.cn/config.json",
"lsp": {
"custom-lsp": {
"command": ["custom-lsp-server", "--stdio"],
"extensions": [".custom"]
}
}
}

附加信息

PHP Intelephense

PHP Intelephense 通过许可证密钥提供高级功能。您可以通过将(仅)密钥放入以下位置的文本文件中来提供许可证密钥:

  • 在 macOS/Linux 上:$HOME/intelephense/license.txt
  • 在 Windows 上:%USERPROFILE%/intelephense/license.txt

文件应只包含许可证密钥,不含其他内容。