OpenCodeの設定 - LSPのソースを表示

== 概要 ==
OpenCodeのLSP (Language Server Protocol) 機能は、LLMがコードベースをより深く理解し、正確なコード操作を行うための基盤となる。<br>
LSPを活用することにより、型チェック、エラー検出、定義へのジャンプ、参照の検索、シンボルのリネームといった高度なコード解析機能が利用可能になる。<br>
<br>
OpenCodeは30以上のプログラミング言語に対してLSPサーバを内蔵しており、プロジェクトで使用されている言語を自動検出して適切なサーバを起動する。<br>
ユーザが明示的に設定を行わなくても、TypeScript、Python、Rust、Go等の主要な言語であれば、ファイルを開くだけでLSP機能が有効になる。<br>
<br>
LSPの診断情報はLLMにフィードバックされ、コードの品質向上やエラーの早期発見に貢献する。<br>
LLMはLSPからの診断結果を参照しながらコードを生成・修正するため、型エラーや構文エラーを含むコードが生成される可能性が低くなる。<br>
<br>
OpenCodeはLanguage Server Protocol (LSP) に対応しており、コード解析、定義ジャンプ、参照検索、リネーム等の高度なコードインテリジェンス機能を利用できる。<br>
<br>
また、OpenCodeではカスタムLSPサーバの追加も可能であり、標準でサポートされていない言語や独自のツールチェーンを使用する場合でも、LSPの恩恵を受けることができる。<br>
<br>
設定は、<u>opencode.jsonファイル</u> の <code>lsp</code> セクションで行い、サーバごとに環境変数、初期化オプション、ファイル拡張子のマッピング等を詳細にカスタマイズできる。<br>
<br><br>

== LSPとは ==
Language Server Protocol (LSP) は、Microsoftによって開発されたオープンなプロトコルであり、エディタやIDEと言語サーバ間の通信を標準化するものである。<br>
<br>
==== LSPが解決する課題 ====
従来、各エディタ (VS Code、Vim、Emacs等) ごとに言語サポートを実装する必要があり、同じ機能を複数のエディタで利用できるようにするには多大な労力を要していた。<br>
LSPはこの問題を解決するために設計された。<br>
<br>
LSP以前の状況:<br>
* 各エディタが独自のプラグインAPIを持つ。
*: 言語サポートを提供するには、エディタごとに異なる実装が必要であった。
* 同じ言語機能を複数回実装する必要がある。
*: オートコンプリート、定義ジャンプ、エラー診断等の機能を各エディタ用に個別に実装しなければならなかった。
* 言語ツールのメンテナンスが分散する。
*: 複数の実装を維持する負担が大きく、品質にばらつきが生じた。
<br>
LSP導入後:<br>
* 言語サーバは1度だけ実装すればよい。
*: 任意のLSP対応エディタから利用できる共通の言語サーバを開発できる。
* エディタはLSPクライアントを実装するだけでよい。
*: 様々な言語のサポートを統一的な方法で提供できる。
* 言語コミュニティがサーバ開発に集中できる。
*: 高品質な言語サーバのエコシステムが発展した。
<br>
==== クライアント-サーバアーキテクチャ ====
LSPはクライアント-サーバアーキテクチャを採用している。<br>
<br>
* LSPクライアント (エディタ / IDE)
*: ユーザインターフェースを提供し、ユーザの操作に応じて言語サーバにリクエストを送信する。
*: OpenCodeはLSPクライアントとして動作する。
*: <br>
* LSPサーバ (Language Server)
*: 特定のプログラミング言語に特化した解析エンジンである。
*: コードの解析、診断、補完候補の生成等を行い、結果をクライアントに返す。
<br>
クライアントとサーバ間の通信は、JSON-RPC 2.0をベースとした標準化されたメッセージフォーマットで行われる。<br>
通信方法としては、標準入出力 (stdio)、ソケット、パイプ等が使用できる。<br>
<br>
==== LSPが提供する主な機能 ====
下表に、LSPが標準化している主な機能を示す。<br>
<br>
<center>
{| class="wikitable"
|+ LSPの主要機能
|-
! 機能 !! 説明
|-
| 診断 (Diagnostics) || コード内のエラー、警告、情報を検出して報告する。<br>型エラー、構文エラー、リント警告等が含まれる。
|-
| 定義へのジャンプ (Go to Definition) || シンボルの定義場所に移動する。<br>変数、関数、クラス等の宣言箇所を特定できる。
|-
| 参照の検索 (Find References) || シンボルが参照されている全ての場所を検索する。<br>変数の使用箇所や関数の呼び出し元を確認できる。
|-
| シンボルの検索 (Document/Workspace Symbols) || ファイル内またはワークスペース全体でシンボルを検索する。<br>関数、クラス、変数等を名前で検索できる。
|-
| リネーム (Rename) || シンボルの名前を一括で変更する。<br>全ての参照箇所も同時に更新される。
|-
| ホバー (Hover) || シンボルの上にカーソルを置いた際に型情報やドキュメントを表示する。
|-
| 補完 (Completion) || コード入力中に候補を提示する。<br>関数名、変数名、プロパティ等の補完が含まれる。
|-
| コードアクション (Code Actions) || エラーの修正提案やリファクタリング操作を提供する。<br>クイックフィックスや自動修正等が含まれる。
|}
</center>
<br><br>

