Add new Style/FileDirnameLevel cop
#10419
Merged
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
bbatsov
reviewed
Mar 6, 2022
| module RuboCop | ||
| module Cop | ||
| module Style | ||
| # This cop checks for repeated `File.dirname`. |
bbatsov
reviewed
Mar 6, 2022
| # # good | ||
| # File.dirname(path, 2) | ||
| # | ||
| class FileDirnameLevel < Base |
There was a problem hiding this comment.
I wonder if NestedFileDirname is not a better name, but I'm fine with the proposed name.
There was a problem hiding this comment.
Yeah, I was wondering whether to use that name. So, I've updated to NestedFileDirname to be consistent with the doc.
bbatsov
reviewed
Mar 6, 2022
|
|
||
| RSpec.describe RuboCop::Cop::Style::FileDirnameLevel, :config do | ||
| context 'Ruby >= 3.1', :ruby31 do | ||
| it 'registers and corrects an offense when using `File.dirname(path)` repeated two times' do |
There was a problem hiding this comment.
nested two times
And so on for the other example descriptions.
## Summary This cop checks for nested `File.dirname`. It replaces nested `File.dirname` with the level argument introduced in Ruby 3.1. ```ruby # bad File.dirname(File.dirname(path)) # good File.dirname(path, 2) ``` See: https://bugs.ruby-lang.org/issues/12194 ## Other Information For `File.expand_path('../..', path)`, there is a partial conflict with `Style/ExpandPathArguments` cop. So this PR does not support it. https://docs.rubocop.org/rubocop/1.25/cops_style.html#styleexpandpatharguments
koic
force-pushed
the
new_add_new_style_file_dirname_level_cop
branch
from
193ce3d
to
a975c1b
Compare
|
Thanks! |
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.
Summary
This cop checks for nested
File.dirname. It replaces repeats with the level argument introduced in Ruby 3.1.See: https://bugs.ruby-lang.org/issues/12194
Other Information
For
File.expand_path('../..', path), there is a partial conflict withStyle/ExpandPathArgumentscop. So this PR does not support it.https://docs.rubocop.org/rubocop/1.25/cops_style.html#styleexpandpatharguments
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.