Adding AllCops/SafeCopsOnly: true to config file?

[dmke]

(Question originated from Shopify/ruby-lsp#3011)

I'm using VSCode with ruby-lsp extension, which leverages RoboCop as formatter. I also am running rubocop --safe on the CI.

I'm currently facing a situation, where ruby-lsp invokes rubocop (without --safe, not sure how they actually interact). On some code snippets like the following, this leads to a situation where the correction applied in VSCode leads to a CI failure:

# #find_by_password_reset_token is defined by Rails' has_secure_password
user = User.find_by_password_reset_token(params[:token])

• ruby-lsp and bundle exec rubocop (without --safe) report

  Rails/DynamicFindBy: Use find_by instead of dynamic find_by_password_reset_token.

• bundle exec rubocop --safe doesn't report a problem.

After disabling the line:

user = User.find_by_password_reset_token(params[:token]) # rubocop:disable Rails/DynamicFindBy

• ruby-lsp and bundle exec rubocop (without --safe) don't report a problem.

• bundle exec rubocop --safe reports

  Lint/RedundantCopDisableDirective: Unnecessary disabling of Rails/DynamicFindBy.

Is there a way to pin the --safe CLI argument in the .rubocop.yml, i.e. something like:

AllCops:
  SafeCopsOnly: true

Neither the docs (Ctrl+F, "safe"), nor the default.yml mention something in that direction.

My current config has set the following global options:

AllCops:
  NewCops: enable
  StyleGuideCopsOnly: false
  TargetRubyVersion: "3.3"

[Earlopain]

You can specify default command line arguments in a file called .rubocop, ruby-lsp should make use of that. Does look like there's nothing for the normal config file.

[dmke]

That does work, thank you!

[kashrobinson71-tech]

I appreciate it

[koic]

You could try specifying RUBOCOP_OPTS=--safe as an environment variable, or writing the --safe option in a .rubocop file (not .rubocop.yml).

Default command-line options are loaded from .rubocop and RUBOCOP_OPTS and are combined with command-line options that are explicitly passed to rubocop. Thus, the options have the following order of precedence (from highest to lowest):

1. Explicit command-line options
2. Options from RUBOCOP_OPTS environment variable
3. Options from .rubocop file.

For more details, please refer to the following documentation:
https://docs.rubocop.org/rubocop/1.69/usage/basic_usage.html#command-line-flags

[dmke]

Thank you for the hint!

Specifying an environment variable to pick up by VSCode and pass through ruby-lsp to RuboCop seems like a hassle. I'm using the .rubocop file approach.

[andyw8]

@koic I think it would be helpful if the use of .rubocop was mentioned on https://docs.rubocop.org/rubocop/1.69/configuration.html.

[dvandersluis]

It's mentioned at the bottom of this section: https://docs.rubocop.org/rubocop/1.69/usage/basic_usage.html#command-line-flags

I'm not sure if it makes sense in configuration too because .rubocop is for command line switches, not for all the options you can configure via yaml.

[andyw8]

True, but for discoverability a link would be appreciated.