深酒とお昼寝で忘れる

深酒とお昼寝で忘れる

素面でも意図したことを忘れがちなしらふいとさんは、忘れる前に何かしら書き残せたらとても満足のようです

重い腰を上げて Neovim ことはじめ ー ripgrep (rg) と fzf によるソースコード検索編

fzf fzf.vim Neovim ripgrep Vim

はじめに

Neovim への移行と共に実現したいことがありました。この 『コマンド一発でソースコード検索＆表示できる「peco」改が凄い！』 というブログポストで紹介されているもの相当の機能を Vim 内で実現することです。記事でも『Vim にある grep とかも物色しながら「いいのないねー」……』とありますし、比較的素直な発想だと思います。さていきなりですが、これは 先日の記事 に書いた Neovim のニュースレターの 第６号 で紹介されている fzf を導入すればできる気がしたので、やってみました。

代替手段の調査

と、その前に、一応他の実現方法についても少し調べてみます。

まずは、元の記事にある peco の連携を少し調べてみましたが希望に沿うものはなさそうな雰囲気。記事の出発点が Vim の grep などを検討したが良いものがない、というものなので、もし peco との連携が可能なら記事で言及されますよね、きっと。

続いて考えたのが CtrlP を使う方法です。結構期待したのだけれど CtrlP はファイルのマッチングを念頭に作られたからかデフォルトでは所望の機能がないようです。CtrlP の拡張を少し探してみたもののすぐには見つからなかったので、次へ。

最後に、できる気がするのだけれど今回は手を出さなかったのが Denite.nvim を使う方法です。先代の Unite.vim の頃から、いつか使ってみたいと思っているプラグインなのですが……、なんかどうにも億劫で試してみるには至りませんでした。

fzf および fzf.vim のインストール

はい。ということで fzf です。fzf は peco のようないわゆる fuzzy matcher で、作者の方が Vim ユーザなこともあってか Vim との連携機能が強力です。同じ作者による fzf.vim プラグインを導入すると 幸せになれるそうです。色々と設定を試行錯誤して、そこそこ満足できる状態になりました。

インストールには TOML ファイルに fzf および fzf.vim のエントリを追加します。

[[plugins]]
repo = 'junegunn/fzf'
build = './install --bin'
merged = '0'

[[plugins]]
repo = 'junegunn/fzf.vim'
depends = 'fzf'

検索プログラムの選定

fzf.vim の設定の前に、fzf への入力を出力するプログラムを決めます。元の『「peco」改』のエントリは peco への入力に Ack を使っています。Ack は find+grep 相当のことが実行できるもので、同種のプログラムが多数開発されています。調べた結果、ripgrep というプログラムが性能が良く一番信頼できそうだな、という結論に至りました。興味のある方は、ripgrep の作者が性能比較を行なっている このブログポスト や、Hacker News での ag の作者との やり取り などを読んでみてください。

fzf.vim の設定

さてあとは fzf.vim の設定です。なるべく元の記事の アニメーション と似たような使用感になると良いなと思って設定しました。

該当する箇所の設定を抜き出してみました。

[[plugins]]
repo = 'junegunn/fzf.vim'
depends = 'fzf'
hook_add = '''
    command! -bang -nargs=* Rg
      \ call fzf#vim#grep(
      \   'rg --line-number --no-heading '.shellescape(<q-args>), 0,
      \   fzf#vim#with_preview({'options': '--exact --reverse'}, 'right:50%:wrap'))
'''

fzf.vim の README にある :Rg というコマンドを設定している箇所を参考にして、以下の変更を加えています。ちなみに rg というのは ripgrep の実行ファイル名です。README では --column が有効で with_column も 1 に設定してありますが、どのような効果があるのか不明だったので無効にしました。:Rg! コマンドは使わないと思ったので除き、また --color=always があると速度が目に見えて遅くなってしまうのでこちらも除いてデフォルトの挙動（--color=auto）にしてあります。

fzf#vim#with_preview はとてつもなく素晴らしいので、デフォルトで有効にしました。長い行は wrap した方が好みです。また、fzf に --exact と --reverse を渡しています。前者はあいまい検索を無効に、後者は候補の表示をデフォルトのボトムアップからトップダウンに変更するオプションです。

追記（2017/04/29）：--delimiter : --nth 3.. というオプションを追加しました。詳しくは こちら。

あとはコマンドモードで :Rg を実行すれば良いです。

おわりに

f:id:someneat:20170308040647g:plain