README.md

Ruby 用 Linter/Formatter 設定

Linter/Formatter

• RuboCop

設定ファイルのバリエーション

• Base
• Rails
• RSpec

使い方

1. 必要なファイルを、プロジェクトのルートディレクトリに作成する

• Gemfile

  # frozen_string_literal: true
  
  source 'https://rubygems.org'
  
  group :development, :test do
    gem 'rubocop', '~> 0.83', require: false
    gem 'rubocop-performance', require: false
    gem 'rubocop-rails', require: false # Rails プロジェクトのみ
    gem 'rubocop-rspec', require: false # テストに RSpec を利用するプロジェクトのみ
  end

• .gitignore

  .rubocop-https-*

• .rubocop.yml
  • Rails プロジェクトの場合

    inherit_from:
      - https://raw.githubusercontent.com/timedia/styleguide/master/ruby/rubocop/base.yml
      - https://raw.githubusercontent.com/timedia/styleguide/master/ruby/rubocop/rails.yml
      # 以下は RSpec 利用時のみ
      - https://raw.githubusercontent.com/timedia/styleguide/master/ruby/rubocop/rspec.yml
    
    AllCops:
      TargetRubyVersion: 2.7
      Exclude:
        - bin/**/*
        - config/*
        - config/environments/*
        - db/**/*
        - node_modules/**/*
        - vendor/**/*
    
    # 必要な場合は、ここにプロジェクトごとのカスタム設定を書く

  • Rails を使っていないプロジェクトの場合

    inherit_from:
      - https://raw.githubusercontent.com/timedia/styleguide/master/ruby/rubocop/base.yml
      # 以下は RSpec 利用時のみ
      - https://raw.githubusercontent.com/timedia/styleguide/master/ruby/rubocop/rspec.yml
    
    AllCops:
      TargetRubyVersion: 2.7
      Exclude:
        - vendor/**/*
    
    # 必要な場合は、ここにプロジェクトごとのカスタム設定を書く

2. RuboCop の実行

bundle install
bundle exec rubocop