Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): Gem names and troubleshooting for v3 migration instructions #1927

Merged
merged 2 commits into from
Jun 18, 2024
Merged

chore(docs): Gem names and troubleshooting for v3 migration instructions #1927

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fd1228
chore(docs): Gem names and troubleshooting for v3 migration instructions
bmulholland Jun 18, 2024
5646c8c
Apply suggestions from code review
pirj Jun 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/modules/ROOT/pages/upgrade_to_version_3.adoc
View file
Open in desktop
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`
pirj marked this conversation as resolved.
Show resolved Hide resolved
* 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`.
pirj marked this conversation as resolved.
Show resolved Hide resolved