docs(examples): prevent internal imports via eslint #3503
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.
Following up #3494 , @levithomason had the idea to prevent local imports in the docs examples via linter. Here's one solution: we have a local
.eslintrc
in the examples preventing undesired import patterns. However the rule is not valid for theindex.js
files in the same folder, so I've disabled the rule for those files.Now the eslint will complain if there's a local import in the examples, like this:
Related to this PR, it seems that the prettier has done some additional changes to some of the
index.js
files. The docs seem to still work fine, but I wonder why that happened...I'd be glad to get some feedback!
Cheers!