ESLint: Add use-import-as rule#77389
Merged
Merged
Conversation
9 tasks
|
Size Change: 0 B Total Size: 7.76 MB ℹ️ View Unchanged
|
|
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. |
|
Flaky tests detected in 43cdffb. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/24833217145
|
ciampo
reviewed
Apr 21, 2026
ciampo
left a comment
Contributor
There was a problem hiding this comment.
-
Should we add a CHANGELOG entry for the
@wordpress/eslint-pluginpackage? -
Should we update all docs in
@wordpress/componentsto also use the suggested renaming in Gutenberg? Or at least, should we remove the__experimentalComponent as Componentpattern in those docs?
Left a few suggestions, some of them being the result of an internal AI-assisted review.
# Conflicts: # packages/eslint-plugin/CHANGELOG.md
Member
Author
Added.
I'm a bit hesitant to do that right now because the actual value mapping is only defined in every repo's own eslintrc. |
ciampo
approved these changes
Apr 22, 2026
ciampo
left a comment
Contributor
There was a problem hiding this comment.
LGTM 🚀
Left some extra feedback, but pre-approving
Comment on lines
+258
to
+263
| { | ||
| '@wordpress/components': { | ||
| __experimentalText: 'WCText', | ||
| Badge: 'WCBadge', | ||
| }, | ||
| }, |
Contributor
There was a problem hiding this comment.
Should we also add `VisuallyHidden: 'WCVisuallyHidden', ?
Member
Author
There was a problem hiding this comment.
I'm cleaning up everything in #77575, so not needed.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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?
Part of #76135
@wordpress/use-import-asrule to@wordpress/eslint-plugin.@wordpress/componentsaliases, including__experimentalText->WCTextandBadge->WCBadge.Why?
As we introduce new components from
@wordpress/ui, there will be equivalent components from@wordpress/componentsthat have the same name. This makes it easier to distinguish between the two, both for a human eye and when grepping.How?
use-import-asESLint rule that accepts a package-to-name mapping in config.const { Badge } = unlock( privateApis );destructuring pattern for private APIs.WCTextandWCBadgealiases where applicable.Testing Instructions
wp-scripts test-unit-js --config test/unit/jest.config.js packages/eslint-plugin/rules/__tests__/use-import-as.js --runInBand.wp-scripts lint-js --config eslint.config.mjs packages --rule "@wordpress/use-import-as:error".@wordpress/use-import-aserrors.Use of AI Tools
Cursor AI was used to help implement the ESLint rule, update existing usages, and prepare this pull request. I reviewed and validated the resulting changes.