前のエントリでは、ReFeを使うとコマンドラインでRubyのリファレンスマニュアルを読めることを説明した。しかし、ReFeの真髄はエディタとの連携にある。
vim-refはリファレンスマニュアルをvim上で読むためのvimプラグインである。これはReFeにも対応しており、Rubyのソースコードからリファレンスを参照するようなことが簡単にできる。
インストール
Vundleを使っていれば以下を.vimrcに記載して、BundleInstallでインストールできる。
Bundle 'thinca/vim-ref'
使い方
vim-refをインストールするとリファレンスを検索するRefコマンドが使えるようになる。Refコマンドの使い方は以下のとおり。オプションとクエリは省略可能である。
Ref オプション ソース クエリ
例えばReFeでArray#joinのリファレンスを表示するには以下のようにすれば良い。
Ref refe Array#join
vim-refではあらゆるバッファで有効なキーマップとしてKが定義されている。 これは非常に便利で、例えば.rbファイルでArray.newにカーソルを合わせてKを押下すると、Array.newのリファレンスが開く。
-
K– カーソル下のキーワードにジャンプ
ref-viewerの内部ではKに加えて以下のキーマップが利用できる。 ようはKやEnterキーで読み進めて、<C-t>か<C-o>で戻ることができる。
-
Enter– カーソル下のキーワードにジャンプ - ダブルクリック – 同上
-
<C-j>– 同上 -
<C-t>– 前のページに戻る -
<C-o>– 同上 -
<C-i>– 次のページに進む
またref-viewerでは、RefHistoryコマンドを使って履歴を確認することが可能だ。
