repo: add runtime-import-check eslint rule
#10124
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
vince-fugnitto
added
quality
vince-fugnitto
force-pushed
the
vf/runtime-import-check
branch
from
7b8b527 to
95aea85
Compare
alvsan09
reviewed
Sep 17, 2021
|
@vince-fugnitto , it would be great to raise an issue and make a reference to it in this PR i.e. to track fixes for the deviations disabled on this baseline. |
vince-fugnitto
force-pushed
the
vf/runtime-import-check
branch
from
d6c5c43 to
01aeef4
Compare
alvsan09
approved these changes
Sep 17, 2021
|
@colin-grant-work the error message was updated to include the list of allowed folder as requested offline. Example: |
The commit adds a custom eslint rule to warn when we are importing from folders meant for incompatible runtimes, and enforces our code organization guidelines. When we import from such invalid runtimes we may cause downstream adopters and extensions issues, namely when they attempt to import from valid sources but our imports break them. Signed-off-by: vince-fugnitto <[email protected]> Co-authored-by: Paul Maréchal <[email protected]>
vince-fugnitto
force-pushed
the
vf/runtime-import-check
branch
from
b989405 to
a6964f9
Compare
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.
What it does
Fixes: #5873
The pull-request adds a custom eslint rule meant to check for invalid runtime imports which do not comply to our code organization guidelines. The rule will help us identify uses of invalid imports which cause downstream adopters and extenders runtime issues.
How to test
The new rule should report errors when we use invalid imports based on different runtimes.
The pull-request includes a baseline commit meant to suppress the errors currently in the codebase so we can track and fix them, while new errors from contributions should fail linting.
Review checklist
Reminder for reviewers
Signed-off-by: vince-fugnitto [email protected]