[New] no-parent-barrel-import: Forbid import from parent barrel file #2779
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.
Resolves: #2318 (comment)
Forbid import from parent barrel file which often leads to runtime error
cannot read ... of undefined
.Gien:
It resolves the missing cycle check from
no-self-import
, while being computationally cheap (overno-cycle
)Rationale
Though it seems that the issue should have been covered by existing rules, there actually isn't one that prevents this circular import / runtime error via parent barrel file (
index.js
) efficiently.no-self-import
: doesn't check indirect importno-cycle
: very costly on large codebaseno-restricted-paths
: requires fixed patterns and not available as a general rule for every folderRelated Issue
There is a related rule of a larger scope: #2408 but further adjustment might be needed. Also it seems to be overly restrictive on importing from non-parent folder (forbids
import example2 from '../dir2';
fromdir1/file.js
) which might need more justification.