[Fix #1345] Improve offense message for Rails/RootPathnameMethods
#1347
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Earlopain
force-pushed
the
offense-message-root-pathname-methods
branch
from
87458da
to
033c245
Compare
koic
reviewed
Sep 1, 2024
| # | ||
| class RootPathnameMethods < Base # rubocop:disable Metrics/ClassLength | ||
| extend AutoCorrector | ||
| include RangeHelp | ||
|
|
||
| MSG = '`%<rails_root>s` is a `Pathname` so you can just append `#%<method>s`.' | ||
| MSG = '`%<rails_root>s` is a `Pathname` so you can just do `%<replacement>s`.' |
There was a problem hiding this comment.
Suggested change
| MSG = '`%<rails_root>s` is a `Pathname` so you can just do `%<replacement>s`.' | |
| MSG = '`%<rails_root>s` is a `Pathname`, so you can use `%<replacement>s`.' |
koic
reviewed
Sep 1, 2024
| @@ -0,0 +1 @@ | |||
| * [#1345](https://github.com/rubocop/rubocop-rails/issues/1345): Improve offense message for `Rails/RootPathnameMethods`. ([@earlopain][]) | |||
There was a problem hiding this comment.
Please remove the changelog entry since the behavior of the cop does not change.
…hods` The current message is confusing/nonsensical for `Dir[]`. Let's display the correct code instead to show what needs to be done
Earlopain
force-pushed
the
offense-message-root-pathname-methods
branch
from
033c245
to
0f36342
Compare
|
🆒 Thanks for improving this for us all! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #1345
The current message is confusing/nonsensical for
Dir[]. Let's display the correct code instead to show what needs to be done.I also added the Dir offenses to the example section.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.