Vimプラグイン解説〜闇のプラグインシリーズ:dein.vim編

始めに

この記事は、Shougo氏が作製するプラグインを解説する、闇のプラグインシリーズ第1弾になります。
第1弾では、Vim/Neovimのプラグインマネージャーである、dein.vimを紹介していこうと思います。

ただ、紹介するだけなら、ググればいろいろ出てきます。
ですので、dein.vimがプラグインをどのように管理しているのか、読み解いてみようと思います。

自らがVim、もしくはテキストエディタと一体化することを望まないなら、気を付けた方がいい。

深淵(Vim)をのぞく時、深淵(Vim)もまたこちらをのぞいているのだ。

フリードリヒ・ニーチェの名言よりオマージュ

runtimepathから見るプラグインマネージャー

Vim/Neovimのプラグインと呼ばれる物は、基本的にはruntimepathに指定したパスを起点に、特定のディレクトリ内のスクリプトをプラグインと呼んでいます。
これは、GitHubで配布されているプラグインにかかわらず、最初からいくつかの基本プラグインが読み込まれています。

ただruntimepathは、指定したパス内の特定のディレクトリを読み込みに行くという単純な動作のため、
プラグインマネージャーとは、スクリプトを使ってruntimepath管理をしやすくしている物と思ってください。

また、プラグインマネージャーの機能として、自動でプラグインのインストールと更新をしたり、特定のファイルタイプでプラグインが起動するようなオプションを提供しています。

では、dein.vimはどうなっているのか。

例外なくdein.vimもruntimepathを利用していますが、既存のruntimepathを上書きをして高速化を実現しています。
つまり、dein.vimを導入するということは、全体のruntimepathの管理をdein.vimで行うことになるのです。
dein.vimはVim/Neovimが起動するまでのプロセスの妨げにならず、ユーザーがすべてを操作できるように機能が提供されています。

しかし、それらの機能を理解しないで使うということは、宝の持ち腐れになります。
自分がヘルプやソースコードを読んで、こう思いました。
「プラグインをインストールして遅延起動させたいだけなら、ほかのプラグインマネージャーで良い。
Vim/Neovimを極限まで調整したい人なら、導入していじり倒すべきプラグインマネージャーなのだ。」

他のプラグインマネージャーとの比較

それでは、dein.vimがVim/Neovimを極限まで調整する人向けのプラグインマネージャーということが分ってもらえたと思います。
ですので、少々脱線してほかのプラグインマネージャーも見てみようと思います。

組込みのプラグインマネージャー

Vim/Neovimには、packagesという組込みのプラグインマネージャーが存在します。
詳しいことは:h packagesをご覧いただければ分ると思いますが、結果的にruntimepathを使用してプラグインを読み込むことに変わりありません。
プラグインマネージャーを使わず、組込みの機能だけを使うという方は、こちらをお使いください。

Neovim限定のプラグインマネージャー

最近では、packagesを使うプラグインマネージャーが出てきています。
その中でもpacker.nvimは有名で、packagesを使ってプラグイン管理をしています。

Neovimでは、Luaで設定ができるようになっていて、NeoVimユーザーならLuaで設定を書くと速くなると言われています。
packer.nvimのコーディングにはLuaが使われているので、Neovim永住宣言をしている方にピッタリだと思います。

大手のプラグインマネージャー

Vim/Neovimのプラグインマネージャー界隈でも、大手のvim-plugがあります。
こちらは、ワンスクリプトで完結していて、runtimepathをセットしたパス内のautoload/に配置して、プラグインがダウンロードされる場所を指定するだけで使えるミニマルなプラグインマネージャーです。
このプラグインマネージャーは機能がシンプルで、Vimを初めて触るという方が、プラグインを入れたいと言ったら、お勧めするプラグインマネージャーです。

「えっ？ dein.vimの紹介なのに、ほかのプラグインマネージャーをお勧めしちゃうの？」と、思われるかもしれません。
先にも説明した通り、dein.vimはVim/Neovimを極限まで調整したいユーザーが導入するべきプラグインマネージャーであり、初心者にお勧めするプラグインマネージャーではないのです。
しかし、このvim-plugは設定もシンプルで、難しいところが少ないので、Vimでプラグインを入れてみたいだけならこれで十分なのです。

