VimでPipfileを構文ハイライトされた状態で編集

Byraimon, 2017-04-29(土), in category Vim

Python, Vim

Pythonの requirements.txt に変わる新しい依存パッケージ管理用に開発が進められているPipfileをVimで編集する際の設定方法についてまとめる。

TOMLとJSONに適したVimの構文ハイライト用プラグインを導入

まず Pipfile はTOMLベース、バージョンロックを書き出して記録する Pipfile.lock はJSONベースであるため、それぞれ適したVimの構文ハイライト用プラグインを導入しておく。

JSONに関しては、元々Vimでサポートされているが、よりベターな実装があるため、そちらを利用するのがおすすめである。

それぞれのファイル読込時に構文ハイライトを適用させる

あとは、それぞれのファイル読込時に、ファイル名で判定して構文ハイライトを適用してやれば綺麗に編集できるようになる。

au BufNewFile,BufRead Pipfile setf toml
au BufNewFile,BufRead Pipfile.lock setf json

例として PipfilePipfile.lock それぞれのファイル編集時に構文ハイライトが適用された編集画面のキャプチャを紹介しておく。なお現行の依存パッケージ管理ファイルフォーマットである requirements.txt 編集時はrequirements.txt.vimを導入すると同様の事が可能になる。

構文ハイライトが適用された編集画面