README.md

Rubocop Rails Suite

Rubocop Rails Suite is a comprehensive suite of RuboCop configurations tailored for Ruby on Rails applications. This gem enhances your Rails code quality by bundling essential RuboCop extensions for performance, testing, and best practices. It requires at least Ruby version 3.0.0 to function properly.

Gems Included:

• rubocop - The base linter for Ruby.
• rubocop-rails - Rails-specific linting rules.
• rubocop-performance - Rules focused on optimizing Ruby performance.
• rubocop-rspec - Linting rules for RSpec tests.
• rubocop-factory_bot - Linting rules for factory_bot usage.
• rubocop-faker - Linting rules for faker usage.

Installation

Add this line to your application's Gemfile:

gem "rubocop-rails-suite", require: false, group: [:development]

Then execute:

bundle install

Usage

To enable the Rubocop Rails Suite in your project, create or update your .rubocop.yml file with the following:

inherit_gem:
  rubocop-rails-suite: rubocop.yml

# Specify your Ruby version
AllCops:
  TargetRubyVersion: 3.0

This will import the suite's recommended RuboCop rules for Rails projects, including rules for performance, RSpec, factory_bot, faker, and migration linting.

Run RuboCop to check your code:

bundle exec rubocop

Contributing

Contributions are welcome! Feel free to report bugs or submit pull requests.

Contact

For questions or further information, feel free to reach out via LinkedIn.