LSP Servers - OpenCode Docs | OpenCode Tutorial

OpenCode 与你的 Language Server Protocol (LSP) 集成，以帮助 LLM 与你的代码库进行交互。它使用诊断信息向 LLM 提供反馈。

##内置

OpenCode 带有几个用于流行语言的内置 LSP 服务器：

| LSP Server | 扩展名 | 要求 | | ------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------ | | 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 命令可用 | | jdtls | .java | Java SDK (version 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 已安装 (xcode 在 macOS 上) | | 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 服务器会自动启用。

Note

📝 注意

你可以通过将 OPENCODE_DISABLE_LSP_DOWNLOAD 环境变量设置为 true 来禁用自动 LSP 服务器下载。

##工作原理

当 opencode 打开一个文件时，它会：

针对所有已启用的 LSP 服务器检查文件扩展名。
启动相应的 LSP 服务器（如果尚未运行）。

##配置

你可以通过 opencode 配置文件中的 lsp 部分自定义 LSP 服务器。

bash

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

每个 LSP 服务器都支持以下属性：

| 属性 | 类型 | 描述 | | ---------------- | -------- | ------------------------------------------------- | | disabled | boolean | 设置为 true 以禁用 LSP 服务器 | | command | string[] | 启动 LSP 服务器的命令 | | extensions | string[] | 此 LSP 服务器应处理的文件扩展名 | | env | object | 启动服务器时要设置的环境变量 | | initialization | object | 要发送到 LSP 服务器的初始化选项 |

让我们看一些例子。

###禁用 LSP 服务器

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

bash

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

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

bash

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

###自定义 LSP 服务器

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

bash

{
  "$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

该文件应仅包含许可证密钥，不包含其他内容。