CircleCIのconfig入力が補完で楽になるcircleci.vimを試してみた

circleciのconfig入力時に起こるtypo防止として、プラグイン「circleci.vim」を試してみました。
2019.10.29

はじめに

CircleCIの設定ファイルを更新した際に Validate し忘れたまま commit 及び push して、Workflow上で失敗して気がつくという事がしばしばありました。

失敗する原因にtypoが含まれることもあり、編集中の補正用vim用プラグイン「yasuhiroki/circleci.vim」を試してみました。

yasuhiroki/circleci.vim: Vim plugin for CircleCI config yaml

circleci.vimについて

編集中のtypo等をハイライトで指摘、及び入力補完により入力の負担を減らすものとなります。

CircleCIはCLIによるValidateコマンドを提供していますが、基本的に入力完了後のチェックとして使います。そのため、当Pluginは大きな手戻りを防ぐための用途になると思われます。

インストール

plugin内でcircleci用のkeywordsが一通り定義されており、プラグインの追加指定をするのみで辞書の指定等は必要ありません。

[[plugins]]
repo = 'yasuhiroki/circleci.vim'

注意点

Terminalのカラー指定によっては視認し難い可能性があります。

あとがき

CircleCIのValidateについて、あまり意識しすぎず且つ最も手間が少なくより効率的になる仕組みを模索していました。

git-commit時にhook等を仕込むことを考えましたが、commit時での対処は手戻りが大きいと感じ、編集中に極力手軽に行えるものとして当プラグインを発見し、試してみました。構造そのものへの対処についてはスニペットによる補完も検討されているようです。

vimにてCircleCI独自のキーワード入力をtypoしがちな場合には特におすすめです。