== OpenCodeでサポートされるLSPサーバ ==
OpenCodeは多数のプログラミング言語に対してLSPサーバを内蔵している。<br>
これらのサーバは、対応するファイル拡張子が検出された場合に自動的に起動する。<br>
<br>
==== 組み込みLSPサーバ一覧 ====
下表に、OpenCodeでサポートされるLSPサーバとその要件を示す。<br>
<br>
<center>
{| class="wikitable"
|+ 組み込み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コマンドが利用可能であること<br>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以降) がインストールされていること。
|-
| 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がインストールされていること<br>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コマンドが利用可能であること。
|}
</center>
<br>
==== 自起動の仕組み ====
OpenCodeがファイルを開く時、以下に示す手順でLSPサーバが自動的に起動する。<br>
<br>
# ファイルの拡張子を確認する。
# 拡張子に対応するLSPサーバを特定する。
# 対応するLSPサーバがまだ起動していない場合、自動的に起動する。
<br>
この仕組みにより、ユーザは手動でサーバを起動する必要がなく、ファイルを開くだけでLSP機能が利用可能になる。<br>
<br><br>

== LSPの設定方法 ==
LSPサーバの設定は、<u>opencode.jsonファイル</u> の <code>lsp</code> セクションで行う。<br>
<br>
==== 設定構造 ====
設定ファイルの基本構造を以下に示す。<br>
<br>
 <syntaxhighlight lang="json">
 {
    "$schema": "https://opencode.ai/config.json",
    "lsp": {
       "typescript": {
          "disabled": false
       }
    }
 }
 </syntaxhighlight>
<br>
==== 設定項目一覧 ====
各LSPサーバで設定可能な項目を以下の表に示す。<br>
<br>
<center>
{| class="wikitable"
|+ LSP設定項目一覧
|-
! プロパティ !! 型 !! 説明
|-
| <code>disabled</code> || boolean || <code>true</code> に設定すると、そのLSPサーバを無効化する。<br>デフォルトは <u>false</u> である。
|-
| <code>command</code> || string[] || LSPサーバを起動するコマンドと引数の配列<br>カスタムLSPサーバを追加する場合に使用する。
|-
| <code>extensions</code> || string[] || LSPサーバが処理するファイル拡張子の配列<br>例: <u>[".ts", ".tsx"]</u>
|-
| <code>env</code> || object || サーバ起動時に設定する環境変数<br>キーと値のペアで指定する。
|-
| <code>initialization</code> || object || LSPサーバに送信する初期化オプション<br>サーバ固有の設定を渡す時に使用する。
|-
| <code>priority</code> || number || 複数のサーバが同じ拡張子を処理する場合の優先度<br>数値が大きいほど優先度が高い。<br>デフォルトは <u>0</u> である。
|}
</center>
<br>
==== 環境変数の設定 ====
<code>env</code> プロパティを使用して、LSPサーバ起動時の環境変数を設定できる。<br>
<br>
設定例を以下に示す。<br>
<br>
以下に示す設定は、rust-analyzerサーバのデバッグログを有効にする。<br>
<br>
 <syntaxhighlight lang="json">
 {
    "$schema": "https://opencode.ai/config.json",
    "lsp": {
       "rust": {
          "env": {
             "RUST_LOG": "debug",
             "RUST_BACKTRACE": "1"
          }
       }
    }
 }
 </syntaxhighlight>
