ProtobufにLSPサポートが登場
Protobuf has LSP support. You're welcome (buf.build)
要約
Buf社は、Protobuf向けの初の本格的なLSP(Language Server Protocol)サーバーをリリースしました。これにより、VSCodeやNeovimなどのIDEで、コード補完、定義への移動、セマンティクスを考慮したシンタックスハイライトといったモダンな開発体験が可能になります。このLSPサーバーは、Buf CLIにバンドルされており、Protobuf開発の生産性を大幅に向上させることを目指しています。
全文翻訳
ProtobufがLSPサポートに対応しました
Bufは、Protobuf向けの初のフル機能かつ仕様準拠のLSP(Language Server Protocol)サーバーを発表できることを誇りに思います。
Language Server Protocolは、VSCode、IntelliJ、Neovimなどの皆様のお気に入りのIDEやテキストエディタに言語サポートを統合するための標準APIです。LSPサーバーは、定義へ移動、コード補完、参照の検索、セマンティクスを考慮したシンタックスハイライトなどを可能にするインテリジェンスを提供します。
今日まで、Protobufは他の主要なプログラミング言語が享受しているLSPサポートを欠いていました。私たちの功績を過大評価するつもりはありませんが、これはProtobuf開発におけるゲームチェンジャーです。Protobufは、Buf CLIによって、初めてモダンなIDEサポートを手に入れました。
Bufでは、Protobufがライブラリやツールの確立されたエコシステムのおかげで、最高のスキーマ言語であると信じています。Protobufはスマートな選択であるだけでなく、最も簡単な選択肢であるべきです。だからこそ、私たちはProtobuf-ES(Chromiumでも使用されています!)、Protovalidate、ConnectRPC、そしてBuf Schema Registryを含む、Protobufエコシステムを完成させるツールのファミリーの一部として、Buf LSPサーバーをリリースします。プロジェクトやユースケースに関わらず、Protobufでの開発は簡単で、明白な選択肢となるべきです。
試す方法は以下の通りです!
Buf LSPのインストール
VSCodeは、利用可能な最も人気のあるグラフィカルエディタの1つであり、優れたLSPサポート(LSPはVSCodeから始まりました)を備えています。Buf LSPを使用するには、Buf拡張機能をインストールするだけです。これにより、インストール済みのBuf CLI(LSPサーバーをバンドルしています)が自動的に使用されるか、必要に応じてインストールされます。
NeovimはBufエンジニアのお気に入りのエディタであり、Buf LSPもそれと非常によく連携します。必要なのは、Buf CLIをインストールし、LSPサーバーとして使用するようにNeovimを設定することだけです。
nvim-lspconfigリポジトリをインストールしたことを確認してください。これはデフォルトのLSP設定オプションを提供します。こちらの手順に従ってください。.nvimrcにlspconfig.buf_ls.setup {}を追加します。
または、init.lua(またはお好みの別の設定ファイル)のどこかに以下を追加することもできます。
vim.lsp.config('buf-lsp', {
cmd = { 'buf', 'lsp', 'serve' },
filetypes = { 'proto' },
root_markers = { 'buf.yaml', '.git' },
})
その後、.nvimrcでvim.lsp.enable('buf-lsp')を使用して有効にできます。
LSPとNeovimの詳細についてはこちらをご覧ください。
他のエディタを使用している場合は、まずLSP統合がどのように機能するかを調べ、buf lsp serveコマンドを実行してサーバーを起動するだけです。
ツールチェーンの活用
BufはすでにProtobufコンパイラのフロントエンド(ファイルを解析し、protocのようなプラグインを呼び出す部分)を維持しており、これをprotocompileと呼んでいます。私たちの実装は完全準拠しているだけでなく、protocよりもはるかに高速で柔軟性があります。私たちのコンパイラは非常に優れているため、Googleでさえ、その巨大なコードベースの一部の箇所でprotocと並行して使用しています。
Buf LSPを構築するために、私たちはprotocompileを次のレベルに引き上げました。インクリメンタルコンパイルとより優れた診断を可能にする、新しいクエリ駆動型のフロントエンドを開発しました。例えば、protocとは異なり、重複したrepeated修飾子を正しく診断します。
error: encountered more than one type modifier
--> testdata/parser/type/repeated.proto:23:14
|
23 | repeated repeated M x4 = 4;
| -------- ^^^^^^^^ help: consider removing this
| |
| first one is here
FileDescriptorProtoを使用するのではなく、これらのエラーを正確に診断するために新しいASTと中間表現を設計しました。その柔軟性により、Protobufに追加される新しい言語機能(例えば、Editions 2024の今後の機能)を簡単に実装できます。また、メモリ効率も高いため、非常に大きなBufモジュールを含むワークスペースを処理できます。
私たちのコミットメント
Buf LSPに関する私たちの作業は完了していません。私たちは常に診断機能を改善しており、LSPサーバーにもさらに多くの機能を追加する予定です。
importを自動修正として追加する。buf.yamlとのより緊密な統合(モジュールの自動インポートなど)。- カスタムオプションのコード補完と参照検索。
- フィールド/列挙値番号の自動提案。
- CELスニペットのシンタックスハイライトを含む、専用のProtovalidateサポート。
Bufでは、常にProtobufであなたができることの限界を押し広げ、すべての人のためのスキーマ駆動開発を可能にします!
組織のデータに対する標準の強制に役立つ情報が必要な場合は、Bufがお手伝いできるかどうかを確認するためにお問い合わせください。優れた開発者ツールを構築することに情熱を感じる方は、info@buf.buildまでご連絡ください!