RuboCopを使用したRubyコードのリンティングと自動フォーマット

リンティングは、プログラムおよびスタイルのエラーについてソースコードを自動チェックすることです。このチェックは、リンターと呼ばれる静的コード分析ツールによって実行されます。ただし、コードフォーマッタは、事前に構成された一連のルールに厳密に準拠するようにソースコードをフォーマットするためのツールです。リンターは通常違反を報告しますが、問題を修正するのは通常プログラマー次第ですが、コードフォーマッターはそのルールをソースコードに直接適用する傾向があるため、フォーマットの間違いを自動的に修正します。

プロジェクトでより一貫性のあるコードスタイルを作成するタスクでは、通常、個別のリンティングツールとフォーマットツールを導入する必要がありますが、場合によっては、1つのツールで両方の問題に対処できます。後者の良い例はRuboCopです。これは、この記事で詳しく検討するツールです。 Rubyプロジェクトでセットアップし、出力が期待どおりになるように構成オプションを調整する方法を学習します。ローカル開発プロセスに統合するだけでなく、継続的インテグレーションワークフローの一部にする方法も学習します。

RuboCopのインストール

RuboCopのインストールはRubyGemsを介して簡単です：

$ gem install rubocop

インストールされたバージョンを確認してください：

$ rubocop --version
1.18.3

Bundlerを使用する場合は、以下のスニペットをGemfileに配置してください。 次に、bundle installを実行します 。 require: false 一部はBundler.requireに通知します コマンドラインからのみ使用されるため、コードでその特定のgemを必要としないでください。

gem 'rubocop', require: false

インストールされたバージョンを確認してください：

$ bundle exec rubocop --version
1.18.3

RuboCopの実行

rubocopと入力すると、プロジェクトのデフォルト設定を使用してRuboCopを実行できます。 （またはbundle exec rubocop Bundlerと一緒にインストールされている場合）。コマンドに引数を渡さない場合、現在のディレクトリ内のすべてのRubyソースファイルとすべてのサブディレクトリがチェックされます。または、分析する必要のあるファイルとディレクトリのリストを渡すこともできます。

$ bundle exec rubocop
$ bundle exec rubocop src/lib

構成がない場合、RuboCopは、コミュニティ主導のRubyスタイルガイドで概説されているガイドラインの多くを適用します。コマンドを実行した後、いくつかのエラー（違反）が発生する場合があります。報告された各違反には、違反の説明、発生したファイルと行番号など、問題を解決するために必要なすべての情報が記載されています。

レポートの下部に、検査されたファイルの数、違反の総数、および自動的に修正できる違反の数を説明する行が表示されます。 -aを追加した場合 または--auto-correct 引数として、RuboCopは、ソースファイル（接頭辞[Correctable]が付いている問題）で見つかった問題を自動的に修正しようとします。 。

$ bundle exec rubocop -a

修正された各オフェンスのプレフィックスが[Corrected]になっていることに注目してください。 。修正された違反の数の要約もレポートの下部に表示されます。上記の例では、-aを追加した後でも、自動修正されなかった別の修正可能な違反があります。 国旗。これは、一部の自動修正によってコードのセマンティクスがわずかに変更される可能性があるため、RuboCopはそれを安全でないと見なしているためです。これらの違反も自動修正する場合は、-Aを使用してください または--auto-correct-all フラグ。

$ bundle exec rubocop -A

従うべき経験則は、オートコレクト機能を使用した後にテストスイートを実行して、コードの動作が予期せず変更されていないことを確認することです。

RuboCopの構成

RuboCopは、.rubocop.ymlを介して構成できます プロジェクトのルートに配置されたファイル。すべてのプロジェクトに同じチェックを使用する場合は、グローバル構成ファイルをホームディレクトリ（~/.rubocop.yml）に配置できます。 ）またはXDG構成ディレクトリ（~/.config/rubocop/config.yml ）。このグローバル構成ファイルは、ローカルスコープのプロジェクト構成ファイルが現在のディレクトリまたは後続の親ディレクトリに見つからない場合に使用されます。

RuboCopのデフォルト構成は、その構成ホームディレクトリ（~/.config/rubocop/default.yml）に配置されます。 ）、および他のすべての構成ファイルはそれを継承します。これは、プロジェクト構成をセットアップするときに、デフォルトとは異なる変更を加えるだけでよいことを意味します。これは、特定のチェックを有効または無効にしたり、パラメータを受け入れる場合はその動作を変更したりすることを意味する場合があります。

