Skip to content

Commit

Permalink
chore(docs): Gem names and troubleshooting for v3 migration instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
bmulholland authored Jun 18, 2024
1 parent 2004e4b commit 5fd1228
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/modules/ROOT/pages/upgrade_to_version_3.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ In version 3.x:
[discrete]
=== Extraction of cop departments. (`Capybara`, `FactoryBot`, `Rails`)

If you are using the RSpec/Capybara, RSpec/FactoryBot, or RSpec/Rails departments, you need to install the corresponding gem and add it to your `.rubocop.yml` file.
If you are using the RSpec/Capybara, RSpec/FactoryBot, or RSpec/Rails departments -- or have one in a `require` list in your rubocop.yml -- you need to install the corresponding gem and add it to your `.rubocop.yml` file:

* Capybara: `ubocop-capybara`
* FactoryBot: `rubocop-factory_bot`
* Rails: `rubocop-rspec_rails`

For example, if you are using the RSpec/Capybara department, you need to install the `rubocop-capybara` gem and add it to your `.rubocop.yml` file:

Expand Down Expand Up @@ -50,3 +54,7 @@ RSpec/FactoryBot:
RSpec/Rails:
Enabled: false
----

== Troubleshooting

If you're seeing `cannot load such file` when running rubocop, even after installing the gems, try restarting your LSP with `rubocop --restart-server`.

0 comments on commit 5fd1228

Please sign in to comment.