[Fix #10977] Add option to raise cop errors, --raise-cop-error

[wildmaples]

Fix #10977

We want to be able to rescue cop-related errors.

There exists :raise_error, but it's used for internal tests such as through cop helper.

I added a new option that raises with RuboCop::ErrorWithAnalyzedFileLocation, which surfaces more information.

---

Before submitting the PR make sure the following are checked:

• The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
• Wrote good commit messages.
• Commit message starts with [Fix #issue-number] (if the related issue exists).
• Feature branch is up-to-date with master (if not - rebase it).
• Squashed related commits together.
• Added tests.
• Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
• Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

[dvandersluis]

I'm not sure I understand the use case for this? Why do you want rubocop to stop when an error is raised? (Which shouldn't happen in normal operation, of course)

Also there's already --debug which will output errors/backtraces when an exception is encountered.

[wildmaples]

Hi @dvandersluis, thanks for taking a look at this!!

We need this option to rescue any cop exceptions when running RuboCop on the Ruby LSP for a better use experience. The TL;DR is that we want to make sure users know there is an error (instead of failing silently using --debug which is what we are doing now) because it prevents the file from being processed while open on VS Code.

We have a more detailed issue you can find here: Shopify/ruby-lsp#250

[bbatsov]

I see. That makes sense to me, but it has to be documented very clearly.

[bbatsov]

@wildmaples Ping :-)

[wildmaples]

Thanks for the reminder, @bbatsov!

I've added some copy mentioning the new option in the Cop and Basic Usage section of the Rubocop documentation. I also provided additional context for to describe the option. (b165c59)

[bbatsov]

Looks good. I'll include merge this after cutting the next bugfix release.