Vimの実践練習 - 変数名の一括置換と繰り返しでのリネーム

置換と繰り返しの使い分け

:%s は速いかわりに、意図しない場所まで書き換わることがあります。user を置換したつもりが username まで変わった、というのはよくある事故です。単語として一致させるなら :%s/\<user\>/member/g のように単語境界を書きます。

いっぽう * と . の組み合わせは、1か所ずつ目で見て決められます。* は最初から単語単位で検索するので、部分一致の巻き込みも起きません。数か所なら、こちらのほうが安全です。

:%s/user/member/gc のように c を付けると、1か所ごとに置換するかどうかを聞いてきます。一括置換の速さと目視の安全さの中間です。

変数名を置換するとき、コードの中の識別子だけを見ていると取りこぼしが出ます。文字列リテラルの中、コメント、ログに出しているメッセージ、テストの期待値などにも同じ名前が書かれていることがあります。

逆に、それらを機械的に一括置換すると、変えてはいけない文言まで変わります。c フラグを付けて1件ずつ確認するか、まず / で検索して当たる場所を眺めてから範囲を決めるのが確実です。

ファイル全体ではなく特定の関数の中だけを直したいときは、範囲を書きます。ビジュアルモードで選んでから : を押せば :'<,'>s/user/member/g の形になり、選んだ範囲だけが対象になります。

行番号で :10,40s/user/member/g と書くこともできます。範囲を絞れば単語境界を書かなくても事故が起きにくくなるので、書き方が思い出せないときはこちらでも構いません。

NeovimでLSPを設定していれば、識別子の上で grn を押すことで言語サーバーによるリネームができます。文字列やコメントを巻き込まず、他のファイルにある参照もまとめて直せるので、本格的なリファクタリングではこちらが向きます。

この練習で扱っているのは、1つのバッファの中を自分の目で確かめながら直す方法です。LSPが使えない環境や、設定ファイル・ログ・原稿のようにコードではないテキストでは、こちらの手が必要になります。