Vimにたくさんあるファジーファインダー系プラグインを比較してみる

公開:2020/09/22
更新:2020/09/22
19 min読了の目安(約11800字TECH技術記事
Likes36

ファジーファインダー系プラグインとは

fuzzy finder、 あいまいに検索することができるツールです。
完全一致検索のように絞り込むまでにタイプ数が必要だったり、正規表現検索のように小難しいこともなく、高速に絞り込みできることがメリットです。

コマンドラインツールとして有名なのはfzfで、ディレクトリを移動したり、ファイルを選択したり、パイプとしてつなげてフィルターしたりといった用途で使われています。

Vimにおけるファジーファインダー系プラグイン

Vim,Neovimではファジーファインダー機能はデフォルトで入っておらず、なんらかのプラグインをインストールする必要があります。(機能としてはないですが、vimにはmatchfuzzyという関数は最近追加されました)
ファジーファインダーはプログラミングをするときにかなり強力なので、ほとんどのVimmerがなんらかのプラグインをインストール(もしくは自作)していると思います。

しかし、Vimのファジーファインダー系プラグインは数が多く、選ぶのがとても大変です。ファジーファインダーの戦国時代です。有力なものだけで10個もあります(2020年現在)。個人的には乗り換え対象があるのはすばらしいことだと思いますけど、せめて3-4個にしていただきたいものですね。。。

ちなみに、次に有力なプラグインの数が多いカテゴリーは、プラグインマネージャー系プラグイン、タスクランナー系プラグイン、ファイラー系プラグイン、LSPクライアントと続きます。ここらへんもそのうち比較記事を書きたいと思っています(たぶん)。

(おまけ)なぜこんなに増えたのか

理由の1つにvim scriptの手軽さと、なんでも自前で作りたくなるVimmerの特性があると思われます。
https://vim-jp.org/slacklog/CLKR04BEF/2020/06/#ts-1593137484.466200
https://vim-jp.org/slacklog/CLKR04BEF/2020/07/#ts-1594714880.427700

Vimにおけるファジーファインダー系プラグインの利用用途

Vimでファジーファインダーを使うのは、主に次のような用途をファジーファインダーで効率的するためです。

  • 開いているファイル(バッファー)の切り替える
  • 今いるディレクトリ以下のファイルを検索する(find,git ls-files相当)
  • 今いるリポジトリから特定のワードで検索する(grep,rg相当)
  • 今いるファイル内から検索する
  • MRU(以前開いたファイルを開く)
  • コマンドを入力する
  • 編集した場所や過去に移動した場所、ブックマークした場所へ移動する

ファジーファインダーのデータソース詳細

この記事では、ファジーファインダーが検索する対象をデータソースと呼ぶことにします(ものによってはリソースや、データプロバイダーと呼ばれています)。
データソースにはだいたい網羅すると以下のようなものがあります。

最低限提供されていることが多いデータソース

  • buffers
  • files
  • git files
  • grep
  • lines

vim系の機能のデータソース

  • tags
  • marks
  • command
  • command history
  • search history
  • yank
  • quickfix
  • loclist
  • windows
  • sessions
  • maps
  • help
  • colorscheme
  • filetype

他と差別化しやすいデータソース

  • MRU
  • LSP
  • Treesitter
  • git commit/diff
  • change list
  • jump list
  • snippet

ファジーファインダー系プラグインの比較

主要なファジーファインダー系プラグイン一覧

順番は2020/09/22時点でのGitHubのスター数になっています。

※ 数が多すぎるため私もすべてのプラグインをインストールして試したわけではありません。READMEとソースが主な情報源です。

名前 動作環境 実装言語 Stars
fzf.vim Vim/Neovim Vim script + 外部バイナリ(fzf[Go製])
ctrlp.vim Vim/Neovim Vim script
denite.nvim Vim(別途プラグインが必要)/Neovim Python製リモートプラグイン
vim-clap Vim/Neovim [低速版] Vim script or [高速版] Vim script + 外部バイナリ(maple[Rust製])
LeaderF Vim/Neovim Vim script + Pythonコマンド実行(Cのバイナリもインストールされる?)
fzf-preview.vim Neovim/Vim(coc.nvim利用時) TypeScript製リモートプラグイン or CocExtension
telescope.nvim Neovim Lua
CocList Vim/Neovimのcocユーザー coc.nvimに内包されている(coc.nvim自体はTypeScript製で自前リモートプラグインで動いている)
skim.vim Vim/Neovim Vim script + 外部バイナリ(skim[Rust製])
vim-fz Vim/Neovim Vim script + 外部バイナリ(gof[Go製])

主要なファジーファインダー系プラグイン詳細

この章で各ファジーファインダーの詳細な特徴と所感を書いていきます。

※ デフォルトの機能寄りの記載になっています。(例:xxxを使えば実はカスタマイズできてみたいなのを考慮していないということです)
※ なるべく公正になるように画像は公式のREADMEやIssue,PullRequestのものを使っております。

1. fzf.vim

作者はfzf本体の作者でもあって、vim-plugの作者としても有名。
私の観測範囲ではたぶんNo1シェアだと思われる。特に海外では人気が高い。fzf自体の動作が速いため高速に候補の絞り込みができ、最低限必要なデータソースをデフォルトで提供している。
floating windowにも対応しているので見た目もかなりおしゃれにできる。最近プレビュー機能もデフォルトで対応となったので、目的のファイルをさらに探しやすくなった。
拡張性も高く https://github.com/junegunn/fzf/wiki/Examples-(vim)にやり方がいろいろ書いてある。

デメリットとしては、MRUやLSP向けのデータソースをデフォルトでは提供していないことと、イケてる感じで使おうとするとそこそこな規模のコードを自分のvimrcに書く必要が発生することなどである。

余談としては、fzf本体側になぜかVim plugin用のscriptがあり、fzf.vimはそれをwrapしてデータソースを提供している奇妙な作りをしている。おかげでIssueを検索するときfzf本体の方のバグが引っかかったりするので、とてもめんどくさい。

2. ctrlp.vim

Vimの中では老舗のファジーファインダー(2011年製)。Vimの結構古いバージョン(7系以上)でも動くようになっている。
MRUのデータソースもデフォルトで用意されている。他にあまりない変わった機能としては、Vimの正規表現も使える点、ファイルやディレクトリを作成することができる点などがある。
拡張性を利用してhttps://github.com/ctrlpvim/ctrlp.vim/tree/extensions関連するプラグインもいくつか作られている。

デメリットとしては、Vim script製なのでデータソースのデータが多いと絞り込みが遅くなる点が挙げられる。あと、popupとかfloating windowは使わない無骨なUIをどう受け取るか。

3. denite.nvim

作者はDarkPoweredプラグインを数多く世に送り出してる暗黒美無王こと日本人のShougoさん。Unite.vim を経て爆誕した。
Vim scriptでなくリモートプラグイン(Python)を使用しているためデータソースが多くても高速に動作する(Go,Rust等のバイナリを実行するものよりはさすがに遅い)。
拡張性が高く、データソースを様々な開発者が作るエコシステムができている。https://github.com/Shougo/denite.nvim/wiki/External-Sources

デメリットはVim初心者には複雑に感じて設定が難しいこと。

4. vim-clap

作者はvista.vimvim-which-keyを作成している。
プレビュー機能がついていて、外部バイナリを使うと高速に絞り込みできる。他のプラグインと違いめずらしくVim scriptだけでも動作可能の模様。拡張性も高いのでhttps://github.com/topics/vim-clapに他の方が作ったデータソースが公開されている(なぜか日本人が多い)。

これといったデメリットはないように感じるが、取り立てて他のプラグインに対して優位なところもない印象。あと個人的には、CLI側でfzf等を使っていた場合、2つのファジーファインダーのプログラムがOS内にインストールされるところに少し違和感を感じる。

5. LeaderF

ctrlp.vimの次に古参のファジーファインダー。こちらも対応vim7.3以上で動くということで、ほぼ最新を必要とする他のファジーファインダーと比べて動作要件が緩い。絞り込みに正規表現も使えるしプレビューにも対応している。
ctrlp.vimとvim-clapの間のような印象。

6. fzf-preview.vim

色付きプレビュー、ファイル名の色が付け、Deviconの表示、バッファの削除、Quickfixへのデータ受け渡しなど、機能盛りだくさんの見た目派手なオールインワンファジーファインダー。データソースもデフォルトで豊富にあって、なぜかgitの操作もプレビュー付きでできる。ファジーファインダー自体はfzfなので動作も高速。fzf.vimの足りないデータソースを追加して、設定の手間を削減して、いい感じにレイアウトしてくれるイメージ。
作者は日本人のycinoさん。よくvim-jp slackにいる。vim-jp slackはこちら

デメリットとしては高機能故に依存しているプラグインやプログラムが多いことが挙げられる。余計なものをいれたくないミニマリスト向けではない。あと、データソースとしてfzf.vimの機能に近いもの(コマンド検索やヘルプ検索等)に提供されてものもある。ここらへんのデータソースも使いたければfzf.vimやCocListを別途併用する必要がある。

ちなみに私はこれのcoc版を使っている(cocユーザーなので)。coc版はLSPの一部をデータソースとして使用できる(もちろんプレビュー付き)。

7. telescope.nvim

Neovimのコントリビューターで人気者のTJさんがfzf-preview.vimにインスパイアされて作ったLua製のファジーファインダー。
Neovimでしか使えないが、Luaの高速な動作とリッチな機能が売り。fzf-preview.vimに影響を受けているだけあって、色付きプレビュー, Deviconなど機能盛りだくさん。
fzf-previewと差別化できる点としては、treesitterやNeovimLSPと連携できる点が挙げられる。Neovimコントリビューターが作っているだけあって本体と密接につながっていけるのは今後の成長を含めて強みだと考えられる。

デメリットは、MRUのデータソースがない(:oldfilesには対応しているので簡単なMRUとしては使える模様)などデフォルトで提供されているデータソースが少ないこと。また、拡張するにはLuaの知識が必要。

8. CocList

cocユーザーならデフォルトで使用できるファジーファインダー。デフォルトではデータソースが足りないのでhttps://github.com/neoclide/coc-listsを追加でインストールしたほうがよい。これでバッファ切り替えやファイル検索などの基本的になデータソースはひと通り揃う。coc-list自体がLSPの機能提供の一部となっているのでLSP由来のデータソースも検索できる。

デメリットとしては、作者があまり機能追加に乗り気ではないため、今度改善されていく可能性は少ない見込み。

この欠点を解決するためにcoc-listの機能をwrapして別のファジーファインダーにした

9. skim.vim

skimというRust製のファジーファインダーをバックエンドとして使っている。CLIのファジーファインダーツールも含めてRust製にしたい人には選択肢に入るかもしれない。fzf.vimをcloneして作っているようなのでできることはよくも悪くもfzf.vimと同じかそれ以下になると思われる。

10. vim-fz

シンプルな作りになっているので理解しやすい。なんでも自分の手中に納めないと気がすまない人向け。

Windowsだと実行モジュールの起動に少し時間がかかるのが気になるとのこと(mattnさん本人談)。Windowsでの実行モジュールの起動の遅さは、外部バイナリを呼び出す形式のものにはすべて当てはまるのでgof(vim-fzのバックエンド)がとりわけ起動が遅いというわけではない。

プラグインを使わないやり方

一応プラグインを使わずにファジーファインダーを使う方法もあります。
例えば、:terminalでfzfを使う方法やtmuxのpaneを使ってファジーファインダーを起動してVim側に受け渡す方法などが挙げられます。

ファジーファインダー系プラグインの選び方

ファジーファインダー選びはVimプラグインの選択の中でもかなり難しい選択になるかとは思いますが(機能が多くて把握するのが難しく、誤った選択をしたあとの乗り換えのコストが高いため)、一応判断する上で役に立ちそうな指針を書いておきます。

まずは自分のVimのスタイルと各種要件(Vimで使うかNeovimで使うか、リモートプラグインを許容するか等々)から絞るのがよいと思います。
主要なファジーファインダー系プラグイン一覧を利用して絞ってみてください。

そして、機能からさらに絞り込みます。
機能を軸にしたときの主な差別化要素は、

  • 自分のよく使うデータソースが入っているか
  • 速度(絞り込み、起動含む)
  • プレビュー機能(選択されているファイルの内容を右側等に表示する機能)
  • LSP連携

となると思います。
ファジーファインダーを使うことに慣れてくれば、5分に一回は確実に起動することになるかと思いますので、速度や体験は非常に大事になってきます。

検索を効率的に絞り込むファジーファインダーを絞り込むのにこんなに手間がかかるのは正直本末転倒な気もしますが、それもまたVimです。
ファジーファインダーを使いこなしてよいVimライフを送り、さらに生産性を高められることを願っています...