Abandon TypeProf.wasm + LSP Integration for Ruby Code Completion

[takaokouji]

Abandon TypeProf.wasm + LSP Integration for Ruby Code Completion

• User Story: feat: Rubyタブの入力補助（コード補完・インデント）の再構築に向けた技術調査 smalruby3-editor#166
• Related Issue: feat: TypeProf.wasm + LSP による型ベース補完の導入（課題4 段階3） smalruby3-editor#171
• Related PR: feat: typeprof.wasm + lsp による型ベース補完の基盤実装（課題4 段階3） smalruby3-editor#172
• Status: accepted
• Deciders: takaokouji
• Date: 2026-02-23

Sorry, this is written in Japanese.

Rubyタブのコード補完に TypeProf.wasm + LSP を採用しない

Issue #166（Rubyタブの入力補助の再構築）の課題4・段階3として、TypeProf.wasm を Web Worker で動かし monaco.lsp API で Monaco Editor と接続する実装にチャレンジした。

実装内容は smalruby/smalruby3-editor#171（sub-issue）および smalruby/smalruby3-editor#172（実装PR）に記録されている。

実装後の動作検証の結果、TypeProf による補完の恩恵がほとんど得られないことが判明したため、この方向性を中止する。

判断基準や制限

• スモウルビーのユーザー（小学生〜中学生）にとって補完が役立つこと
• 実装・保守コストが現実的であること
• 既存の補完機能（スニペット補完）を劣化させないこと

選択肢

• TypeProf.wasm + LSP によるコード補完を採用する（段階3）
• 採用せず、段階1（正規表現コンテキスト判定）＋段階2（複数 CompletionProvider 分離）で完結させる

決定

採用: 採用せず、段階1＋段階2で完結させる

• TypeProf は「レシーバーに対するメソッド補完」には強力だが、スモウルビーのプログラムでは move(10) や turn_right(15) のようにレシーバーなしのメソッド呼び出しがほとんどであり、prefix 補完（識別子の途中入力）には対応していないため、実質的な恩恵がない
• 以前よりも悪化した点が複数あった（下記参照）
• 段階1＋段階2で実現できている補完品質で、スモウルビーのユースケースには十分

各選択肢の良い点と悪い点

TypeProf.wasm + LSP によるコード補完を採用する

• + 型情報に基づく高精度な補完が期待できる
• + . や :: トリガーでのメソッド補完が動作する（"hello". → String メソッド一覧 など）
• - スモウルビーのプログラムはレシーバーなしのメソッド呼び出しがほとんどであり、TypeProf の prefix 補完非対応が致命的
  • mov と入力しても move(10) の候補が出ない
  • TypeProf は AST ノード境界（. / ::）でのみ補完候補を返す設計（service.rb:completion の node.code_range.last == pos.right チェック）
• - ファイル数・コード量が増大し複雑度が上がる
  • typeprof-worker.js, typeprof-bootstrap.rb, smalruby.rbs, typeprof-lsp-client.js 等が追加（+555行/-8行）
