Caliber

You can customize the gem by specifying what you need:

The above is what config/all.yml expands to but now you can mix and match how you like for your specific needs.

When Caliber is added to your Gemfile, you don’t have to require RuboCop because Caliber does that for you by default. All RuboCop dependencies are also automatically required because they are defined in each configuration. Here’s a full breakdown of how this works:

The above will require and load the configurations for following gems:

When you don’t use the default all.yml configuration, then behavior changes as follows:

Ruby

The above will only load the RuboCop Ruby configuration. No further requirements are necessary since Caliber already requires the RuboCop gem by default.

Capybara

The above will only require the RuboCop Capybara gem and load the associated configuration.

💡 This is a dependency of RuboCop RSpec so doesn’t need to be directly required if already requiring RuboCop RSpec.

Disable Syntax

The above will only require the RuboCop Disable Syntax gem and load the associated configuration.

FactoryBot

The above will only require the RuboCop FactoryBot gem and load the associated configuration.

💡 This is a dependency of RuboCop RSpec so doesn’t need to be directly required if already requiring RuboCop RSpec.

Packaging

The above will only require the RuboCop Packaging gem and load the associated configuration.

Performance

The above will only require the RuboCop Performance gem and load the associated configuration.

Thread Safety

The above will only require the RuboCop Thread Safety gem and load the associated configuration.

Rake

The above will only require the RuboCop Rake gem and load the associated configuration.

RSpec

The above will only require the RuboCop RSpec gem and load the associated configuration.

Should you not want to include this gem in your project for some reason, you can directly inherit the configuration files supported by this project instead. To do this, you’ll need to add the following to the top of your .rubocop.yml:

You’ll also want to add .rubocop-https* to your project’s .gitignore since imported RuboCop YAML configurations will be cached locally and you’ll not want them checked into your source code repository.

If importing all configurations from all.yml is too much — and much like you can do with requiring this gem directly — you can mix and match what you want to import by defining which configurations you want to use. For example, the following is what all.yml expands too:

You can also target a specific version of this gem by swapping out the main path in the YAML URLs listed above with a specific version like 0.0.0.

Lastly, when using this YAML import approach, you’ll not benefit from having all gems you need required and installed for you. So you’ll need to manually require these gems in your Gemfile:

In situations where you’d like to use Caliber alongside additional RuboCop gems, you only need to add the new gems to your Gemfile and then require them within your .rubocop.yml. For example, let’s say you wanted to use both the Caliber and RuboCop Markdown gems together. Here is how you can use both by updating your .rubocop.yml (assuming your Gemfile was updated as well):

Adding additional RuboCop gems only requires adding them to your YAML configuration.

⚠️ This is experimental but might be of interest to anyone using RuboCop’s local XDG Base Directory Specification (highly recommend).

At the moment, RuboCop doesn’t have native functionality for handling these updates and this CLI is one solution to that problem (see this issue for details). So this CLI automates the updating of outstanding issues you have not resolved for your RuboCop configuration (i.e. .rubocop_todo.yml) and is handy when you’ve fixed issues and want to update your configuration to reflect these changes. The CLI assumes you are using the following structure:

…​and that you have this line in .config/rubocop/config.yml:

Assuming the above is true, you can run the caliber CLI and follow the prompts for either updating your outstanding issues or exiting. Upon competition, the CLI will update your .config/rubocop/issues.yml so you can commit these updates/changes to your repository.

Use the bin/check script — when upgrading to newer RuboCop gem dependencies — to check if duplicate configurations exist. This ensures Caliber configurations don’t duplicate effort provided by RuboCop. The script only identifies duplicate Caliber configurations which are enabled and have no other settings.

When both RuboCop and Caliber are in sync, the following will be output:

When RuboCop has finally enabled cops that Caliber already has enabled, the following will display as an example:

The above can then be used as a checklist to remove from Caliber.