コンテンツにスキップ

ADR-19 — 言語サーバーのパッケージング

ステータス: Accepted、2026-05-17

Rigorの言語サーバー実装のパッケージング形を決定し、将来のLSP作業(リファクタリング機能、追加のケイパビリティ(capability)、エコシステム統合)が、毎サイクルgem境界の問題を蒸し返すのではなく、明文化された前提から始まるようにします。

言語サーバーv1はv0.1.6で着地しました(コミットa3e9c47e2d1c9a、1つの設計ドキュメント + 8つのスライス(slice) + クリーンアップにわたる12コミット)。完全な設計はdocs/design/20260517-language-server.mdにあります;このADRはLSPコードがどこに住むかという直交する質問に取り組みます。

今日の形: rigor lspはメインのrigortypegemのCLIサブコマンドで、実装はlib/rigor/language_server/の下、language_server-protocol ~> 3.17への新しいランタイム依存があります。LSPはRigorの内部APIを直接読みます — Analysis::RunnerScope#type_ofEnvironmentBufferTableInference::ScopeIndexerSource::NodeLocator — どれもADR-0のCLIファーストスコープに従って公開を約束されていません。

LSPはバンドルされたままにするのか、別個のgemに分割するのか、既存のLSPフレームワークのアドオンにするのか? という質問は、LSP機能追加(リファクタリング、codeAction、リネームなど)が積み重なって境界の移動が後から難しくなる前に、明示的な答えが必要です。

Rubyエコシステムには3つの実際の先例があります。