<br>
==== 初期化オプションの設定 ====
<code>initialization</code> プロパティを使用して、LSPサーバに初期化オプションを渡すことができる。<br>
これらのオプションはLSPの <code>initialize</code> リクエスト時にサーバに送信される。<br>
<br>
TypeScriptサーバの設定例を以下に示す。<br>
<br>
以下に示す設定は、TypeScriptのインポートパスを相対パス形式にし、package.jsonからの自動インポートを有効にする。<br>
<br>
 <syntaxhighlight lang="json">
 {
    "$schema": "https://opencode.ai/config.json",
    "lsp": {
       "typescript": {
          "initialization": {
             "preferences": {
                "importModuleSpecifierPreference": "relative",
                "includePackageJsonAutoImports": "on"
             }
          }
       }
    }
 }
 </syntaxhighlight>
<br>
==== LSPサーバの無効化 ====
特定のLSPサーバを無効化するには、<code>disabled</code> プロパティを <u>true</u> に設定する。<br>
<br>
* 特定のサーバを無効化する例
*: <syntaxhighlight lang="json">
 {
    "$schema": "https://opencode.ai/config.json",
    "lsp": {
       "typescript": {
          "disabled": true
       }
    }
 }
 </syntaxhighlight>
*: <br>
* 全てのLSPサーバを一括で無効化するには、<code>lsp</code> プロパティ全体を <u>false</u> に設定する。
*: <syntaxhighlight lang="json">
 {
    "$schema": "https://opencode.ai/config.json",
    "lsp": false
 }
 </syntaxhighlight>
<br>
==== カスタムLSPサーバの追加 ====
OpenCodeに標準で含まれていない言語やツール用に、カスタムLSPサーバを追加できる。<br>
<br>
カスタムサーバを追加するには、<code>command</code> と <code>extensions</code> を指定する。<br>
<br>
カスタムLSPサーバの追加例を以下に示す。<br>
<br>
 <syntaxhighlight lang="json">
 {
    "$schema": "https://opencode.ai/config.json",
    "lsp": {
       "custom-lsp": {
          "command": ["custom-lsp-server", "--stdio"],
          "extensions": [".custom", ".cust"]
       }
    }
 }
 </syntaxhighlight>
<br>
カスタムLSPサーバを追加する時の注意点を以下に示す。<br>
* <code>command</code> には、サーバがstdioモードで動作するように <code>--stdio</code> フラグを含める必要がある。
* <code>extensions</code> には、先頭にドットを含めた拡張子を指定する。
*: 例: <code>[".ts"]</code> (正)、<code>["ts"]</code> (誤)
* 指定したコマンドがシステムの環境変数 <code>PATH</code> に含まれていることを確認する。
<br>
==== 優先度の設定 ====
複数のLSPサーバが同じファイル拡張子を処理する場合、<code>priority</code> で優先順位を制御できる。<br>
数値が大きいほど優先度が高く、優先的に使用される。<br>
<br>
優先度設定の例を以下に示す。<br>
<br>
以下の例では、TypeScriptファイルに対して、typescript-language-serverが優先的に使用される。<br>
<br>
 <syntaxhighlight lang="json">
 {
    "$schema": "https://opencode.ai/config.json",
    "lsp": {
       "typescript-language-server": {
          "command": ["typescript-language-server", "--stdio"],
          "extensions": [".ts", ".tsx"],
          "priority": 10
       },
       "eslint": {
          "command": ["vscode-eslint-language-server", "--stdio"],
          "extensions": [".ts", ".tsx", ".js", ".jsx"],
          "priority": 5
       }
    }
 }
 </syntaxhighlight>
<br><br>

