kaichan 「あ〜インデント崩れをすぐに検出してくれる神様的な道具ないかな〜」
神 「(rubocopというgemがあるぞよ)」
kaichan 「はっ!!! rubocopとかいうgemがある気がする!」
以下rubocopの導入方法を記す
まずは、開発環境に
gem 'rubocop-airbnb'
を追加する
group :development do
gem 'rubocop-airbnb'
end
bundle install
ルートディレクトリ(gemfileがある階層)に
.rubocop.yml
.rubocop_airbnb.yml
fileを追加する。
touch .rubocop.yml
touch .rubocop_airbnb.yml
※上記コマンドは実行する階層に注意してください。
.rubocop.ymlに
inherit_from:
- .rubocop_airbnb.yml
.rubocop_airbnb.ymlに
require:
- rubocop-airbnb
と記載する。
完成!
bundle exec rubucop
を実行することで書いたコードがruby style guidに沿っているかをチェックしてくれます^ ^
ーーーもしも、開発途中でrubocopを導入した場合----
神 「あれれ、上記実行したらめっちゃerror? 怒られたんだけど!!!」
神 「kaichanの説明は合ってるの???ぷんぷん」
そんな時は以下のコマンドを実行してください。
bundle exec rubocop --auto-gen-config
新たに
.rubocop_todo.yml
fileが作成され、.ruboop.ymlに
inherit_from: rubocop-todo.yml
と記述されます。
.rubocop_todo.ymlはrubocopを実行した時に検出されたエラーを記述しています。
そして、inherit_from: rubocop-todo.ymlはrubocopにそのエラーは無視してねって伝えます。
このようにすることで、現状のrubocopコマンド実行時に吐き出されるエラーを無視することができます。
(時間がある時に修正するなり、無視するように設定するなりしてくださいね🖤)