つまり、対象としているユーザー層が違うのです。

dein.vim~高速化の鍵~

ここからは、dein.vimがどのようにして高速化を実現しているか、紐解いていきたいと思います。

今回は、以下の環境で見ていきます。

OS

Linux系

Vim or Neovim

Neovim

インストール先

~/.cache/dein

プラグイン管理方式

tomlファイル

設定ファイルの場所

~/.vim/

また、dein.vimのインストールで使用するスクリプトは以下のようにしています。

dein.vimインストールスクリプト

~/.config/nvim/init.vim

source ~/.vim/init.vim

~/.vim/init.vim

if &compatible
  set nocompatible
endif

" dein base directory.
let s:dein_dir = expand('~/.cache/dein')

" dein repository directory.
let s:dein_repo = s:dein_dir . '/repos/github.com/Shougo/dein.vim'

" vim setting directory.
let g:base_dir = fnamemodify(expand('<sfile>'), ':h') .. '/'

" plugins toml-file directory.
let s:toml_dir = g:base_dir ..'toml/'


if &runtimepath !~# '/dein.vim'
    if !isdirectory(s:dein_repo)
        execute '!git clone https://github.com/Shougo/dein.vim' s:dein_repo
    endif
    execute 'set runtimepath^=' . s:dein_repo
endif

if dein#min#load_state(s:dein_dir)
    call dein#begin(s:dein_dir)

    let s:dein_toml = s:toml_dir .. 'dein.toml'
    let s:dein_lazy_toml = s:toml_dir .. 'lazy.toml'

    " read toml and cache
    call dein#load_toml(s:dein_toml, {'lazy': 0})
    call dein#load_toml(s:dein_lazy_toml, {'lazy': 1})

    " end settings
    call dein#end()
    call dein#save_state()
endif


if dein#check_install()
    call dein#install()
endif

filetype plugin indent on
syntax enable

no_lazyのプラグインも高速化するマージ機能

tomlファイルでプラグインを管理する場合dein#load_toml()を使い、読み込むtomlファイルとオプションを指定します。
オプションでは主に遅延の有無で、2つのtomlファイルを用意ことになると思います。
ここからすでに高速化は始まっていて、最初の鍵になるのは、遅延設定をしていないtomlファイルなのです。

どちらかというとVimEnterの後に、プラグインを起動させることが高速化につながるのですが、dein.vimは違います。
遅延設定していないプラグインにこそ、高速化のひと手間を施しているのです。
先に解説した通り、プラグインはruntimepathに指定されたパス内のディレクトリにあるスクリプトを読み込むことで、プラグインとして成り立ちます。
このruntimepathというのは指定された分だけちゃんと順番に読み込むので、パスの数が多くなればなるほど、読み込みに時間がかかるようになるのです。
遅延設定をしていないプラグインがあった場合、通常ですとプラグインマネージャーがダウンロードしてきたプラグインのディレクトリのパスを指定して、Vimが起動する際にruntimepathが順次読み込みにいきます。

しかし、dein.vimでは違います。
遅延設定していないプラグインは~/.cache/dein/.cache/init.vim/.dein/¹というディレクトリにマージされて、読み込むruntimepathの数を少なくしてくれます。
runtimepathの読み込みはパス内の読み込むディレクトリをすべて読み込んだあと、次のパスの読み込みに移ります。
この数をdein.vimでは、ディレクトリをマージしてしまうことで少なくしているのですね。
もちろんプラグインによってはマージされたら困るものや、スクリプト名が被ってしまう可能性もありますので、ユーザーが明示的にマージを無効化できます。

プラグインディレクトリをマージしてほしくない場合は、toml内で以下のように記述します。

dein_no_lazy.toml

[[plugins]]
repo = 'user_name/repository_name'
merged = 0

マージして読み込むディレクトリを少くしても、読み込むスクリプトが多ければ時間がかかるので、マージ機能を過信しないでください。
あくまで、読み込みを高速化するために、ひと手間処理をしてくれているものと思ってください。

設定はstate_nvim.vim²に集結する。