== 利用可能なLSPツール ==
OpenCodeは、LSP機能を利用するための複数のツールを提供している。<br>
これらのツールを使用することにより、コード解析、ナビゲーション、リファクタリング等の操作をプログラム的に実行できる。<br>
<br>
==== lsp_diagnostics ====
ファイルまたはプロジェクト全体の診断情報 (エラー、警告、ヒント) を取得するツールである。<br>
<br>
===== パラメータ =====
<center>
{| class="wikitable"
|+ lsp_diagnosticsパラメータ
|-
! パラメータ !! 型 !! 必須 !! 説明
|-
| <code>filePath</code> || string || はい || 診断を取得するファイルのパス。<br>絶対パスまたは相対パスで指定する。
|-
| <code>severity</code> || string || いいえ || 取得する診断の重要度をフィルタリングする。<br>値: <code>"error"</code>, <code>"warning"</code>, <code>"information"</code>, <code>"hint"</code>, <code>"all"</code><br>デフォルト: <u>"all"</u>
|}
</center>
<br>
===== 使用例 =====
 <syntaxhighlight lang="typescript">
 // 特定ファイルの全ての診断を取得
 lsp_diagnostics({ filePath: "/path/to/file.ts" })
 
 // エラーのみを取得
 lsp_diagnostics({ filePath: "/path/to/file.ts", severity: "error" })
 </syntaxhighlight>
<br>
===== ユースケース =====
* コード変更前にエラーの有無を確認する。
*: 変更を加える前に現在のエラー状態を把握し、変更による影響を評価できる。
*: <br>
* ビルド前に型チェックを行う。
*: ビルドコマンドを実行する前に、型エラーがないことを確認できる。
*: <br>
* コードレビュー時の品質チェック
*: 変更されたファイルの診断情報を確認し、潜在的な問題を特定できる。
<br>
==== lsp_goto_definition ====
シンボルの定義場所にジャンプするツールである。<br>
変数、関数、クラス等の宣言箇所を特定できる。<br>
<br>
===== パラメータ =====
<center>
{| class="wikitable"
|+ lsp_goto_definitionパラメータ
|-
! パラメータ !! 型 !! 必須 !! 説明
|-
| <code>filePath</code> || string || はい || 対象ファイルのパス
|-
| <code>line</code> || number || はい || シンボルの行番号 (1始まり)
|-
| <code>character</code> || number || はい || シンボルの列番号 (0始まり)
|}
</center>
<br>
===== 使用例 =====
 <syntaxhighlight lang="typescript">
 // 変数の定義場所を取得
 lsp_goto_definition({
    filePath: "/path/to/file.ts",
    line: 10,
    character: 15
 })
 </syntaxhighlight>
<br>
===== ユースケース =====
* 関数の実装を確認する。
*: 関数呼び出し箇所から定義に移動し、実装の詳細を確認できる。
*: <br>
* インポート元のモジュールを特定する。
*: インポートされたシンボルの元の定義場所を特定できる。<
*: <br>
* 型定義の確認
*: 使用されている型の定義を確認し、型の構造を理解できる。
<br>
==== lsp_find_references ====
シンボルが参照されている全ての場所を検索するツールである。<br>
ワークスペース全体を対象に検索を行う。<br>
<br>
===== パラメータ =====
<center>
{| class="wikitable"
|+ lsp_find_referencesパラメータ
|-
! パラメータ !! 型 !! 必須 !! 説明
|-
| <code>filePath</code> || string || はい || 対象ファイルのパス
|-
| <code>line</code> || number || はい || シンボルの行番号 (1始まり)
|-
| <code>character</code> || number || はい || シンボルの列番号 (0始まり)
|-
| <code>includeDeclaration</code> || boolean || いいえ || 定義箇所も結果に含めるかどうか。<br>デフォルト: <code>true</code>
|}
</center>
<br>
===== 使用例 =====
 <syntaxhighlight lang="typescript">
 // 関数の全ての使用箇所を検索
 lsp_find_references({
    filePath: "/path/to/file.ts",
    line: 5,
    character: 10,
    includeDeclaration: true
 })
 </syntaxhighlight>
