Skip to content

[Fix #1442] Fix an incorrect behavior when using AllCops: TargetRailsVersion #1445

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.

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

Merged

Conversation

koic
Copy link
Member

@koic koic commented Feb 16, 2025

This PR fixes an incorrect behavior when using AllCops: TargetRailsVersion.

This suppresses the following warning when TargetRailsVersion is defined on the user side:

$ bundle exec rubocop
(snip)

Warning: AllCops does not support TargetRailsVersion parameter.

Supported parameters are:

  - RubyInterpreters
  - Include
  - Exclude
  - DefaultFormatter
  - DisplayCopNames
  - DisplayStyleGuide
  - StyleGuideBaseURL
  - DocumentationBaseURL
  - DocumentationExtension
  - ExtraDetails
  - StyleGuideCopsOnly
  - EnabledByDefault
  - DisabledByDefault
  - NewCops
  - UseCache
  - MaxFilesInCache
  - CacheRootDirectory
  - AllowSymlinksInCacheRootDirectory
  - TargetRubyVersion
  - ParserEngine
  - SuggestExtensions
  - ActiveSupportExtensionsEnabled
  - StringLiteralsFrozenByDefault

This is a dirty hack relying on a private constant to prevent the warning. It should be updated to a better design in the future.

Fixes #1442.


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.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.

…getRailsVersion`

This PR fixes an incorrect behavior when using `AllCops: TargetRailsVersion`.

This suppresses the following warning when `TargetRailsVersion` is defined on the user side:

```console
$ bundle exec rubocop
(snip)

Warning: AllCops does not support TargetRailsVersion parameter.

Supported parameters are:

  - RubyInterpreters
  - Include
  - Exclude
  - DefaultFormatter
  - DisplayCopNames
  - DisplayStyleGuide
  - StyleGuideBaseURL
  - DocumentationBaseURL
  - DocumentationExtension
  - ExtraDetails
  - StyleGuideCopsOnly
  - EnabledByDefault
  - DisabledByDefault
  - NewCops
  - UseCache
  - MaxFilesInCache
  - CacheRootDirectory
  - AllowSymlinksInCacheRootDirectory
  - TargetRubyVersion
  - ParserEngine
  - SuggestExtensions
  - ActiveSupportExtensionsEnabled
  - StringLiteralsFrozenByDefault
```

This is a dirty hack relying on a private constant to prevent the warning.
It should be updated to a better design in the future.

Fixes rubocop#1442.
@koic koic merged commit 063bf20 into rubocop:master Feb 17, 2025
16 checks passed
@koic koic deleted the fix_an_error_when_using_target_rails_version branch February 17, 2025 07:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Warning: AllCops does not support TargetRailsVersion parameter.
1 participant
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy