.vimrcに設定しているプラグインの一つvim-easy-alignの使い方を備忘録として、簡単なメモに残します。
vim-easy-alignとは
vim-easy-alignは、区切り文字でパラグラフを簡単に整形できるプラグイン。例えば、プログラムの可読性を高めるために、コマンド一つで=の位置をを同じに出来たり、マークダウン記法のテーブルを見やすく整形出来たりする。
使い方
下記のように設定すると、ノーマルモード、ヴィジュアルモードでgaコマンドが利用できるようになる。
"=======================================
" vim-easy-align
"=======================================
xmap ga <Plug>(EasyAlign)
nmap ga <Plug>(EasyAlign)
基本のコマンドと覚え方は、次の通り（=は場面に応じて切り替える）。
| コマンド | 覚え方 |
|---|---|
| vipga= | visual-select inner paragragh ga = |
| gaip= | ga inner paragragh = |
個人的に、使用頻度が高いのは、次の二つ。
- =（イコール）を基準に整形する
- テーブルを見やすく整形する
それぞれ主に、gaip=、gaip*|コマンドを使う。
1. =（イコール）を基準に整形する
before
i = 0
x, y = 3, 4
ary = [1, 2, 3]
gaip=コマンドを使うと、
after
i = 0
x, y = 3, 4
ary = [1, 2, 3]
2, テーブルを見やすく整形する
before
|command|how to remember|
|---|---|
|vipga=|visual-select inner paragragh ga =|
|gaip=|ga inner paragragh =|
gaip*|コマンドを使うと、
after
| command | how to remember |
| --- | --- |
| vipga= | visual-select inner paragragh ga = |
| gaip= | ga inner paragragh = |
といった具合である。
=の代わりに使えるその他
| コマンド | 説明 |
|---|---|
| = | 一致した一つ目の=を基準に整列させる |
| 2= | 一致した二つ目の=を基準に整列させる |
| *= | 一致した全ての=を基準に整列させる |
| **= | 一致した全ての=を基準に左右交互に整列させる |
| Enter | 整列させる位置を（左/ 右/ 中央）で切り替える |
Enterの使い方
-
<Enter>一回で右に、二回で中央に整列させることができる。<Enter>なしでは、上記の二つの例で見たように、左詰で整列させる(デフォルト)。 -
gaip<Enter><Enter>*=のように使う。