<br>
===== ユースケース =====
* リファクタリング前の影響範囲調査
*: 変数や関数を変更する前に、影響を受ける箇所を全て把握できる。
*: <br>
* 未使用コードの検出
*: 参照が1つも見つからない場合、そのシンボルが未使用である可能性が高い。
*: <br>
* 依存関係の分析
*: 特定のモジュールや関数がどこで使用されているかを確認できる。
<br>
==== lsp_symbols ====
ファイルまたはワークスペース内のシンボルを検索するツールである。<br>
ドキュメントスコープとワークスペーススコープの2つのモードを持つ。<br>
<br>
===== パラメータ =====
<center>
{| class="wikitable"
|+ lsp_symbolsパラメータ
|-
! パラメータ !! 型 !! 必須 !! 説明
|-
| <code>filePath</code> || string || はい || 対象ファイルのパス
|-
| <code>scope</code> || string || いいえ || 検索スコープ<br>値: <code>"document"</code> (ファイル内), <code>"workspace"</code> (プロジェクト全体)<br>デフォルト: <u>"document"</u>
|-
| <code>query</code> || string || いいえ || 検索クエリ<br>シンボル名の一部を指定してフィルタリングできる。
|-
| <code>limit</code> || number || いいえ || 返される結果の最大数
|}
</center>
<br>
===== 使用例 =====
 <syntaxhighlight lang="typescript">
 // ファイル内のシンボル一覧を取得
 lsp_symbols({
    filePath: "/path/to/file.ts",
    scope: "document"
 })
 
 // ワークスペース全体から特定のクラスを検索
 lsp_symbols({
    filePath: "/path/to/file.ts",
    scope: "workspace",
    query: "UserService"
 })
 </syntaxhighlight>
<br>
===== ユースケース =====
* ファイル構造の把握
*: ファイル内の関数、クラス、変数の一覧を確認し、コードの全体像を把握できる。
*: <br>
* プロジェクト全体のシンボル検索
*: 特定の名前を持つクラスや関数をプロジェクト全体から検索できる。
*: <br>
* APIの探索
*: 公開されている関数やクラスを素早く見つけられる。
<br>
==== lsp_prepare_rename ====
シンボルのリネームが可能かどうかを確認するツールである。<br>
実際のリネームを行う前に、そのシンボルがリネーム可能かどうかを検証するために使用する。<br>
<br>
===== パラメータ =====
<center>
{| class="wikitable"
|+ lsp_prepare_renameパラメータ
|-
! パラメータ !! 型 !! 必須 !! 説明
|-
| <code>filePath</code> || string || はい || 対象ファイルのパス
|-
| <code>line</code> || number || はい || シンボルの行番号 (1始まり)
|-
| <code>character</code> || number || はい || シンボルの列番号 (0始まり)
|}
</center>
<br>
===== 使用例 =====
 <syntaxhighlight lang="typescript">
 // リネームが可能か確認
 const result = lsp_prepare_rename({
    filePath: "/path/to/file.ts",
    line: 10,
    character: 5
 })
 
 if (result) {
    // リネームが可能
    lsp_rename({ ... })
 }
 </syntaxhighlight>
<br>
===== ユースケース =====
* リネーム前の検証
*: 実際にリネームを実行する前に、そのシンボルがリネーム可能かどうかを確認できる。
*: <br>
* 編集可能範囲の特定
*: リネーム時にどの範囲が編集されるかを事前に把握できる。
<br>
==== lsp_rename ====
シンボルの名前を一括で変更するツールである。<br>
ワークスペース内の全ての参照箇所も同時に更新される。<br>
<br>
===== パラメータ =====
<center>
{| class="wikitable"
|+ lsp_renameパラメータ
|-
! パラメータ !! 型 !! 必須 !! 説明
|-
| <code>filePath</code> || string || はい || 対象ファイルのパス
|-
| <code>line</code> || number || はい || シンボルの行番号 (1始まり)
|-
| <code>character</code> || number || はい || シンボルの列番号 (0始まり)
|-
| <code>newName</code> || string || はい || 新しいシンボル名
|}
</center>
<br>
===== 使用例 =====
 <syntaxhighlight lang="typescript">
 // 変数名を変更
 lsp_rename({
    filePath: "/path/to/file.ts",
    line: 10,
    character: 5,
    newName: "newVariableName"
 })
 </syntaxhighlight>
