Set of RuboCop styles for Foreman and its plugins.
As we are one organization and almost one project, it would be nice to keep the similar standards for code quality.
Instead of defining the rules for plugin per plugin, plugins can include defaults from this gem.
There is also a guide how to run this in GH action
# Gemfile gem 'theforeman-rubocop', '~> 0.0.4'
And configure in the
Easiest config - all opinionated Cops
inherit_gem: theforeman-rubocop: - strict.yml
Basic style -
default, performance and rails cops
inherit_gem: theforeman-rubocop: - default.yml
Not intrusive style -
It is similar to default, but has some not as important cops disabled.
rules/style_lenient.yml for disabled cops.
inherit_gem: theforeman-rubocop: - lenient.yml
All opinionated cops with new ones -
If you want to closely follow what RuboCop introduces in its new versions, use this level.
It is the same as
strict, but enables the newly introduced cops.
inherit_gem: theforeman-rubocop: - strictest.yml
Choose just some cops
Cops are splited in categories for your convenience, so you can opt-out some cops.
inherit_gem: theforeman-rubocop: - rules/base.yml - rules/ruby_target.yml - rules/style.yml - rules/metrics.yml - rules/performance.yml - rules/rails.yml - rules/minitest.yml - rules/style_lenient.yml AllCops: NewCops: disable