vim-surroundで文字列を複数文字('**'など)で囲む

Octopressで強調表示をしようと思うと **で囲えば太字にしてくれますが(*一つはイタリック)、囲うのが面倒であまり使ってませんでした。

これを使っていくために簡単に使える様にプラグインを使って設定しなおしました。

vim-surround
キー設定

vim-surround

vim-surroundは文字列を囲う括弧などをスマートに扱えるようになるプラグインです。

NeoBundleなどを使っていたら.vimrcに

.vimrc

NeoBundle "trope/vim-surround"

を加えておくだけで入れられます。

これだけでも

"Hello| world!"

と言う文字列の|のところにカーソルがあったとして、ノーマルモードでds"(delete surround “)とするだけで両側の"が消えます。 "は大概の記号が使えます。

括弧とかだと{を使うと{ a }の様に両側に空白をいれ、 }を使うと{a}の様に空白無し、にしたりします。

また、tはタグを意味し、<div>~</div>みたいな中でdstすると両側のタグが消えます。

cs"'(change surround “ (to) ‘)とすれば"が'に変わります。

逆に単語の途中にカーソルがあるときにysiw"(you surround inner word (with) “)と押すと単語の両側を"で囲います ¹ 。

ビジュアルモードに置いてはS"とSを使うとその囲った部分を"で囲ってくれます。

一つだけ、vim-surroundで行われる動作をuで取り消そうとすると結構予期しない動作をします。囲む作業で色々な動作を指定てその辺が上手くヒストリーできてないのか仕方ないのかわかりませんが、囲んだ後にuとかしようとする場合には多少手作業が必要になることもあるので気をつけます。

キー設定

このままでも大分便利ですが、ysiw"とかはちょっと長いのでキーマップします。

.vimrc

let g:surround_{char2nr("a")} = "**\r**"
nm <Leader>{ ysiw{
nm <Leader>} ysiw}
nm <Leader>[ ysiw[
nm <Leader>] ysiw]
nm <Leader>( ysiw(
nm <Leader>) ysiw)
nm <Leader>< ysiw<
nm <Leader>> ysiw>
nm <Leader>" ysiw"
nm <Leader>' ysiw'
nm <Leader>` ysiw`
nm <Leader>* ysiw*
nm <Leader><Leader>* ysiw*wysiw*
nm <Leader>a ysiwa
xm { S{
xm } S}
xm [ S[
xm ] S]
xm ( S(
xm ) S)
xm < S<
xm > S>
xm " S"
xm ' S'
xm ` S`
xm * S*
xm <Leader>* S*gvS*
xm <Leader>a Sa

ノーマルモードでは<Leader> と記号を使ってカーソル下の記号を囲う様に設定。

<Leader>は通常は\ですが自分設定では

" mapleader (<Leader>) (default is \)
let mapleader = ","
" use \ as , instead
no <Subleader> <Nop>
map \ <Subleader>
no <Subleader>, ,

として、,を<Leader>として使って \へは<Subleader>とういものを新たに割り当てて、一応\,で,を使える様にしてあります。 (faとかで飛んだ時に;でもう一つ進むのに対して後ろに戻るキー。ほとんど使いませんが。。。)

ビジュアルモードでは記号を押すだけで選択範囲を囲う様に設定。

この設定はずいぶん前からあったんですが、今回アスタリスクのものも付け加えて、特に、nm <Leader><Leader>* ysiw*wysiw* 等<Leader>をもう一つ打つことで*2つで囲う、という項目も入れました。

この設定により、ノーマルモードからでも一発で**を両側における様になります。

追記: 2016/03/12

let g:surround_{char2nr("a")} = "**\r**"

を追加。 vim-surroundではこの様にg:surruound_{char2nr("<char>")} という変数を使ってaを記号の一つの様に使え、それに対して囲む物を定義することが出来ます。

定義は\rで分けて左側と右側に囲むのにつかう文字列を入れます。ここに複数文字を入れることが出来るので、"<div>\r</div>" みたいなものをdに割り当てたり数rことも可能です。

追記ここまで

これでOctopressで強調したい単語が出てきた時も単語上で,*したり、ビジュルモードで適当に囲んで,,*するだけですぐに強調表示に出来ます。

これまではなんとなく強調したいだけのものも、'で囲うことが多かったのですが、なんとなく見難い感じもするので、コードっぽいものとそうでないものと分けてやってみようかと思います。

まあ、気分次第ですが。