File size: 9,950 Bytes
89a2873 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | ---
title: LSP 伺服器
description: OpenCode 與您的 LSP 伺服器整合。
---
OpenCode 可以與語言伺服器協定（LSP）伺服器整合，將診斷資訊作為 agent 的回饋。
---
## 內建支援
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 (version 21+)` |
| julials | .jl | 需要已安裝 `julia` 和 `LanguageServer.jl` |
| 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 預設關閉。啟用後，當偵測到上述檔案副檔名且滿足相應要求時，伺服器會啟動。
:::note
您可以將 `OPENCODE_DISABLE_LSP_DOWNLOAD` 環境變數設定為 `true` 來停用 LSP 伺服器的自動下載。
:::
---
## 工作原理
啟用 LSP 且 OpenCode 開啟檔案時，它會：
1. 將檔案副檔名與所有已啟用的 LSP 伺服器進行比對。
2. 如果對應的 LSP 伺服器尚未執行，則自動啟動它。
---
## 最佳實踐
LSP 可以透過語言伺服器診斷幫助 agent 發現並修復問題。這對某些專案很有用，但不一定總是帶來淨收益。
語言伺服器可能與專案不同步、佔用較多記憶體、隨版本或專案表現不同，並拖慢 agent 工作流程。在許多專案中，更好的做法是讓 agent 直接執行 lint、typecheck 或其他診斷類 CLI 工具，這樣錯誤會回到 agent 循環，同時避免這些取捨。將這些指令記錄在 `AGENTS.md` 或 skills 等指示檔中，讓 agent 知道該執行什麼。當您的專案能從額外的語言伺服器回饋中受益時再啟用 LSP。
---
## 設定
您可以透過 OpenCode 設定檔中的 `lsp` 部分來啟用並自訂 LSP 伺服器。
要啟用所有內建 LSP 伺服器，請將 `lsp` 設定為 `true`。
```json title="opencode.json"
{
"$schema": "https://opencode.ai/config.json",
"lsp": true
}
```
使用物件可以在保持內建伺服器啟用的同時設定覆寫項或自訂伺服器。
```json title="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 伺服器時設定環境變數：
```json title="opencode.json" {5-7}
{
"$schema": "https://opencode.ai/config.json",
"lsp": {
"rust": {
"env": {
"RUST_LOG": "debug"
}
}
}
}
```
---
### 初始化選項
使用 `initialization` 屬性向 LSP 伺服器傳遞初始化選項。這些是在 LSP `initialize` 請求期間傳送的伺服器特定設定：
```json title="opencode.json" {5-9}
{
"$schema": "https://opencode.ai/config.json",
"lsp": {
"typescript": {
"initialization": {
"preferences": {
"importModuleSpecifierPreference": "relative"
}
}
}
}
}
```
:::note
初始化選項因 LSP 伺服器而異。請查閱您所使用的 LSP 伺服器的文件以了解可用選項。
:::
---
### 停用 LSP 伺服器
如果省略 `lsp`，所有 LSP 伺服器都會被停用。如果另一個設定啟用了 LSP，可將 `lsp` 設定為 `false` 來停用所有 LSP 伺服器：
```json title="opencode.json" {3}
{
"$schema": "https://opencode.ai/config.json",
"lsp": false
}
```
要停用**特定的** LSP 伺服器，將 `disabled` 設定為 `true`：
```json title="opencode.json" {5}
{
"$schema": "https://opencode.ai/config.json",
"lsp": {
"typescript": {
"disabled": true
}
}
}
```
---
### 自訂 LSP 伺服器
您可以透過指定指令和檔案副檔名來新增自訂 LSP 伺服器：
```json title="opencode.json" {4-7}
{
"$schema": "https://opencode.ai/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`
該檔案應僅包含授權金鑰，不要新增其他任何內容。
|