タイトル通り.
vim で editorconfig を使うための手順をまとめる.
私が vim の初心者なので, ど基礎から.
概要は次の通り.
動作環境
- macOS Mojave 10.14.x
- vim 8.1
vim はデフォルトで mac に入っていたものを使おうと思ったが, 本記事作成を期に brew で入れ直した.
brew 経由で vim を mac に入れる手順はこちらの記事にまとめた.
前提条件
前提条件は次の通り.
- cURL が使えること
editorconfig とは
- indent size, tab size とかを一律揃えてくれる便利なやつ.
- プロジェクトに参加する人で争わずに済む素敵なツール.
.editorconfigを読み込んで反映する plugin
公式サイトはこちら.
vim plugin 管理ツール (plugin manager) について
win. でいうところの chocolatey みたいな.
mac. でいうところの brew, pip みたいな.
phpenv や ndenv 等のバージョン管理ツールをもっと楽にしてくれる anyenv みたいな.
まぁそんな感じの plugin 管理ツールなるものがいくつかあるっぽい.
ちょっとググると plugin manager 的な呼び方もされてる.
今回利用する editorconfig は plugin manager のどれかを利用して inst. する.
github の installation を眺めると3通りの inst. 方法が書いてある.
その中の2つが次の plugin manager を利用した方法になっている.
- pathogen
- Vundle
ちなみに pathogen は 「病原体」 という意味.
世の中的には他にも色んな plugin manager があるっぽい.
私は pathogen を使うことにした.
理由は次の通り.
- editorconfig の installation で既に2つに絞って紹介されているから
- ちょっと調べたら pathogen の方がシンプルで使いやすい って評判だったから
ひとまず pathogen を inst. するか.
plugin manager である pathogen を install.
editorconfig の installation を見ても 「pathoegen 使ってね」 としか書いてない.
じゃあ pathogen を先に入れよう.
pathogen の github はこちら.
↑ここに書いてある installation に従う.
次のコマンドで install する.
# isntall
$ mkdir -p ~/.vim/autoload ~/.vim/bundle && \
curl -LSso ~/.vim/autoload/pathogen.vim https://tpo.pe/pathogen.vim
# 確認
$ ls -lah ~/.vim/
total 8
drwxr-xr-x 5 kengo staff 160B 1 14 18:25 .
drwxr-xr-x+ 34 kengo staff 1.1K 1 14 17:38 ..
-rw-r--r-- 1 kengo staff 410B 1 13 18:25 .netrwhist
drwxr-xr-x 3 kengo staff 96B 1 14 18:25 autoload
drwxr-xr-x 2 kengo staff 64B 1 14 18:25 bundle
これで home directory に .vim という dir. が作成される.
次の一文を .vimrc に書くと runtime path の設定が完了するらしい.
execute pathogen#infect()
github の installation によると, 自分が入れたい pluging は全部次の場所に格納されるらしい.
~/.vim/bunle
pathogen の install については以上.
次は editorconfig を isnt. するか.
editorconfig isntall
さっき入れた patheogen を利用して editorconfig を inst. する.
# install
$ cd ~/.vim/bundle && git clone https://github.com/editorconfig/editorconfig-vim.git
# 確認
$ ls -lah ~/.vim/bundle
total 0
drwxr-xr-x 3 kengo staff 96B 1 14 19:18 .
drwxr-xr-x 5 kengo staff 160B 1 14 18:25 ..
drwxr-xr-x 15 kengo staff 480B 1 14 19:18 editorconfig-vim
editorconfig を使ってみる
たとえば次のような .editorconfig をプロジェクト dir. に置いてみよう.
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
trim_trailing_whitespace = true
[*.php]
indent_size = 4
indent_style = space
trim_trailing_whitespace = true
insert_final_newline = true
end_of_line = lf
[*.blade.php]
indent_size = 2
indent_style = space
trim_trailing_whitespace = true
insert_final_newline = true
end_of_line = lf
[*.md]
indent_style = space
indent_size = 4
trim_trailing_whitespace = false
insert_final_newline = true
end_of_line = lf
[*.yml]
indent_style = tab
indent_size = 4
end_of_line = lf
そして, vim で適当なファイルを開いて tab やら 保存 やらしてみよう.
期待通りの動作になっているはず.
今回は以上.