https://github.com/jgarber623/rubocop-configs
A collection of RuboCop configuration files for inclusion in other Ruby-based projects.
https://github.com/jgarber623/rubocop-configs
rubocop rubocop-configuration ruby
Last synced: over 1 year ago
JSON representation
A collection of RuboCop configuration files for inclusion in other Ruby-based projects.
- Host: GitHub
- URL: https://github.com/jgarber623/rubocop-configs
- Owner: jgarber623
- License: mit
- Created: 2022-01-03T21:47:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-15T13:49:43.000Z (almost 2 years ago)
- Last Synced: 2025-02-02T01:25:27.747Z (over 1 year ago)
- Topics: rubocop, rubocop-configuration, ruby
- Homepage: https://jgarber623.github.io/rubocop-configs
- Size: 74.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rubocop-configs
A collection of reusable [RuboCop](https://rubocop.org) configuration files for inclusion in other Ruby projects.
## Usage
Add the following to your project's `Gemfile` and run `bundle install`:
```ruby
gem "rubocop"
gem "rubocop-performance"
gem "rubocop-rails"
gem "rubocop-rake"
gem "rubocop-rspec"
```
Add the following to your project's `.rubocop.yml`:
```yaml
inherit_from:
- https://jgarber623.github.io/rubocop-configs/.rubocop.yml
- https://jgarber623.github.io/rubocop-configs/.rubocop-rails.yml
- https://jgarber623.github.io/rubocop-configs/.rubocop-rspec.yml
```
## Dependencies
As noted above, the configurations in this project require one or more of the following RuboCop extensions:
- [rubocop-performance](https://rubygems.org/gems/rubocop-performance)
- [rubocop-rails](https://rubygems.org/gems/rubocop-rails) (`.rubocop-rails.yml` only)
- [rubocop-rake](https://rubygems.org/gems/rubocop-rake)
- [rubocop-rspec](https://rubygems.org/gems/rubocop-rspec) (`.rubocop-rspec.yml` only)
The following RuboCop extensions are recommended for [Ruby on Rails](https://rubyonrails.org) projects:
- [rubocop-capybara](https://github.com/rubocop/rubocop-capybara)
- [rubocop-factory_bot](https://github.com/rubocop/rubocop-factory_bot)
The following RuboCop extension is recommended for [RubyGem](https://rubygems.org) projects:
- [rubocop-packaging](https://rubygems.org/gems/rubocop-packaging)
## License
rubocop-configs is freely available under the MIT License. Use it, learn from it, fork it, improve it, change it, tailor it to your needs.