lsp.mdx 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  1. ---
  2. title: LSP-серверы
  3. description: opencode интегрируется с вашими серверами LSP.
  4. ---
  5. opencode может интегрироваться с серверами Language Server Protocol (LSP), чтобы использовать диагностику как обратную связь для агента.
  6. ---
  7. ## Встроенные
  8. opencode поставляется с несколькими встроенными LSP-серверами для популярных языков:
  9. | LSP Server | Extensions | Requirements |
  10. | ------------------ | ------------------------------------------------------------------- | ------------------------------------------------------------------------- |
  11. | astro | .astro | Автоматически устанавливается для проектов Astro |
  12. | bash | .sh, .bash, .zsh, .ksh | Автоматически устанавливает bash-language-server |
  13. | clangd | .c, .cpp, .cc, .cxx, .c++, .h, .hpp, .hh, .hxx, .h++ | Автоматически устанавливается для проектов C/C++ |
  14. | csharp | .cs | `.NET SDK` установлен |
  15. | clojure-lsp | .clj, .cljs, .cljc, .edn | `clojure-lsp` команда доступна |
  16. | dart | .dart | `dart` команда доступна |
  17. | deno | .ts, .tsx, .js, .jsx, .mjs | `deno` команда доступна (автоматически обнаруживает deno.json/deno.jsonc) |
  18. | elixir-ls | .ex, .exs | `elixir` команда доступна |
  19. | eslint | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vue | `eslint` зависимость в проекте |
  20. | fsharp | .fs, .fsi, .fsx, .fsscript | `.NET SDK` установлен |
  21. | gleam | .gleam | `gleam` команда доступна |
  22. | gopls | .go | `go` команда доступна |
  23. | hls | .hs, .lhs | `haskell-language-server-wrapper` команда доступна |
  24. | jdtls | .java | `Java SDK (version 21+)` установлен |
  25. | kotlin-ls | .kt, .kts | Автоматически устанавливается для проектов Kotlin |
  26. | lua-ls | .lua | Автоматически устанавливается для проектов Lua |
  27. | nixd | .nix | `nixd` команда доступна |
  28. | ocaml-lsp | .ml, .mli | `ocamllsp` команда доступна |
  29. | oxlint | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts, .vue, .astro, .svelte | `oxlint` зависимость в проекте |
  30. | php intelephense | .php | Автоматически устанавливается для проектов PHP |
  31. | prisma | .prisma | `prisma` команда доступна |
  32. | pyright | .py, .pyi | `pyright` зависимость установлена |
  33. | ruby-lsp (rubocop) | .rb, .rake, .gemspec, .ru | `ruby` и `gem` команды доступны |
  34. | rust | .rs | `rust-analyzer` команда доступна |
  35. | sourcekit-lsp | .swift, .objc, .objcpp | `swift` установлен (`xcode` на macOS) |
  36. | svelte | .svelte | Автоматически устанавливается для проектов Svelte |
  37. | terraform | .tf, .tfvars | Автоматически устанавливается из релизов GitHub |
  38. | tinymist | .typ, .typc | Автоматически устанавливается из релизов GitHub |
  39. | typescript | .ts, .tsx, .js, .jsx, .mjs, .cjs, .mts, .cts | `typescript` зависимость в проекте |
  40. | vue | .vue | Автоматически устанавливается для проектов Vue |
  41. | yaml-ls | .yaml, .yml | Автоматически устанавливает Red Hat yaml-language-server |
  42. | zls | .zig, .zon | `zig` команда доступна |
  43. LSP отключен по умолчанию. Когда он включен, серверы запускаются при обнаружении одного из указанных выше расширений файлов и выполнении требований.
  44. :::note
  45. Вы можете отключить автоматическую загрузку LSP-сервера, установив для переменной среды `OPENCODE_DISABLE_LSP_DOWNLOAD` значение `true`.
  46. :::
  47. ---
  48. ## Как это работает
  49. Когда LSP включен и opencode открывает файл, он:
  50. 1. Проверяет расширение файла на всех включенных серверах LSP.
  51. 2. Запускает соответствующий сервер LSP, если он еще не запущен.
  52. ---
  53. ## Рекомендации
  54. LSP может помочь агенту находить и исправлять проблемы, предоставляя диагностику от языковых серверов. Это полезно в некоторых проектах, но не всегда является однозначным преимуществом.
  55. Языковые серверы могут рассинхронизироваться, потреблять много памяти, отличаться по поведению между версиями или проектами и замедлять рабочие процессы агента. Во многих проектах лучше, чтобы агент напрямую запускал lint, typecheck или другие диагностические CLI-инструменты; так ошибки возвращаются в цикл агента без этих компромиссов. Задокументируйте эти команды в файлах инструкций, например `AGENTS.md` или skills, чтобы агент знал, что запускать. Включайте LSP, когда проект получает пользу от дополнительной обратной связи языкового сервера.
  56. ---
  57. ## Настройка
  58. Вы можете включить и настроить серверы LSP через раздел `lsp` в конфигурации opencode.
  59. Чтобы включить все встроенные LSP-серверы, установите `lsp` в `true`.
  60. ```json title="opencode.json"
  61. {
  62. "$schema": "https://opencode.ai/config.json",
  63. "lsp": true
  64. }
  65. ```
  66. Используйте объект, чтобы оставить встроенные серверы включенными и при этом настроить переопределения или пользовательские серверы.
  67. ```json title="opencode.json"
  68. {
  69. "$schema": "https://opencode.ai/config.json",
  70. "lsp": {}
  71. }
  72. ```
  73. Каждый LSP-сервер поддерживает следующее:
  74. | Свойство | Тип | Описание |
  75. | ---------------- | -------- | --------------------------------------------------------------------------- |
  76. | `disabled` | boolean | Установите для этого параметра значение `true`, чтобы отключить сервер LSP. |
  77. | `command` | string[] | Команда запуска LSP-сервера |
  78. | `extensions` | string[] | Расширения файлов, которые должен обрабатывать этот сервер LSP |
  79. | `env` | object | Переменные среды, которые нужно установить при запуске сервера |
  80. | `initialization` | object | Параметры инициализации для отправки на сервер LSP |
  81. Давайте посмотрим на несколько примеров.
  82. ---
  83. ### Переменные среды
  84. Используйте свойство `env` для установки переменных среды при запуске сервера LSP:
  85. ```json title="opencode.json" {5-7}
  86. {
  87. "$schema": "https://opencode.ai/config.json",
  88. "lsp": {
  89. "rust": {
  90. "env": {
  91. "RUST_LOG": "debug"
  92. }
  93. }
  94. }
  95. }
  96. ```
  97. ---
  98. ### Параметры инициализации
  99. Используйте свойство `initialization` для передачи параметров инициализации на LSP-сервер. Это настройки, специфичные для сервера, отправляемые во время запроса LSP `initialize`:
  100. ```json title="opencode.json" {5-9}
  101. {
  102. "$schema": "https://opencode.ai/config.json",
  103. "lsp": {
  104. "typescript": {
  105. "initialization": {
  106. "preferences": {
  107. "importModuleSpecifierPreference": "relative"
  108. }
  109. }
  110. }
  111. }
  112. }
  113. ```
  114. :::note
  115. Параметры инициализации зависят от сервера LSP. Проверьте документацию вашего LSP-сервера на наличие доступных опций.
  116. :::
  117. ---
  118. ### Отключение LSP-серверов
  119. Если `lsp` не указан, все LSP-серверы отключены. Чтобы отключить все LSP-серверы после того, как другая конфигурация их включила, установите для `lsp` значение `false`:
  120. ```json title="opencode.json" {3}
  121. {
  122. "$schema": "https://opencode.ai/config.json",
  123. "lsp": false
  124. }
  125. ```
  126. Чтобы отключить **конкретный** LSP-сервер, установите для `disabled` значение `true`:
  127. ```json title="opencode.json" {5}
  128. {
  129. "$schema": "https://opencode.ai/config.json",
  130. "lsp": {
  131. "typescript": {
  132. "disabled": true
  133. }
  134. }
  135. }
  136. ```
  137. ---
  138. ### Пользовательские LSP-серверы
  139. Вы можете добавить собственные LSP-серверы, указав команду и расширения файлов:
  140. ```json title="opencode.json" {4-7}
  141. {
  142. "$schema": "https://opencode.ai/config.json",
  143. "lsp": {
  144. "custom-lsp": {
  145. "command": ["custom-lsp-server", "--stdio"],
  146. "extensions": [".custom"]
  147. }
  148. }
  149. }
  150. ```
  151. ---
  152. ## Дополнительная информация
  153. ### PHP Intelephense
  154. PHP Intelephense предлагает дополнительные функции через лицензионный ключ. Вы можете предоставить лицензионный ключ, поместив (только) ключ в текстовый файл по адресу:
  155. - В macOS/Linux: `$HOME/intelephense/license.txt`
  156. - В Windows: `%USERPROFILE%/intelephense/license.txt`
  157. Файл должен содержать только лицензионный ключ без какого-либо дополнительного содержимого.