rubocop
コードの品質を保つために、コード規約に準拠しているかどうかを調べようとした場合、rubyにはrubocopというgemが用意されています。
bbatsov/rubocop
Ruby - Rubocopを使ってコーディングルールへの準拠チェックを自動化 - Qiita
rubocopについては、すでに多くの有益な記事があるので、詳しくは割愛します。
簡単に言えば、予め定義したルールに則さないコードを自動で見つけてくれるような物です。
Offenses:
test.rb:1:5: C: Use snake_case for methods and variables.
def badName
^^^^^^^
test.rb:2:3: C: Favor modifier if/unless usage when you have a single-line body. Another good alternative is the usage of control flow &&/||.
if something
^^
test.rb:4:5: W: end at 4, 4 is not aligned with if at 2, 2
end
^^^
1 file inspected, 3 offenses detected
この仕組みをgit-hookと組み合わせる事で、規約違反のコードはgit commitできないようにするなど、プロジェクトの品質を保つのに役立ちそうです。
Gitフックを使っておかしいRubyコードをコミットできないようにする - Qiita
jshint
一方、javascriptにもコード品質を保つために、jshint / jslintなどがあります。
JavaScript - JSHint入門 - JSHintを使ってJSコードの信頼性を高める - Qiita
こちらも、git-hookと合わせれば、javascriptの品質担保に役立ちそうです。
pre-commit gem
そんななか、pre-commit gemという物を知ったので、メモとして書いておきます。
↑のgithubに書いてある説明はシンプルで、
A better pre-commit hook for git.
というものです。
install
$ gem install pre-commit
list
installできたら、デフォルトの状態を見てみましょう
$ pre-commit list
Available providers: default(0) git(10) git_old(11) yaml(20) env(30)
Available checks : before_all ci closure coffeelint common console_log csslint debugger gemfile_path go jshint jslint json local merge_conflict migration nb_space php pry rails rspec_focus rubocop ruby ruby_symbol_hashrockets scss_lint tabs whitespace yaml
Default checks : common rails
Enabled checks : common rails
Evaluated checks : tabs nb_space whitespace merge_conflict debugger pry local jshint console_log migration
Default warnings :
Enabled warnings :
Evaluated warnings :
Available checks に便利そうなチェック項目が色々あります。
設定
設定はgitコマンドでも、pre-commitコマンドでもできるようです
pre-commit <enable|disable> <git|yaml> <checks|warnings> check1 [check2...]
試しに、jshintで、warningsが出るようにすると、
pre-commit enable yaml warnings jshint
となります。
yamlは設定ファイルをyamlで作成します。
初回このコマンドを実行した場合は、下記のようなファイルができます
---
:warnings_remove: []
:warnings_add:
- :jshint
このファイルは直接編集しても問題ありません。
ちなみに、warnings はエラー表示のみ。checksはcommit不可、となります。
rubocopはデフォルトで入っていないので、入れてあげましょう。
$ pre-commit enable yaml checks rubocop
反映
設定を色々やったのち、下記を叩くと
# In your git repo
$ pre-commit install
.git/hook/pre-commit ファイルが書き変わります。
$ cat pre-commit
#!/usr/bin/env sh
# This hook has a focus on portability.
# This hook will attempt to setup your environment before running checks.
#
# If you would like `pre-commit` to get out of your way and you are comfortable
# setting up your own environment, you can install the manual hook using:
#
# pre-commit install --manual
#
cmd=`git config pre-commit.ruby 2>/dev/null`
if test -n "${cmd}"
then true
elif which rvm >/dev/null 2>/dev/null
then cmd="rvm default do ruby"
elif which rbenv >/dev/null 2>/dev/null
then cmd="rbenv exec ruby"
else cmd="ruby"
fi
...
...
省略
元々hookが書いてある方は、上書きしないようにご注意を。
試しに、わざとエラーとなるコードを書いてみます
jshintのwarningsが出ており、またrubocopのエラーでcommitが失敗しています。
これで、rubyもjsもcoffeeも、まとめてコード規約違反はcommitできなくできそうです :)
参考
Gitフックを使っておかしいRubyコードをコミットできないようにする - Qiita
rubocopによる静的コード解析でRubyのコード品質を保つ | Act as Professional
rubocop + pre-commitで規約違反のコードをコミットできないようにする | Oh My Enter!
git用のpre-commit gemが便利すぎる - TakiTakeの日記