Git Hooksを導入してrubocopを走らせるのを忘れないようにする方法

✏️️ 2019/08/17 👍️2019/08/19 🔗

Ruby on RailsにRubocopを導入する方法
で、Rubocopを導入しても、ついbundle exec rubocopを行なうのを忘れがちです。そんなときは、Git Hooksを導入すれば、コミット前に自動でrubocopが走るように設定することができます。

Git Hooksの運用に便利なgemであるovercommitを導入します。

インストール

# Gemfile
group :development do
  gem 'overcommit'
end
bundle install
bundle exec overcommit --install

設定

Rubocopの設定を有効にします。

# .overcommit.yml
RuboCop:
  enabled: true
  on_warn: fail # Treat all warnings as failures

使い方

設定の変更を反映

bundle exec overcommit --sign

現在の設定を確認

bundle exec overcommit --list-hooks

以上で、Git Hooksを導入してrubocopを走らせるのを忘れないようにする方法は完了です。

参考

Akito
日本のスタートアップで主にRuby on Railsを使ってプロダクト開発をしています。