<br>
===== ユースケース =====
* 変数名の変更
*: 意味不明な変数名をより適切な名前に変更できる。
*: <br>
* 関数名のリファクタリング
*: 関数の目的に合った名前に変更し、ソースコードの可読性を向上できる。
*: <br>
* クラス名の変更
*: クラスの役割をより正確に表す名前に変更できる。
<br>
===== リネームの注意点 =====
* リネームはプロジェクト全体に影響する<br>
*: ワークスペース内の全ての参照箇所が更新されるため、変更前に影響範囲を確認することが推奨される。<br>
*: <br>
* 一部のシンボルはリネームできない<br>
*: 標準ライブラリのシンボルや外部パッケージのシンボルはリネームできない場合がある。<br>
*: <br>
* <code>lsp_prepare_rename</code> で事前確認を推奨<br>
*: リネームを実行する前に、<code>lsp_prepare_rename</code> でリネームが可能かどうかを確認することを推奨する。<br>
<br><br>

== 設定例 ==
言語別のLSPの設定例を以下に示す。<br>
<br>
==== TypeScript / JavaScript ====
TypeScriptおよびJavaScriptプロジェクトの設定例を以下に示す。<br>
<br>
 <syntaxhighlight lang="json">
 {
    "$schema": "https://opencode.ai/config.json",
    "lsp": {
       "typescript": {
          "initialization": {
             "preferences": {
                "importModuleSpecifierPreference": "relative",
                "includePackageJsonAutoImports": "on"
             }
          }
       }
    }
 }
 </syntaxhighlight>
<br>
==== Python ====
Pythonプロジェクト (pyright使用) の設定例を以下に示す。<br>
<br>
 <syntaxhighlight lang="json">
 {
    "$schema": "https://opencode.ai/config.json",
    "lsp": {
       "pyright": {
          "env": {
             "PYTHONPATH": "./src"
          }
       }
    }
 }
 </syntaxhighlight>
<br>
==== Rust ====
Rustプロジェクト (rust-analyzer使用) の設定例を以下に示す。<br>
<br>
 <syntaxhighlight lang="json">
 {
    "$schema": "https://opencode.ai/config.json",
    "lsp": {
       "rust": {
          "initialization": {
             "checkOnSave": {
                "command": "clippy"
             },
             "cargo": {
                "features": "all"
             }
          }
       }
    }
 }
 </syntaxhighlight>
<br>
==== 複数サーバの併用 ====
TypeScriptファイルに対して、typescriptサーバとeslintサーバを併用する設定例を以下に示す。<br>
<br>
以下に示す設定では、typescriptサーバが主要なソースコード解析を担当し、eslintサーバがリント機能を提供する。<br>
<br>
 <syntaxhighlight lang="json">
 {
    "$schema": "https://opencode.ai/config.json",
    "lsp": {
       "typescript": {
          "extensions": [".ts", ".tsx", ".js", ".jsx"],
          "priority": 10
       },
       "eslint": {
          "extensions": [".ts", ".tsx", ".js", ".jsx"],
          "priority": 5
       }
    }
 }
 </syntaxhighlight>
<br><br>

