Vimをちゃんと知りたい!だからHelpを日本語化する!


Qiita初投稿です! ガイドライン を見ながらやってみようの精神。

はじめに

Vimを使い始めたのは「どんなサーバーでもだいたい入ってるから」という程度で、かなり安易なものでした。最初は「なんだこれ?」って思っていたキーバインドもすぐに馴染んで、今ではJetbrainsのIDEでもVimのキーバインドを適用しているほど気に入っています。
とはいえ、今までなんとなくVimを使い、なんとなくvimrcを書いていたところがありました。そして気が付きました。Vimのことを全然知らないということを。。。

よし!じゃあVimのことを知りましょう!
ということで、この記事では僕がVimを知るためにやったことをメモします。
また、VimのHelpを読み進めるのにあたり日本語化したくなったので、その方法についても記載します。
上述のようになんとなくでVimを使っていた人、Vimを使い始めたけど使い方がよく分からんって思っている人ちょっと興味あるんだけどVimってなに?っていう人の目に留まればと思います。

Vimを知る

Vimを知るためには、実際にVimと触れ合うことが大切です。
僕もPC(MacOSX High Sierra:10.13.6)からVimを立ち上げ、を触ってみることにしました。

まずやること

まずはVimを立ち上げましょう。コマンドラインでvimと打ちます。
ちなみに僕のVimバージョンは以下でした。

$ vim --version
VIM - Vi IMproved 8.1 (2018 May 18, compiled Oct 29 2018 06:56:05)
macOS version
Included patches: 1-500
Compiled by Homebrew

Vimが立ち上がったら、次のように表示されます。

この時点で、Vimは僕らに道を指し示してくれています。さぁ、キーボードで:helpと入力しましょう!

英語のヘルプ画面が現れました。まずは操作説明から!
良いですね!僕はやる気に満ち溢れています。どんどん進めていきますよ!

ふむふむ、チュートリアルもあるんですね!30分コースですか!良いでしょう!!
tutorにカーソルをあわせてCTRL-]で飛びます!!
さっそくCTRL-]を使えたぞ!楽しい!意味もなくCTRL-Oで戻ってみたりなんかしちゃいます!!

なるほど。この画面ではなく別途vimtutorというコマンドがあって、そちらにチュートリアルがあるんですね!

Vimのチュートリアルを一巡してみる

一旦Vimを:q!で閉じ、コマンドラインでvimtutorと打ってみましょう。

おぉ!今度は日本語で表示されました。これは嬉しい誤算!!
※もし日本語で表示されなければコマンドラインを打つ際にvimtutor jaと入力してみてください。日本語で表示されるはずです。

vimtutorすごく良いですね!!

このチュートリアルが、使うことで覚えられる仕組みになっていることを、心しておかなければなりません。正しく学習するにはコマンドを実際に試さなければならないのです。文章を読んだだけならば、きっと忘れてしまいます!

と記載がある通り、実際に手を動かして学習することができます。
新しいことを知るって楽しい!!

チュートリアル完了から新たな一歩を踏み出す

さて、お次は何をすれば良いのか。見てみましょう。
Vimを立ち上げ、:helpから先程の画面の続きを見てみます。

ふむふむ。

ほうほう。。。

。。。

なかなかボリュームがありますね!(1つ1つのドキュメントもなかなか。。。
そして僕は英語力があまり高くないです!

日本語化されたVimのHelpを読もう!

英語で全部読むのはちょっと辛いな〜と思ったところでvim-jpにたどり着きました!
これは良いな!と思い早速マニュアルのページを開くことに。
なにやら見たことのある内容ですね!!失ったやる気も上り調子です!!

vim-jpでhelpを読み始める

英語版で習ったことの確認もしたいので、vim-jpの冒頭から軽く流してみます。
するとあることを思い立ちました。このサイトVimで開きたいなと。
実際helpを読み進めるのにVimで開いたほうが都合がいいですし、将来的にもVimを操作している時にサッと日本語化されたhelpを開きたくなるはず。

Vim上で日本語化されたhelpを開きたい

Vim上で日本語化されたhelpを開く方法を調べてみました。
Vimヘルプを日本語化!の記事が参考になります。
まずはvim-plugを入れます。Installationに記載の内容をもとに、コマンドライン上で以下を実行します。

curl -fLo ~/.vim/autoload/plug.vim --create-dirs \
    https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim

つぎに、Usageを参考にPluginの設定を書きます。ここでは日本語化したいだけなので、最低限のPlug~/.vimrcファイルに追記します。

.vimrc
call plug#begin('~/.vim/plugged')
" A project which translate Vim documents into Japanese.
Plug 'vim-jp/vimdoc-ja'
call plug#end()

set helplang=ja,en

set helplang=ja,enについてはvim-jaのwikiに以下の記載があります。

:help コマンドで英語のヘルプが表示される場合は日本語の優先順位をあげてください。vimrc に以下を追記します。

vimrcへの設定が完了したら、仕上げです。Vimを立ち上げて:PlugInstallと入力しましょう。するとPluginのインストールが始まります。
これで準備は完了です。さぁ:helpと入力してみましょう!

日本語化されたHelpが表示されました!皆さんの環境ではどうでしょうか?
これならある程度のボリュームがあっても読み進められそうです。

おわりに

これでHelpを読むハードルは下がりました。あとはじっくりHelpを読んで、Vimを知っていきたいと思います。
ちなみに僕は上級編あたりまでは読みたいなと考えています。それ以上は必要に応じて。。。