Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork1.6k
[New] no-parent-barrel-import: Forbid import from parent barrel file#2779
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Draft
jonioni wants to merge1 commit intoimport-js:mainChoose a base branch fromjonioni:feat/no-parent-barrel-import
base:main
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Uh oh!
There was an error while loading.Please reload this page.
Conversation
This file contains hidden or 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
0620062
to9a811b4
CompareHi@ljharb, wondering if you could point out why the tests failed with |
Sign up for freeto 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.
Uh oh!
There was an error while loading.Please reload this page.
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.