There's a lot of open issues
Code style checking for factory_bot files. A plugin for the RuboCop code style enforcing & linting tool.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 1.61
 Project Readme

RuboCop factory_bot

Join the chat at https://gitter.im/rubocop-rspec/Lobby Gem Version CI

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.