Allow ariakit and framer motion imports in the components package #63123
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
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
ciampo
added
[Type] Code Quality
|
Size Change: -81 B (0%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in eba94e7. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9794443435
|
tyxla
approved these changes
Jul 4, 2024
.eslintrc.js
Outdated
Comment on lines
423
to
439
| { | ||
| files: [ 'packages/components/src/**' ], | ||
| rules: { | ||
| 'no-restricted-imports': [ | ||
| 'error', | ||
| { | ||
| paths: restrictedImports.filter( | ||
| ( { name } ) => | ||
| ! [ | ||
| '@ariakit/react', | ||
| 'framer-motion', | ||
| ].includes( name ) | ||
| ), | ||
| }, | ||
| ], | ||
| }, | ||
| }, |
There was a problem hiding this comment.
It may be useful to add a comment that we're re-exporting them in the package so we're allowing usage inside the package. Right now it's not so obvious without looking deeper into why they were forbidden in the first place.
There was a problem hiding this comment.
Sure, I'll add a comment
|
This makes sense, though I agree that the config is getting complicated. We could simplify it by creating a package-specific config file that extends the root one, and then apply the overrides there. |
Not sure we wanna go that way though. If we want to upgrade to ESLint v9+, we might want to inspect migrating to a flat config instead. They're planning to remove |
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Jul 18, 2024
…ess#63123) * ESLint: allow importing from ariakit and framer motion in the components package * Remove unnecessary eslint disable comments * CHANGELOG * Add comment in ESLint config --- Co-authored-by: ciampo <mciampini@git.wordpress.org> Co-authored-by: tyxla <tyxla@git.wordpress.org>
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?
Tweak the ESLint configuration to allow, only for the components package, importing from
ariakitandframer-motion, as initially suggested in #62919 (comment)Why?
For better DevEx. The reason they are disabled in the first place is that they should be only consumer by the
@wordpress/componentspackage, so this ESlint config change just puts that advice in practive.How?
eslint-disablecomments forariakitandframer-motionimports in the components packageTesting Instructions
eslint-disablecomments left in the components packageariakitandframer-motionimports still generate an ESLint error when imported outside of the components package