eslint: add plugin to warn against src
imports
#10234
Merged
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.
What it does
The pull-request adds a new
no-src-import
rule to our custom eslint-plugin in order to warn against the use of/src/
imports over/lib/
which causes the build to fail and is not trivial for developers to identify as to why. The rule should help write developers more easily identify when they are using imports incorrectly.How to test
src
imports should produce errors.quick-fix
should exist to change thesesrc
imports tolib
.Review checklist
Reminder for reviewers
Signed-off-by: vince-fugnitto [email protected]