ruby-reader-ja

Ruby Reader とは？

Ruby Reader とは、LLMと一緒にRubyのコードを読むためのツールです。

[できること]

• 人がコードを読まずともLLMが関数探索してくれる
• 前に進んだ関数経路に戻れる
• 調べている関数経路のバグをLLMが見つけてくれる
• 調べている関数をLLMが図にしてくれる
• 調べた関数経路をLLMがレポートにしてくれる

[効果]

• Rubyコードをランダムウォークなしに読み進められる
• 土地勘がないと10分以上かかる数百行、数千行の関数のコードリーディングを、LLMが1分で終わらせてくれる
• Rubyコードのバグを見つけられる機能がある
• 頭にいれるだけで暗黙知になりがちな関数経路や関数の説明をLLMがしてくれる

[できないこと/人の作業]

• エントリーポイントの把握
• LLMによる関数自動探索（人が判断した方が正確）
• コードベースを分割せず一括でLLMに調べさせること

利用方法

1. ruby-lspの準備

brew install ruby-lsp

2. vscode のインストール（v1.100.0以上）

3. RubyReader のインストール

vscodeでRubyReaderのVSCode拡張を検索。検索後に出てくる「RubyReader」のVSCode拡張をインストール。

5. 設定の入力 ruby-lspのパス、Rubyプロジェクトのルートパス、compile_commands.json のディレクトリのパス、LLM（OpenAI・Claude・Plamo）を入力

6. チャット画面で探索を開始 最初に、「探索を開始するファイルパス」「探索を開始する関数」「探索の目的」を入力すれば、探索を開始できます。

7. 探索を制御 探索に成功すると、

Release Notes

1.0.7

fix begin bug

1.0.6

fix lsp reference find file bug

1.0.5

fix lsp find pos bug

1.0.4

fix reference class found bug

1.0.3

fix reference found bug

1.0.2

fix multi choice bug

1.0.1

Initial release of RubyReader-jp