fablicop
fablicop is a RuboCop configration gem.
It assumes your project is using Ruby on Rails and RSpec, so some Cops prefixed with Rails
and RSpec
are enabled out of the box.
In other words, it's not appropriate to use it with non-Rails projects.
Installation
You can install fablicop with this command:
gem install fablicop
Or, run bundle install
after adding this line to your application's Gemfile:
gem 'fablicop', require: false
Getting started
Set up .rubocop.yml
with the command below.
fablicop init
init
generates the following directive to your .rubocop.yml
:
inherit_gem:
fablicop:
- "config/.base_rubocop.yml"
Usage
After configuration, your RuboCop now sees fablicop's configuration. Just run rubocop
as usual.
rubocop
Or, prefix bundle exec
.
bundle exec rubocop
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/Fablic/fablicop.
Release
This Gem is configured to publish a new version via .github/workflows/release.yml
. Follow these steps to publish a release:
- Go to https://github.com/Fablic/fablicop/actions/workflows/release.yml
- Click "Run workflow"
- Input the new version without "v" (e.g.,
1.10.3
) - Check "apply" (without "apply," this workflow performs without side-effects)
- Click the "Run workflow" button
- Make sure the new release is published on rubygegms.org
License
The gem is available as open source under the terms of the MIT License.