プラグイン読み込みのタイミングを指定する方法はいくつかありますが、on_*系が一番ポピュラーですね。

dein.vimでは、プラグインの読み込みや更新のタイミングでフックして、ユーザーが書いた設定処理を実行できます。
フックについて分りやすいのは以下の記事になります。

それでは、プラグインの読み込みタイミングや設定内容が、どのように処理されているのかというと、~/.cache/dein/state_nvim.vimにまとめられています。
実際にプラグインをインストールして、いくつか設定をしたうえでstate_nvim.vimを見てみると、tomlファイルに記述した設定内容がVim Scriptになって反映されています。

ここでも読み込むファイル数を少なくして、高速化を図るdein.vimの設計思想が伺えますね。
そして、state_nvim.vimを読んでもらえると分るかと思いますが、ここではVim/Neovimの起動時のruntimepathを定義しています。

これらの処理は、dein#save_state()によって実行され、state_nvim.vimを生成してくれます。

プラグインの更新について

dein.vimでは、プラグインの更新に使う関数として、dein#update()があります。
通常プラグインの更新というと、各リポジトリのmaster/mainブランチのバージョンを確認してプルなどで更新します。
しかし、dein.vimは更新確認にgitコマンドを使用しないで、.git/内のファイルを参照してバージョンを確認しているようです。
Windowsでは外部プロセスの起動に時間がかかるため、高速化になるようです。

以下は参考記事になります。

お勧めのオプション

dein.vimで使わなくても大丈夫だけど、使うともっと便利に高速化できるオプションを紹介したいと思います。

g:dein#inline_vimrcsで分割している設定を、state_nvim.vimにまとめる。

ファイルの見通しを良くするために設定ファイルを分割するユーザーもいます。

たとえば、:setなどの基本オプションだけまとめたスクリプトや、オレオレキーバインド、GUI専用のオプション……etc.

そういった人のために、それらの設定をstate_nvim.vimにまとめてくれる機能がdein.vimにはあります。

設定方法は簡単で、読み込んでほしい設定ファイルのパスをg:dein#inline_vimrcsに追加することです。
g:dein#inline_vimrcsはリスト型になっているので、if has() … endとadd()を使えば使用条件によって、読み込む設定ファイルの変更が可能です。

g:dein#inline_vimrcs = []の記述例

ディレクトリ構造は、ここで解説したものを元に記述例を書いていきます。
.vim/rc/には、以下のファイルがあるものとします。

ファイル名	説明
option.vim	:setで始まる基本設定。
keybind.vim	全体で使うキーバインド。
gnvim.vim	GUI版のNeovimの設定をまとめた物。

ここではgnvim.vimはターミナルで使用する場合は読み込んでほしくないので、それも踏まえた設定をしていきましょう。

~/.vim/init.vim

if &runtimepath !~# '/dein.vim'
    if !isdirectory(s:dein_repo)
        execute '!git clone https://github.com/Shougo/dein.vim' s:dein_repo
    endif
    execute 'set runtimepath^=' . s:dein_repo
endif