• - 入力中の構文エラーが多発し、Monaco のエラー表示がノイズになる
  • 式の途中入力（move(）で TypeProf が構文エラー診断を送出し、赤波線が頻繁に発生
  • エラーが解消されたタイミングで再描画コストが発生
• - Monaco 言語 ID を smalruby（カスタム）から ruby（組み込み）に変更する必要があり、既存の設定（インデントルール等）との競合が生じた
  • Monaco CDN が非同期で ruby 組み込み言語設定をロードし、カスタム setLanguageConfiguration を上書きする問題が発生
  • when_flag_clicked のような when_ プレフィクスのメソッドが誤ってデデントされるバグが再発
• - LSP 関連の依存（monaco.lsp API）が不安定。Monaco Editor 開発者自身が「バグがある可能性がある」と明言している
• - Jest テスト環境で file:/// URI スキームの扱いに追加対応が必要になるなど、テスト環境コストが増加
• - Web Worker での TypeProf.wasm 初期化に数秒かかるため、エディタ起動時の体験が低下する
• - ruby.wasm バイナリが 53MB と大きく、.gitignore に追加してダウンロードスクリプトで取得する運用が必要

採用せず、段階1＋段階2で完結させる

• + コードベースがシンプルに保たれる
• + 既存の補完品質（スニペット補完 + コンテキスト判定）をそのまま維持できる
• + スモウルビーの主要ユースケース（レシーバーなしのメソッド補完）はスニペット補完で十分カバーされている
• - TypeProf の型情報を活用した高精度補完は得られない
• - . / :: トリガーでのメソッド補完（例: "hello".length など）は実装されない

---

付録: 実装過程で判明した技術的知見

アーキテクチャ（実装済み状態）

Main Thread (Monaco Editor, language: 'ruby')
    ↕ postMessage (JSON-RPC / LSP)
Web Worker (typeprof-worker.js)
    └─ Ruby VM (ruby.wasm)
        └─ TypeProf::LSP::Server (Fiber)
            └─ /workspace/smalruby.rbs (型定義)

実装過程で遭遇した課題と対処

課題1: url_schema の誤設定

url_schema: "file:///" (スラッシュ3個) では uri_to_path が "file:///workspace/main.rb" から "workspace/main.rb" (相対パス) を生成してしまい、TypeProf が textDocument/didOpen をスキップする。

url_schema: "file://" (スラッシュ2個) が正しく、/workspace/main.rb (絶対パス) を生成する。

課題2: publish_all_diagnostics kwarg

Rubox のコードをベースにすると publish_all_diagnostics: true が含まれるが、TypeProf 本体の initialize は url_schema: のみ受け付けるため ArgumentError になる。

課題3: smalruby.rbs の内容が空

webpack の DefinePlugin.runtimeValue で typeprof-bootstrap.rb と smalruby.rbs を読み込み、__SMALRUBY_RBS_PLACEHOLDER__ トークンを実際の RBS 内容で置換する方法で解決した。ただし webpack.config.js の変更は HMR では反映されないため、dev サーバーの再起動が必要。

課題4: Monaco モデルの言語 ID

MonacoLspClient は documentSelector が undefined の場合、Monaco の組み込み言語（ruby）にのみプロバイダを自動登録する仕様。カスタム言語 smalruby では capabilities._staticCapabilities が {} のままでプロバイダが登録されず、補完リクエストが Worker に届かない。

monaco.languages.register({id: 'smalruby'}) を廃止し、language="ruby" に変更することで解決した。ただし後述の問題が発生。

課題5: Monaco CDN による言語設定の上書き

Monaco は組み込み言語（ruby）の設定を CDN から非同期にロードする。この非同期ロードが handleEditorDidMount 後に実行され、setLanguageConfiguration('ruby', smalrubyLanguageConfiguration) を上書きしてしまう。

上書きされた decreaseIndentPattern は (end|rescue|ensure|else|elsif|when)\b となり、when_flag_clicked のような when_ プレフィクスのメソッド名を誤ってデデントする。

smalrubyLanguageConfiguration の decreaseIndentPattern では when\s（スペース必須）として when_xxx を除外しているが、CDN ロード後に上書きされると無効化される。

monaco.languages.onDidChange で languageId === 'ruby' の変更を検知し再適用する方法を検討したが、monaco.languages.onDidChange is not a function エラーが発生した（monaco-editor 0.55.1 では API が存在しない）。

課題6: TypeProf の identifier prefix 補完非対応

TypeProf の service.rb:completion メソッドは node.code_range.last == pos.right で補完位置をチェックする。これは「カーソルがAST ノードの末尾」のときのみ補完候補を返すため、mov のような識別子入力中には候補を返さない。

ドット補完（"hello".）は動作する。これはメソッドチェーン呼び出しノードの末尾がカーソル位置と一致するため。

課題7: Smalruby メソッドのコンテキスト（RBS での対処）

TypeProf は main.rb の self を Object と解釈するため、SmalrubySprite のメソッドは補完されない。smalruby.rbs に class Object を追加して全 Smalruby メソッドをトップレベルで定義することで "undefined method: Object#mov" の診断は解消できた。ただし prefix 補完非対応の問題は解消されない。

動作確認済み状態

コンテキスト	入力例	補完	結果
トップレベル（def/do ブロック外）	when_	event スニペット	✅ 仕様通り
トップレベル（def/do ブロック外）	mov	候補なし	✅ 仕様通り（テスト用のため不要）
do...end 内	mov	動かす move(10) 等 139件	✅ スニペット補完が動作
do...end 内	"hello".	String メソッド一覧	✅ TypeProf ドット補完が動作

スニペット補完が do...end 内で正しく動作しており、TypeProf の恩恵はドット補完のみ。スモウルビーのユースケースでドット補完が必要なケースはほぼない。

参考: 調査対象

• Rubox — TypeProf.wasm + Web Worker + LSP の参考実装
• mame/typeprof.wasm — typeprof-bootstrap.rb のベース
• Monaco Editor 0.55.1 の monaco.lsp API（実験的）