vimdiffの使い方 Vimで差分を表示してマージする(do / dp)
2つの設定ファイルのどこが違うのか目で追うのは時間がかかります。Vimには標準でdiff機能が組み込まれており、vimdiffで差分を色分け表示し、そのままdoやdpで片側の内容を取り込んでマージするところまで、外部ツールなしで進められます。
目次(11項目)
| 操作 | これだけ覚える |
|---|---|
vimdiff f1 f2 | 2ファイルを比較しながら開く |
:diffsplit file | 開いているファイルと比較する |
| [c / ]c | 前 / 次の差分箇所へ移動 |
| do | 相手の内容を取り込む(:diffget) |
| dp | 自分の内容を相手へ送る(:diffput) |
:diffoff! | 差分表示を終了 |
ターミナルから直接比較する
vimdiff ファイル1 ファイル2
gvimdiff ファイル1 ファイル2
次のコマンドでも同じ動作になります。同時に比べられるのは8ファイルまでで、9つ目を渡すとE96: Cannot diff more than 8 buffersが出ます。
vim -d ファイル1 ファイル2
nvim -d ファイル1 ファイル2
デフォルトでは垂直分割(左右並び)で開かれます。上下に並べたい場合は-oオプションを付けます。
vim -d -o ファイル1 ファイル2
vimdiff file1 file2が最短です。分割方向を変えたいなら-oを追加します。
vimdiff old.conf new.conf の画面。変更行に色が付き、片方にしかない行は横線で示されるVimを開いた状態から比較する
すでに1つのファイルを開いている状態で、別のファイルと比較したいこともあります。
:diffsplit 比較対象ファイルパス
:vertical diffsplit 比較対象ファイルパス
1行目は今開いているバッファと指定したファイルを上下に並べて比較し、verticalを前置すると左右に並びます。すでに分割して開いているウィンドウ同士を後から比べたいときは、それぞれのウィンドウで:diffthisを実行すると差分表示に切り替わります。
差分箇所を移動する
[c " 前(上)の差分箇所へ移動
]c " 次(下)の差分箇所へ移動
ファイルが長い場合、スクロールで探すより]cで差分箇所だけを飛び移ったほうが速くなります。最後の差分で]cを押してもエラーは出ず、カーソルがその場に留まるだけです。変わっていない行は自動で折りたたまれているので、畳まれた部分を読みたいときは折りたたみの開閉がそのまま効きます。
差分を取り込む(do / :diffget)
差分を眺めるだけでなく、その場でどちらかの内容を採用して寄せることもできます。カーソルのある差分箇所について、もう一方のバッファの内容を今のバッファへ取り込む(上書きする)のが:diffgetで、キーではdoです。
:diffget
do " diff obtain の略
doは「diff obtain」の略で、:diffgetの頭文字のd+gではない点に注意してください。連続した行の差分であれば、1回でまとめて取り込めます。
function greet() {
console.log('hi');
}
function greet() {
console.log('hello');
}
もう一方のバッファではconsole.log('hello')となっており、その内容がそのまま取り込まれます。差分の一部だけを取り込みたいときは、:1,2diffgetのように行範囲を付けます。
vimdiff local.txt remote.txt の画面。行の中で変わった部分だけ色が濃くなる自分の変更を相手へ送る(dp / :diffput)
向きが逆なのが:diffputです。今のバッファの、カーソルがある差分箇所の内容を、もう一方のバッファへ反映します。
:diffput
dp " diff put の略
dpはコマンド名の:diffputとそのまま対応しているので、doより覚えやすいはずです。どちらも変更は通常の編集と同じ扱いなので、向きを取り違えてもuで戻せます。
この流れが使えるのはテキストファイルの差分に限られます。画像やzipのようなバイナリファイルはそもそもdiff表示ができないため、行単位で取り込むのではなくどちらの版を採用するかをGit側で指定する形になります。
2つの環境で少しずつ育ってしまった設定ファイルを1つにまとめる作業で、doとdpを使うようになってから、コピー&ペーストで取り違えるミスがなくなりました。1文字違いで向きが逆になるので最初は緊張しながら押していましたが、慣れると迷わず打てるようになりました。
3ファイル以上では取り込み元を指定する
3つ以上のウィンドウを差分表示にしていると、引数なしのdoや:diffgetはどれから取り込むかが決まらず、E101: More than two buffers in diff mode, don't know which one to useで止まります。この場合はバッファ番号か、バッファ名の一部を引数に渡します。
:diffget 3 " :ls で調べたバッファ番号
:diffget REMOTE " 名前に REMOTE を含むバッファ
:diffput 2
名前の一部で指定できるのは、git mergetoolがファイル名にLOCAL・REMOTE・BASEを入れて開くからです。4画面のコンフリクト解消の進め方と終わり方はgit mergetoolでvimdiffを使う手順にまとめました。
差分を取り直す・終了する
Vimは編集のたびに差分を計算し直しますが、外部でファイルが書き換えられた場合などは表示が追随しないことがあります。表示がおかしいと感じたら、まず:diffupdateを打ってください。これで直らなければ、実際に内容がずれています。
:diffupdate " 差分を計算し直す
:diffoff " 今のウィンドウの差分表示を解除
:diffoff! " タブ内の全ウィンドウの差分表示を解除
比較が終わったら:diffoff!で通常の表示に戻せます(:help :diffoff)。マージ作業だった場合は、終える前に]cを押してカーソルが動かない(差分が残っていない)ことと、コンフリクトの目印が本文に残っていないことを確かめます。
/^<<<<<<<\|^=======\|^>>>>>>>
この検索で何も見つからなければ大丈夫です。目印が残ったまま保存すると、そのままコミットされてしまいます。手元にパッチファイルがあるなら、:diffpatch パッチファイルで今のバッファに当てた結果を差分表示で確かめることもできます。
差分の出方を diffopt で調整する
インデントだけを直したファイルを比べると、全行が差分として出てしまいます。空白の違いを無視する指定を入れると、意味のある変更だけが残ります。
set diffopt+=iwhite " 空白の量の違いを無視する
set diffopt+=internal,algorithm:histogram
set diffopt+=context:99999 " 変わっていない行を畳まない
iwhiteはインデントの深さを2から4に変えたような違いを無視しますが、行頭に空白が無かった行へインデントを足した場合は差分に残ります。それも消したいときはiwhiteallにします。2行目は差分の計算方法を変える指定です。既定の方法より、行の移動やまとまった変更を人間に近い形でまとめてくれます。差分がばらばらに出て読みにくいと感じたら試してみてください。ただしmacOSに最初から入っている/usr/bin/vim(Vim 9.1)は内部の差分エンジン無しでビルドされており、この行はE474: Invalid argumentになります。その場合は外部のdiffコマンドで比べる既定の動作のまま使うか、Homebrewなどで入れたVimかNeovimを使ってください。3行目は差分の前後に残す行数を大きくして、自動の折りたたみを実質的に止めます。一時的に全部見たいだけならzRで開くほうが手軽です。
設定ファイルを書き換える前に、バックアップとの差分をvimdiffで確認する習慣をつけてから、意図しない変更に気づかず保存してしまう事故がなくなりました。ターミナルでdiffコマンドの出力を目で追うより、色分け表示で該当箇所へ直接ジャンプできるほうが圧倒的に速いと感じます。
全行が差分になるとき
中身は同じはずなのに全行が違うと表示される場合、まず疑うのは改行コードです。改行がすべてCRLFのファイルはfileformat=dosとして読まれるので、LFのファイルと比べても差分にはなりません。困るのは1つのファイルにCRLFとLFが混ざっている場合で、fileformat=unixとして読まれ、CRLFの行の末尾に^Mが見えている状態になります。そうなると、その行はすべて相手と違うと判定されます。
:set ff? " それぞれのウィンドウで確認する
:e ++ff=unix " 揃えて開き直す
文字コードも、どちらかの判定が外れて化けていると同じことが起きます(両方が正しく判定されていれば、文字コードが違っても中身が同じなら差分にはなりません)。どちらもfileformatとfileencodingを揃えてから比べ直せば解決します。差分を見る前に、両方のウィンドウで :set ff? fenc? を打つ癖を付けておくと早く気づけます。
まとめ
ファイル間の差分確認はvimdiff、Vimを開いた状態からなら:diffsplitか:diffthisを使います。[c/]cで差分箇所を移動し、do(相手から取り込む)とdp(自分から渡す)で寄せていけば、外部ツールなしで比較からマージまで済みます。3ファイル以上を開いたときだけは、:diffgetにバッファを指定してください。