if dein#min#load_state(s:dein_dir)
+
+     " dein inline_vimrcs setting.{{{
+
+     let g:dein#inline_vimrcs = ['option.vim', 'keybind.vim']
+
+     if has('gui_running')
+         call add(g:dein#inline_vimrcs, 'gnvim.vim'))
+     endif
+
+     call map(g:dein#inline_vimrcs, { _, val -> s:vimrcs_dir .. val })
+
+     " }}}
+
    call dein#begin(s:dein_dir)

これでgnvim.vimはターミナルで使用するときは読み込まれず、GUIで使用する場合は読み込まれるようになりました。

注意点は、dein#begin()よりも前に定義する必要があることですね。
また、頻繁に設定を変更する場合は、キャッシュスクリプトの更新が必要です。
その更新をしてくれるdein#recache_runtimepath()という関数もありますが、その度に関数を実行するのは面倒ですので、以下のオプションを設定するのをお勧めします。

~/.vim/init.vim

if &runtimepath !~# '/dein.vim'
    if !isdirectory(s:dein_repo)
        execute '!git clone https://github.com/Shougo/dein.vim' s:dein_repo
    endif
    execute 'set runtimepath^=' . s:dein_repo
endif
+
+ " dein options {{{
+
+ let g:dein#auto_recache = v:true
+
+ " }}}

if dein#min#load_state(s:dein_dir)

自分の場合、dein.vimのインストール確認とruntimepathをセットした後に、オプション用のブロックを用意してそこに書き込んでいます。

最終的に設定ファイルが読み込まれると、コメントや空行などの無駄なものを省いて、state_nvim.vimに含めてくれます。

g:dein#lazy_rpluginsでリモートプラグインの読み込みも遅延する。

Neovimには、リモートプラグインという別の言語で書かれたプラグインを読み込むためのスクリプトがあります。
これも基本プラグインに含まれる訳ですが、依存するプラグインが起動するまで、読み込まないようにできます。
使用するプラグインの依存関係によりますが、そういったプラグインを使用しているなら、設定してみるのはどうでしょうか。

~/.vim/init.vim

if &runtimepath !~# '/dein.vim'
    if !isdirectory(s:dein_repo)
        execute '!git clone https://github.com/Shougo/dein.vim' s:dein_repo
    endif
    execute 'set runtimepath^=' . s:dein_repo
endif

" dein options {{{

let g:dein#auto_recache = v:true
+ let g:dein#lazy_rplugins = v:true

" }}}

if dein#min#load_state(s:dein_dir)

GitHub GraphQL APIを使用した、高速アップデート

上の方ではdein#update()を紹介しましたが、それよりも高速にプラグインの更新を確認してくれる機能がdein#check_update()です。
この機能を使うには、g:dein#install_github_api_tokenにGitHubから取得できるPersonal Access Token(以下：PAT)をセットする必要があります。
PATの生成方法と、dein#check_update()の使用方法は、先にも紹介した参考記事:『永遠に未完成』をご覧ください。

しかし、自分のようにdotfiles等の形でGitHubに公開している場合、PATをそのまま書き込むのは危険です。
ですので、自分流のPAT管理方法を紹介したいと思います。

まずは、PATが書かれたものをGitのトラッキング対象外にしたいので、.gitignoreに以下のものを書き加えましょう。

~/.vim/.gitignore

# Ignore github_pat
./github_pat

先の参考記事を元にPATを取得したら、.vim/github_patを作成してPATを貼り付けておきましょう。
そしたら、init.vimに以下の設定を書きましょう。

~/.vim/init.vim

" dein options {{{

let g:dein#lazy_rplugins = v:true

+ " GitHub apt file.
+ let s:github_pat = g:base_dir .. 'github_pat'
+
+ " github_patが有るか確認する。
+ if filereadable(s:github_pat)
+
+     " ここで、g:dein#install_github_api_tokenにPATをセットする。
+     let g:dein#install_github_api_token = readfile(s:github_pat)[0]
+ endif

" }}}

これで、call dein#check_update(v:true)を実行すれば、プラグインの更新をしてくれるのですが、コマンドを定義して更新しやすくしましょう。

~/dotfiles/.vim/init.vim

" Check for plugin updates on github graphQL api.{{{
command! DeinUpdate call dein#check_update(v:true)
" }}}

最後に

dein.vim研究は思った以上にたいへんで、書くのもたいへんでした…。
ソースコードやヘルプを読むのもたいへんですが、使われているテクニックを理解するのに時間がかかったり、やっていることをうまく言語化するのがたいへんでした。
ですが、今回の記事の執筆でVim/Neovimのしくみを少しずつ理解できるようになったので、良い成果だと思っています。
この記事でdein.vimを諦めた人も、チャレンジしてくれるようになったらよいなと思いました。
ちなみに自分は、より凄さを理解してしまったので、dein.vimから別のプラグインマネージャーに乗り換えるのはできなそうです。

ここでShougoさんのプラグインを個別紹介したいとか注釈に書いているけど、研究とまでは行かなくても自分の設定をさらすくらいにした方がよいかもしれないと思いました。

注釈

1. .vimrcを読み込んでいる場合、~/.cache/dein/.cache/.vimrc/.dein/になります。 ↩

2. ファイル名はNeovim使用時です。Vim使用時は、state_vim.vimになります。 ↩