コーディングミスの見逃しを防ぐスクリプト


git diffをブラウザに表示することで、コーディングミスの見逃しを防ぐ(ことを期待している)スクリプトを作りました。



プログラマーとして働き出してそろそろ1年になるのですが、そこで感じている自分の欠点は、
コーディングの凡ミスが多いことです。



コードレビューで、単純なスペルミスやデバッグ用のコードが残っていたりするのを指摘され、オフィスの窓から飛び降りようとした新人プログラマーは私だけではないと思います。



原因はいろいろあるとは思いますが、一つの原因はターミナル上でのgit diffが見にくいこと。lessのインターフェイスは、何百行のソースを閲覧するには向いていません。
また、私の場合、画面を上下に2分割して使っていて、フォントサイズも大きめなので、ターミナルには一度に20行程度しか表示できません。


また、コーディング中にずっと同じカラースキームのターミナルを眺めていると、目が飽きて、注意力が下がります。コーディング中に見逃したミスを見つけるには、コーディング中と違うカラースキームを使うのが効果的でしょう。



そんなわけで、これを実現するスクリプトを作ってみました。
https://github.com/doloopwhile/diff2html


diff2html.pyでdif出力をhtmlに変換し、html2browse.pyでhtmlをブラウザに表示します。

$ git diff | python3 diff2html.py | python3 html2browse.py

するとブラウザが立ち上がり、セルフコードレビューの始まりです。



なお、同じ事はgithubのコミット閲覧画面などできます。しかし、何度もアップロードするのは面倒(→繰り返したくない→チェックの回数が減る)なので、このスクリプトのほうが効果的なんじゃないかなと思います。