== LSPの動作原理 ==
==== ファイルオープン時の処理フロー ====
ユーザがファイルを開いた時、OpenCodeは以下に示す順番で処理を実行する。<br>
<br>
# ファイル拡張子の確認
#: 開かれたファイルの拡張子を抽出する。
#: <br>
# LSPサーバのマッチング
#: 拡張子に対応するLSPサーバを検索する。
#: 複数のサーバが一致する場合は、優先度が最も高いサーバを選択する。
#: <br>
# サーバの起動確認
#: 選択されたLSPサーバが既に起動しているか確認する。
#: 起動していない場合は、新たにサーバプロセスを起動する。
#: <br>
# ファイルの同期
#: ファイルの内容をLSPサーバに同期する。
#: サーバは内容を解析して、診断情報を生成する。
#: <br>
# 診断情報の受信
#: LSPサーバからの診断情報を受信し、OpenCodeの内部状態を更新する。
#: 診断情報はLLMにフィードバックされる。
<br>
==== LSP通信の流れ ====
LSPクライアントとサーバ間の通信は、JSON-RPC 2.0フォーマットで行われる。<br>
<br>
主な通信パターンを以下に示す。<br>
<br>
* リクエスト-レスポンス
*: クライアントがリクエストを送信して、サーバがレスポンスを返す。
*: 例: 定義へのジャンプ、参照の検索
*: <br>
* 通知
*: 一方向のメッセージ
*: 応答を期待しない。
*: 例: ファイルの変更通知、設定の更新
*: <br>
* サーバからのプッシュ
*: サーバからクライアントへの能動的な通知
*: 例: 診断情報の更新、ログメッセージ
<br>
==== 診断情報の活用 ====
LSPサーバから提供される診断情報は、以下のように活用される。<br>
<br>
* LLMへのフィードバック
*: 診断情報はLLMに提供され、コード生成や修正の品質向上に活用される。
*: <br>
* エラーの早期発見
*: コード編集中にリアルタイムでエラーが検出され、即座にフィードバックが提供される。
*: <br>
* 品質の可視化
*: エラーや警告の数を把握し、コード品質の現状を確認できる。
<br><br>

== 推奨される事柄 ==
==== 適切な優先度設定 ====
複数のLSPサーバが同じファイル拡張子を処理する場合、適切な優先度を設定することが重要である。<br>
<br>
推奨される優先度設定のガイドラインを以下に示す。<br>
<br>
* プライマリ言語サーバ : 優先度 10
*: メインのソースコード解析を担当するサーバには高い優先度を設定する。
*: 例: TypeScriptプロジェクトでのtypescriptサーバ
*: <br>
* リンター / フォーマッター : 優先度 5
*: リント機能を提供するサーバには中程度の優先度を設定する。
*: 例: eslintサーバ
*: <br>
* 補助的なサーバ : 優先度 1
*: 補助的な機能を提供するサーバには低い優先度を設定する。
*: 例: prettierサーバ
<br>
==== 不要なサーバの無効化 ====
使用しないLSPサーバは無効化することにより、リソースの節約とパフォーマンスの向上が期待できる。<br>
<br>
無効化が推奨されるケースを以下に示す。<br>
<br>
* プロジェクトで使用しない言語のサーバ
*: 例: PythonプロジェクトでTypeScriptサーバを使用しない場合
*: <br>
* 競合する機能を持つサーバ
*: 複数のサーバが同じ機能を提供し、競合が発生する場合
*: <br>
* パフォーマンスに問題があるサーバ
*: 特定のサーバが原因で動作が遅くなる場合
<br>
==== 環境変数の設定 ====
LSPサーバが必要とする環境変数は、<u>opencode.jsonファイル</u> で明示的に設定することを推奨する。<br>
<br>
設定が推奨される環境変数の例を以下に示す。<br>
<br>
* PYTHONPATH (Pythonサーバ)
*: モジュールの検索パスを明示的に指定する。
*: <br>
* RUST_LOG (Rustサーバ)
*: デバッグ時のログレベルを制御する。
*: <br>
* JAVA_HOME (Javaサーバ)
*: Javaのインストール場所を明示する。
<br>
==== プロジェクト固有の設定 ====
LSPの設定はプロジェクトごとに異なる場合が多いため、プロジェクトルートの <u>opencode.jsonファイル</u> に設定を記述することを推奨する。<br>
<br>
プロジェクト固有の設定のメリットを以下に示す。<br>
<br>
* チーム間での設定共有
*: バージョン管理システムを通じて設定を共有できる。
*: <br>
* プロジェクトごとの最適化
*: 各プロジェクトの特性に合わせた設定が可能である。
*: <br>
* 設定の分離
*: グローバル設定とプロジェクト設定を分離できる。
<br><br>

== トラブルシューティング ==
==== LSPサーバが起動しない ====
===== コマンドの確認 =====
指定したコマンドがシステムの環境変数 <code>PATH</code> に含まれているか確認する。<br>
<br>
 # コマンドが存在するか確認
 which typescript-language-server
 
 # バージョンを確認
 typescript-language-server --version
