Ruby/Rubyの基礎知識

Rubocop を使った静的解析で Ruby コーディング規約をチェックする(3ページ目)

Ruby の静的コード解析ツールである Rubocop を用いて、書いたコードがあらかじめ定義したコーディング規約に従っているかをチェックします。

橋本 拓也

執筆者:橋本 拓也

Rubyガイド

まずは auto-gen で既存のコードを正とする

既存プロジェクトに Rubocop を導入する際に考えられるのが、歴史あるコードに対して rubocop を実行すると offenses が大量に出て来るため導入ハードルが高く断念する、というケースです。そんなときは --auto-gen-config オプションを利用すると作業の取っ掛かりとなります。

rubocop --auto-gen-config を実行すると、現時点でコーディング規約違反となった "Cops" をすべて許可する.rubocop_todo.yml が生成されます。

これを .rubocop.yml から inherit_from で参照することで反映されます。

以上の操作で「とりあえず現状動いているコードを正とする」ことができたので、あとは着手しやすい項目から .rubocop_todo.yml をひとつひとつ Enabled: true に変えていき、コーディング規約に準拠させていくことになります。

以上

Rubocop の紹介は以上です。ここまでの例では毎回 rubocop コマンドを実行していましたが、お気に入りのエディタと連携する設定を行えば、書いているそばから規約への準拠を促してくれて、とても楽に開発ができます。詳しくは Editor Integration - bbatsov/rubocop を参照してください。

【編集部おすすめの購入サイト】
Amazonで Ruby 関連の書籍をチェック!楽天市場で Ruby 関連の書籍をチェック!
  • 前のページへ
  • 1
  • 2
  • 3
※記事内容は執筆時点のものです。最新の内容をご確認ください。
※OSやアプリ、ソフトのバージョンによっては画面表示、操作方法が異なる可能性があります。

あわせて読みたい

あなたにオススメ

    表示について

    カテゴリー一覧

    All Aboutサービス・メディア

    All About公式SNS
    日々の生活や仕事を楽しむための情報を毎日お届けします。
    公式SNS一覧
    © All About, Inc. All rights reserved. 掲載の記事・写真・イラストなど、すべてのコンテンツの無断複写・転載・公衆送信等を禁じます