Overcommit+Pronto+個別チェッカーで変なRubyコード（変更分＋新規分）をコミットさせない

ローカルでもCI環境に合わせてProntoを使いたい

CircleCIでProntoを使ってGitHub上のPRのRubyコードを自動コードレビューしています。
ローカルではGuardで常時 RSpec, Rubocop を走らせていますが、それでもコミットする前には最終的なコードチェックを自動的にしたい要望が数人からありました。CircleCIではProntoを使っているので、ローカル開発環境でもその動きに合わせようと思いました。

新ファイルがあるとProntoがクラッシュ

Prontoの基本的な使い方は、コミット・プッシュされたフィーチャーブランチと統合先ブランチを
比較して、コメントをすることです。
ローカルで、今までコミットされていない新しいRubyファイルをgit addした状態で
pronto run --stagedを走らせるとクラッシュしてしまいます。

新ファイルを一時退避してProntoを実行

ならば、変更のあるファイルだけProntoを実行すれば良いでしょう。
新規ファイルは、即ちそのまま差分なので、この後全量をチェックします。

precommit-part1.sh

# !/usr/bin/env bash
set -x

# Pronto crashes on checking files not yet committed,
# therefore we reset them once and re-add later
newrubies=$(git diff --name-only --diff-filter=A HEAD |\
            grep -e '\.\(rb\|rake\)$' | tr '\n' ' ')
[ -z "${newrubies// }" ] && exit

git reset $newrubies
status=0
bin/pronto run --staged || let ++status
git add $newrubies

新ファイルは個別にチェック

Prontoでも実行しているチェックを新ファイルに対して個別に実行します。

precommit-part2.sh

# Check those new files that not checked by Pronto
bin/flay `echo $newrubies`
bin/flog `echo $newrubies`
bin/reek -s `echo $newrubies` --failure-exit-code 0
bin/rubocop `echo $newrubies` || let ++status

exit $status

Overcommitで自動実行

前記のprecommit-part1.shとprecommit-part2.shを
合わせたbin/precommit.shをOvercommitのCustomScriptとして実行します。

.overcommit.yml

PreCommit:
  CustomScript:
    enabled: true
    command: ['bin/precommit.sh']

各開発者の環境で Overcommit のGitフックをインストールしてもらいましょう。

overcommit --install

まとめ

これで、Pronto, Reek, Rubocopに引っかかるコードの差分があるとローカルでコミットできなくなります。チェックの内容はCircleCIでコミット済みのもの対する行うものと実質同じはずです。

参考

• CircleCIでProntoを使ってGitHub上のPRを自動コードレビュー（master, develop以外任意の統合先ブランチにも対応）
• ["pronto run" doesn't to do anything, --staged crashes #240]
  (https://github.com/prontolabs/pronto/issues/240)
• Overcommit, a fully configurable and extendable Git hook manager
• RuboCopは自動修正のみ使うと捗る
• Gitフックを使っておかしいRubyコードをコミットできないようにする