RuboCopは、個々のチェックを警官と呼び、それぞれが特定の違反を検出する責任があります。利用可能な警官も次の部門にグループ化されています：

• スタイル警官は主に前述のRubyスタイルガイドに基づいており、コードの整合性をチェックします。
• レイアウト警官は、空白の使用など、フォーマットに関連する問題をキャッチします。
• Lint警官は、ruby -wと同様に、コードで発生する可能性のあるエラーを検出します 、ただし、追加のチェックが多数あります。
• メートル法の警官は、クラスの長さやメソッドの長さなど、ソースコードの測定に関連する問題を扱います。
• ネーミング警官はネーミング規則に関係しています。
• セキュリティ警官は、潜在的なセキュリティ問題を見つけるのに役立ちます。
• Bundlerの警官は、Bundlerファイル（Gemfileなど）の不正行為をチェックします 。
• Gemspecの警官は.gemspecで悪い習慣をチェックします ファイル。

追加のリンターとフォーマッターを介してRuboCopを拡張することも可能です。独自の拡張機能を構築することも、プロジェクトに関連する場合は既存の拡張機能を利用することもできます。たとえば、Rails拡張機能は、Railsのベストプラクティスとコーディング規則を適用する目的で使用できます。

初めて構成ファイルを作成すると、追加されたが構成されていない新しい警官の存在を警告する多数のメッセージが表示されます。これは、RuboCopがリリースごとに新しい警官を追加し、ユーザー設定で明示的に有効または無効になるまで、これらが特別な保留状態に設定されるためです。メッセージにリストされている各警官を個別に有効または無効にするか、以下のスニペットを使用してすべての新しい警官を有効にすることができます（推奨）。その後、メッセージは抑制されます。

# .rubocop.yml
AllCops:
  NewCops: enable

構成ファイルやRuboCopが提供する豊富なオプションをいじりたくない場合は、Standardプロジェクトを検討することを検討してください。これは主に、RuboCopの事前構成されたバージョンであり、ルールをカスタマイズすることなく、Rubyプロジェクトに一貫したスタイルを適用することを目的としています。最初に発表されたライトニングトークでは、その起源と動機について詳しく説明しています。

Gemfileに次の行を追加することでインストールできます 次に、bundle installを実行します 。

# Gemfile
gem "standard", group: [:development, :test]

その後、次のようにコマンドラインからStandardを実行できます。

$ bundle exec standardrb

$ bundle exec rubocop

523 files inspected, 1018 offenses detected

$ bundle exec rubocop --auto-gen-config
Added inheritance from `.rubocop_todo.yml` in `.rubocop.yml`.
Created .rubocop_todo.yml.

$ bundle exec rubocop
523 files inspected, no offenses detected

$ bundle exec rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 10000

# Gemfile
gem "rubocop-shopify", require: false

# .rubocop.yml
inherit_gem:
  rubocop-shopify: rubocop.yml

# rubocop:disable Layout/LineLength, Style
[..]
# rubocop:enable Layout/LineLength, Style

# rubocop:disable all
[..]
# rubocop:enable all

for x in (0..10) # rubocop:disable Style/For

{
  "ruby.lint": {
    "rubocop": true
  }
}

{
  "coc.preferences.formatOnSaveFiletypes": ["ruby"],
  "solargraph.autoformat": true,
  "solargraph.diagnostics": true,
  "solargraph.formatting": true
}

$ gem install overcommit
$ overcommit --install # at the root of your project

# .overcommit.yml
PreCommit:
  RuboCop:
    enabled: true
    on_warn: fail
    problem_on_unmodified_line: ignore
    command: ['bundle', 'exec', 'rubocop']

$ SKIP=RuboCop git commit -m "WIP: Unfinished work"

# .github/workflows/rubocop.yml
name: Lint code with RuboCop

on: [push, pull_request]

jobs:
  build:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [macos-latest, ubuntu-latest, windows-latest]

    steps:
    - uses: actions/checkout@v2

    - name: Setup Ruby
      uses: ruby/setup-ruby@v1
      with:
        ruby-version: '3.0'
        bundler-cache: true

    - name: Run RuboCop
      run: bundle exec rubocop

# Gemfile
gem 'prettier'

$ bundle exec rbprettier --write '**/*.rb'

# .rubocop.yml
inherit_gem:
  prettier: rubocop.yml