パターン
A. 単一gem、LSPはサブコマンドSteep(steep langserver)、Solargraph(solargraph stdioアナライザー + LSPサーバーが1つのgemに住む。ツール作者が両方のレイヤーを所有する。
B. アナライザーに依存する単独のLSPgem(Rubyにはほとんど先例がない;TSエコシステムでtypescript-language-servertscの上にあるのが近い)アナライザーgemとLSPgemが別々にバージョン管理される。LSPgemがアナライザーの公開APIに依存する。
C. 共有LSPシェルへのアドオンruby-lspに対するruby-lsp-rubocopruby-lsp-railsruby-lsp-sorbet共通のLSPシェルがアドオンプロトコル経由で複数のアナライザーをホストする。複数のアナライザーが1つのエディタセッションで共存できる。

SteepとSolargraph — Rigorと構造的に最も類似した2つのRubyプロジェクト(アナライザーファースト、単一ツール、型認識)— はどちらもAを選びました。Ruby LSPはCを選びましたが、これはLSPオーケストレーターシェルであり、アナライザーではありません;Rigorのようなツールの1つ上のレイヤーに座ります。

パターンA — LSPをrigortypegemにバンドルしたままにする

  • rigor lspcheck / type-of / sig-genと並ぶサブコマンドのままです。gem分割なし。
  • LSP実装はlib/rigor/language_server/の下に住み、Rigorの内部APIに直接アクセスします。LSP / アナライザー境界での公開API安定性の誓約は不要です。
  • language_server-protocol ~> 3.17rigortypeのランタイム依存のままです。それは薄いgem(約500行 + 自動生成されたLSP型)であり、バンドルコストはユーザーベース全体にとって受容可能です。

却下された代替案は、この決定を再開させるトリガー条件とともに「検討した代替案」に記録されています。

Aの理由:

  1. 内部APIの結合。LSPはAnalysis::Runner / Scope#type_of / Environment / BufferTable / Inference::ScopeIndexer / Source::NodeLocatorを直接読みます。これらはどれもADR-0に従って公開を約束されていません — アナライザーが自由に進化させる「いつでも変わってもよい」内部サーフェス(surface)として扱われています。別個のgemへの分割は次のいずれかを強制します:

    • それらのAPIが公開になる(アナライザー進化への萎縮効果)、または
    • 内部ヘルパーをLSPgemに重複させる(バージョンドリフトで腐る)。 どちらの結果もアナライザーの主要ミッションには資しません。
  2. SteepとSolargraphの先例。Rigorと構造的に最も類似した2つのRubyプロジェクトはどちらも、アナライザーgemのサブコマンドとしてLSPを出荷しています。彼らの経験は、バンドルされた形がアナライザーファーストのツールにとって自然なフィットであることを示唆し、どちらのプロジェクトでも境界が摩擦を生んだという証拠はありません。

  3. 分割への需要圧力なし。分割は、プロジェクトが現在抱えていない問題を解決します: インストールの肥大化(ユーザー苦情なし)、独立したリリースケイデンス(スケジューリング衝突なし)、複数のLSPバックエンド(地平線上に2つ目のバックエンドなし)。

  4. リファクタリング機能はパッケージングと直交。フレーミングの質問 — 「リファクタリング機能を構築できるように分割すべきか?」 — は誤った前提です。リファクタリングケイパビリティ(textDocument/codeActiontextDocument/renametextDocument/formatting)は、分割gem実装と同じようにrigortypeの内部で実装可能です。アーキテクチャ上のゲートは型認識コード書き換えと編集適用セマンティクスであり、どちらもどちらのレイアウトにも等しく収まります。

  5. 可逆性が高い。将来の分割(A → BまたはA → C)は、gem間でファイルを移動し1つのgemspec依存行を調整することを必要としますが、LSPコード自体は再設計を必要としません。一方、時期尚早の分割は、編集が難しくなるAPIサーフェスを固定化します。

このADRはこれらの条件の下で受け入れられます。いずれかのトリガーが発火したら、次の実装者はパッケージングの問題を再開すべきです(SHOULD)。

トリガー再評価する方向
LSP実装が約2,000行を超えて成長する(今日: 約360行)B(単独のrigor-lsp)。分割コストはLSP自体が実質的なサブシステムになったときに正当化される。
rigor checkをCIから使うがlanguage_server-protocolをGemfile.lockに入れたくない」という具体的なユーザー需要B、rigortypeがランタイム依存を失う;rigor-lspがそれを運ぶ。
独立したリリースケイデンスが痛みになる(rigorアナライザーは型正確性のリズムで出荷;LSPはUXのリズムで出荷;リズムが衝突する)B、別々のバージョニングで。
2つ目のLSPバックエンドが出現する(例えば同じアナライザーを使う別のオーディエンス向けのLSP)B、両方のバックエンドがgem間結合なしに合成できるように。
「rigorの解析をRuboCop / Sorbet / Rails LSPと1つのエディタセッションで合成したい」という具体的なユーザー需要C(ruby-lsp-rigorアドオン、Aと並行)。
新しいLSPシェルプロジェクトがRuby LSPを置き換え、Rigorが統合する必要があるC、新しいシェルに対して。

期待はこれらのいずれもv0.1.xまたはv0.2.xサイクルでは発火しないことです。v0.3.x / v0.4.xの実装者がそれらを再導出する必要がないように記録されています。

トリガー条件が発火して分割が起こる場合:

  • rigor-lsp — 既存のRigorプラグインファミリーのプレフィックス(rigor-rails-routesrigor-dry-typesrigor-activerecordなど)に一致します。移行が漸進的(gradual)なら、rigor-plugin-authorSKILL規律に従ってplugins/rigor-lsp/の下にステージし、安定したらgit subtree splitで抽出します。
  • ruby-lsp-rigor — 分割がC(Ruby LSPアドオン)に向かう場合、Ruby LSPのruby-lsp-<name>アドオン命名規則に従います。両方の形が共存するならrigor-lsp(A)とは独立にリリースされます。
  • lsp-rigorは不可 — Rigorの既存のプレフィックス体制と逆順;一貫性の理由で却下。

B. rigortypeに依存する単独のrigor-lspgem

Section titled “B. rigortypeに依存する単独のrigor-lspgem”

長所

  • 専用の製品サーフェス: rigor-lspは「Ruby言語サーバー」を検索しているユーザーに名前で発見可能。
  • rigortypeのランタイムが最小限に保たれる(CLIのみのユーザーに対するlanguage_server-protocol依存なし)。
  • 独立したリリースケイデンス。LSP UXの変更はアナライザーのバンプなしで出荷;アナライザーの型正確性の変更はLSPのバンプなしで出荷。
  • 理論的には、rigortypeを消費する別のLSPシェルを可能にする(実際にはあり得ない)。

短所

  • アナライザーの内部API(Runner / Scope / Environment / BufferTable / ScopeIndexer / NodeLocator)が公開になることを強制する — または内部ヘルパーをrigor-lspに重複させることを強制する。両方の結果は現在の形より悪い。
  • gem間のバージョン互換性マトリックス(rigortype 0.xrigor-lsp 0.y)。解決可能だがリリース調整を追加する。
  • 両方のレイヤーに触れる貢献者にとっての認知的オーバーヘッドが高い。

却下された理由は、APIの結合コストがリストされたあらゆる長所を支配するためです。長所はLSPが十分に大きく成長したとき、または分割インストールへのユーザー需要が表面化したときにのみ現実になります — トリガー表を参照してください。

C. Ruby LSPシェル下のruby-lsp-rigorアドオン

Section titled “C. Ruby LSPシェル下のruby-lsp-rigorアドオン”

長所

  • 1つのエディタセッションで他のRuby LSPアドオン(RuboCop、Rails、Sorbet)と共存。
  • 維持するLSP配管が少ない(Ruby LSPがフレーミング、ライフサイクル、ケイパビリティネゴシエーションを所有)。
  • ShopifyがプッシュしているRubyツーリングエコシステムv2の方向性に一致する。

短所

  • 大幅な再アーキテクチャ: v0.1.6で着地した約250行のServer / Loopレイヤーは、ほぼRuby LSPアドオンの足場で置き換えられる。
  • Ruby LSPのアドオンプロトコルの安定性に依存する — Shopifyが契約(contract)を変更できる;Rigorは追従するか動かなくなる。
  • LSPライフサイクル(ケイパビリティ選択、起動順序、リクエスト優先順位付け)に対するアーキテクチャ制御を放棄する。
  • Ruby LSPがアドオンAPIを通じて公開するLSP機能セットに、Rigorを閉じ込める。

今のところ却下されますが、複数アナライザー合成への具体的なユーザー需要が表面化したら再訪する価値があります。その場合の理想的なパスはAと並行してCです(Rigorだけを望むユーザーのために単独サブコマンドを保ち、合成を望むユーザーのためにアドオンを追加する)。

リファクタリングツールを含むメガgem

Section titled “リファクタリングツールを含むメガgem”

考慮: LSPスライスの一部としてcodemodツーリング、Prismリライターなどをrigortypeにバンドルし、gemをRubyの「静的解析 + IDE」の全部入りツールにする。

却下された理由は、codemod / リライターレイヤーは、gemのランタイムアイデンティティに吸収されるべきではなく、それ自身でアドレス可能なサブシステムであるべきだからです。リファクタリング機能が出荷されるとき(ROADMAPの§「エディタ / IDE統合」の下でキューイング済み)、リライターはrigortype内の独自のlib/rigor/refactoring/名前空間の下に住み、LSPレイヤーが呼び出すクリーンな内部APIを持つべきです。これがアナライザー / リファクタリング / LSPを1つのgem境界の下にある3つの識別可能なサブシステムとして保ちます — Steepが実証するバンドルされているが分割可能(bundled-but-modular)な形です。

ポジティブ

  • LSP開発は、rigor checkrigor type-ofを駆動しているのと同じ内部APIサーフェスに対して継続する。新しい公開API安定性の負担なし。
  • 当面の間、単一gemインストールモデル。1つのコマンド(gem install rigortype)でユーザーにCLI + LSPを与える。
  • Rails / dry-rbのプラグインファミリーパターン(examples/の下のgemごと、安定したら抽出)は正準的なマルチgemパスのままである — LSPは単にそれに当てはまらない。

ネガティブ / コスト

  • language_server-protocolランタイム依存は、CIのみのユーザーを含むすべてのrigortypeインストールで恒久的になる。緩和: gemは小さく、json(Ruby 3+のstdlib)以外の推移的ランタイム依存はない。トリガー表が発火するまで受容可能。
  • 将来の再評価は明示的に起こる必要がある。このADRは質問が忘れられないようにするブックマークである。

中立

  • リファクタリング機能は出荷時に新しいgemではなくrigortype内に着地する。LSPを使わないrigor checkの消費者はコードサイズのコストを払うが、ランタイムコストは払わない(リファクタリングコードはrigor lspパス経由でのみロードされる)。

ステータスレビューのケイデンス

Section titled “ステータスレビューのケイデンス”

このADRは次のときにレビューされます。

  • 上記の任意のトリガー条件が発火する(必須のレビュー)。
  • 大きなLSPケイパビリティが着地する(リファクタリング、セマンティックトークン、インレイヒント) — バンドルされた形がまだ役立っていることをサニティチェック。
  • Rubyエコシステムが変化する(Ruby LSPがシェルとして普及する、あるいは衰退する;新しいシェルが出現する)。

これらのいずれかが起こるまで、このADRは書かれたままの形で重要であり続けます。

© 2026 TypedDuck. Licensed under CC BY-SA 4.0.