まあそれだけなんだけど

rubocopには--format githubというオプションがある。

このオプションをつけると、指摘点が1行のシンプルなフォーマットのテキストで表示されると思う。

このフォーマットはGitHub Actions上で効果を発揮するものになっていて、PRのコード上にまるでbotがコメントを挿入したかのようなテキストを表示させることができる。(厳密にはコメントではない)

rubocopの--format githubオプションについては、こちらのブログでも紹介されている。

この機能は私も好きで、実際にrbs リポジトリーでもgem_rbs_collectionリポジトリーでも導入している。

で？

このオプションをSteepにも導入してみた。

狙っている使い方は、型検査をよりやんわり伝えると言う方法だ。

現状型検査に一つでも違反していたらCIを落とすというやり方はかなりストイックなもので、ライブラリーレベルならやれるが、アプリケーションレベルでやるのはかなり大変か限定的な使い方になるだろうと思われる。

しかし、もう少し広い範囲で、やんわりとした使い方をしたい。つまり型検査に違反していてもCI上は落ちず、かつ無視はできないレベルで視界には入るので注意喚起ぐらいにはなる。という使い方だ。

もしこの使い方ができれば、少しずつのCI上での型導入が進めやすくなるのではないかなと狙っている。

使われたらいいなあ。