RuboCop factory_bot
factory_bot-specific analysis for your projects, as an extension to RuboCop.
Installation
Just install the rubocop-factory_bot
gem
gem install rubocop-factory_bot
or if you use bundler put this in your Gemfile
gem 'rubocop-factory_bot', require: false
Usage
You need to tell RuboCop to load the factory_bot extension. There are three ways to do this:
RuboCop configuration file
Put this into your .rubocop.yml
.
require: rubocop-factory_bot
Alternatively, use the following array notation when specifying multiple extensions.
require:
- rubocop-other-extension
- rubocop-factory_bot
Now you can run rubocop
and it will automatically load the RuboCop factory_bot
cops together with the standard cops.
Command line
rubocop --require rubocop-factory_bot
Rake task
RuboCop::RakeTask.new do |task|
task.requires << 'rubocop-factory_bot'
end
Documentation
You can read more about RuboCop factory_bot in its official manual.
The Cops
All cops are located under
lib/rubocop/cop/factory_bot
, and contain
examples/documentation.
In your .rubocop.yml
, you may treat the factory_bot cops just like any other
cop. For example:
FactoryBot/AttributeDefinedStatically:
Exclude:
- spec/factories/my_factory.rb
Contributing
Checkout the contribution guidelines.
License
rubocop-factory_bot
is MIT licensed. See the accompanying file for
the full text.