Prefer require_relative for internal requires
#170
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
tagliala
force-pushed
the
chore/prefer-require-relative
branch
2 times, most recently
from
b6f8fcb
to
78020be
Compare
|
@jamesmartin and ready for review Then I will go for another round of RuboCop offenses |
`require_relative` is preferred over `require` for files within the same project because it uses paths relative to the current file, making code more portable and less dependent on the load path. This change updates internal requires to use `require_relative` for consistency, performance, and improved portability. However, the test directory makes an exception and there `require` is preferred Fix `Packaging/RequireRelativeHardcodingLib` safe offense Ref: - ruby/psych#522 - ruby/logger#20 - ruby/rdoc#658 - rubocop/rubocop#8748 - https://docs.rubocop.org/rubocop-packaging/cops_packaging.html#packagingrequirerelativehardcodinglib
tagliala
force-pushed
the
chore/prefer-require-relative
branch
from
78020be
to
001b5c7
Compare
jamesmartin
approved these changes
Oct 10, 2024
|
Sorry, I forgot to remove draft |
|
Thanks, @tagliala! 🙇 |
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.
require_relativeis preferred overrequirefor files within the sameproject because it uses paths relative to the current file, making code
more portable and less dependent on the load path.
This change updates internal requires to use
require_relativeforconsistency, performance, and improved portability.
However, the test directory makes an exception and there
requireispreferred
Fix
Packaging/RequireRelativeHardcodingLibsafe offenseRef:
require_relativefor internal requires ruby/psych#522require_relativerubocop/rubocop#8748