gopls で知る言語サーバー

最近「言語サーバーって何？」と興味を持ち、 Go の言語サーバー gopls を通じて仕組みを調べてみました。 本 LT では、 LSP の基本や gopls の動作、そして自作クライアントで直接会話してみた体験を紹介します。

Transcript

1. gopls で知る言語サーバー 1
2. 自己紹介 名前：yushin （初めてのLT で緊張してます ） 経歴 前職：web/mobile アプリ(Go, kotlin, swift, ruby) 現職：生成AI 絡みアプリ(python, typescript) 2
3. なぜこのテーマを選んだのか 今年に「言語サーバー」という言葉を初めて聞いた → 色々調べたいけど... → golang.tokyo のLT 枠が空いていた 3
4. 発表の流れ 1. 言語サーバーとは何か？（大まかな処理の流れの説明） 2. hover を例にLSP 通信 3. セマンティックトークン取得処理 4
5. 言語サーバーとは エディタなどのプログラミング補助ツール 主な機能： 定義元ジャンプ（Definition ） ホバー時のポップアップ（Hover ） エラー・警告のハイライト（Diagnostics ） コード補完（Completion ） シンタックスハイライト（Semantic Token ） 5
6. 全体の流れ 6
7. hover 時のLSP 通信 initialize → didOpen → hover の流れを観察 LSP のリクエスト・レスポンスを可視化 7
8. initialize リクエスト・レスポンス {"jsonrpc":"2.0","id":1,"method":"initialize" ...} {"jsonrpc":"2.0","result":{"capabilities":{"hoverProvider":true, ...}}} LSP 通信のフォーマットはJSON-RPC クライアントがサーバーに自身の情報や機能を伝える サーバーが対応可能な機能一覧を返す hoverProvider （ホバー機能が有効か） tokenTypes （有効なセマンティックトークン）などなど 8
9. didOpen リクエスト { "jsonrpc":"2.0", "method":"textDocument/didOpen", "params":{ "textDocument":{ "uri":"file:///Users/yushinmatsuura/playground/gopls/temp.go", "languageId":"go", "version":1, "text":"package main\n..." }}} サーバーがファイル内容を受け取り、解析を開始 コードの同期のための処理でdidChange などもある 9
10. hover リクエスト・レスポンス { "jsonrpc":"2.0", "id":2, "method":"textDocument/hover", "params":{ "textDocument":{ "uri":"file:///Users/yushinmatsuura/playground/gopls/temp.go" }, "position":{"line":7,"character":10} }} 指定位置の情報取得をリクエスト 10
11. hover レスポンス { "jsonrpc":"2.0", "result":{ "contents":{ "kind":"markdown", "value":"```go\nvar values []int\n```" }, "range":{ "start":{"line":7,"character":9},"end":{"line":7,"character":15} } }, "id":2 } 11
12. hover 12
13. セマンティックトークンの深掘り 1. didOpen などでテキストを読み込む 2. textDocument/semanticTokens/full メソッドなどでセマンティック トークンを取得 ast node からセマンティックトークンを作成 DLP レスポンスのためにエンコード 3. クライアントがレスポンスを受け取り、反映する 13
17. エンコード 期待されているレスポンスの型: uinteger[]; { line: 2, startChar: 5, length: 3, tokenType: "property", tokenModifiers: ["private", "static"] }, { line: 2, startChar: 10, length: 4, tokenType: "type", tokenModifiers: [] }, { line: 5, startChar: 2, length: 7, tokenType: "class", tokenModifiers: [] } [ 3,5,3,0,3, 0,5,4,1,0, 3,2,7,2,0] 17
18. 小ネタ集 （時間があれば） 18
19. セマンティックトークンのカスタマイ ズ Developer: Inspect Editor Tokens and Scopes トークンの色を変更可能 "editor.tokenColorCustomizations": { "[Default Dark+]": { "comments": "#ecfc86", } } 19
20. Telemetry について Google がデータを集計 確認方法： go install golang.org/x/telemetry/cmd/gotelemetry@latest gotelemetry view プロセスの確認： ps aux | grep gopls 20