<br>
===== 要件の確認 =====
LSPサーバの要件を満たしているか確認する。<br>
<br>
* 必要なSDKがインストールされているか
*: 例: csharpサーバには.NET SDKが必要
*: <br>
* 必要な依存関係がプロジェクトに存在するか
*: 例: typescriptサーバにはtypescriptパッケージが必要
<br>
===== stdioモードの確認 =====
カスタムLSPサーバを追加する場合、サーバがstdioモードで動作することを確認する。<br>
多くのLSPサーバは <code>--stdio</code> フラグでstdioモードを有効にできる。<br>
<br>
==== LSPサーバが応答しない ====
===== ファイル拡張子の設定確認 =====
<code>extensions</code> の設定が正しいか確認する。<br>
<br>
 <syntaxhighlight lang="json">
 {
    "lsp": {
       "typescript": {
          "extensions": [".ts", ".tsx"]
       }
    }
 }
 </syntaxhighlight>
<br>
===== 優先度の確認 =====
複数のサーバが同じ拡張子を処理する場合、優先度が適切に設定されているか確認する。<br>
<br>
===== サーバの無効化状態の確認 =====
サーバが誤って無効化されていないか確認する。<br>
<br>
==== パフォーマンスの問題 ====
LSPの動作が遅い場合、以下に示す対策を検討する。<br>
<br>
===== 不要なサーバの無効化 =====
使用しないLSPサーバを無効化してリソースを節約する。<br>
<br>
 <syntaxhighlight lang="json">
 {
    "lsp": {
       "unused-server": {
          "disabled": true
       }
    }
 }
 </syntaxhighlight>
<br>
===== 大規模プロジェクトでの対策 =====
大規模プロジェクトでは、以下の対策が有効な場合がある。<br>
<br>
* ファイル監視の除外設定
*: <code>watcher.ignore</code> でノイズの多いディレクトリを除外する。
*: <br>
* 初期化オプションの調整
*: サーバ固有の設定でインデックス範囲を制限する。
<br>
==== 診断情報が表示されない ====
===== LSPサーバの状態確認 =====
サーバが正常に起動しているか確認する。<br>
<br>
===== ファイルの同期状態確認 =====
ファイルがLSPサーバに正しく同期されているか確認する。<br>
ファイルを保存して再読み込みすることで、再同期を試行できる。<br>
<br>
===== サーバ設定の確認 =====
診断機能が有効になっているか、サーバの設定を確認する。<br>
一部のサーバでは、診断機能を明示的に有効にする必要がある場合がある。<br>
<br><br>

== PHP Intelephenseの特別な設定 ==
PHP Intelephenseは、ライセンスキーを設定することでプレミアム機能を利用できる。<br>
<br>
==== ライセンスキーの設定方法 ====
ライセンスキーは、以下に示すパスにテキストファイルとして配置する。<br>
<br>
* MacOS / Linux
*: <u>~/intelephense/license.txt</u>
*: <br>
* Windows
*: <u>%USERPROFILE%/intelephense/license.txt</u>
<br>
ファイルにはライセンスキーのみを記述し、他の内容を含めないように注意する。<br>
<br><br>

== 参考リンク ==
* [https://opencode.ai/docs/lsp/ OpenCode公式ドキュメント - LSP Servers]
* [https://opencode.ai/docs/config/ OpenCode公式ドキュメント - Config]
* [https://ohmyopencode.com/lsp/ Oh My OpenCode - LSP Support]
* [https://microsoft.github.io/language-server-protocol/ Language Server Protocol公式サイト]
* [https://langserver.org/ Langserver.org - LSP実装一覧]
<br><br>


{{#seo:
|title={{PAGENAME}} : Exploring Electronics and SUSE Linux | MochiuWiki
|keywords=MochiuWiki,Mochiu,Wiki,Mochiu Wiki,OpenCode,LSP,Language Server Protocol,TypeScript,Python,Rust,Go,Java,C++,JavaScript,設定,Configuration,Development,Programming,SUSE,Linux
|description={{PAGENAME}} - OpenCodeのLSP設定に関するガイド | This page is {{PAGENAME}} in our wiki about electronic circuits and SUSE Linux
|image=/resources/assets/MochiuLogo_Single_Blue.png
}}

__FORCETOC__
[[カテゴリ:設定]]