Add ESLint rule to avoid unintentional dependency on @wp-playgrounds/wordpress-builds #2048
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
…wordpress-builds package
Member
Author
|
Lint is failing in CI because the rule is working and we still need to make some exceptions. We need to disable the rule for intended users of wordpress-builds like the We also need to disable the rule for tests. Example errors here: |
Collaborator
|
Agreed about the exceptions, other than that it looks good 👍 |
Collaborator
|
Poke for after the support rotation @brandonpayton |
Collaborator
|
Yay, thank you! |
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.
Motivation for the change, related issues
We've encountered issues like #2026 where an undesired dependency on
@wp-playground/wordpress-builds(which is an unpublished, private package) caused problems.Implementation details
This PR adds an ESLint rule that considers dependency on
@wp-playground/wordpress-buildsto be an error. If a module wants a dependency on that package, it can disable the ESLint rule for the import line.We should improve the rule message to better communicate the above.
Please feel free to take this and finish if you are interested. Otherwise, I can wrap later.
Testing Instructions (or ideally a Blueprint)