TextControl: Add lint rule for 40px size prop usage #64455
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
mirka
commented
Aug 12, 2024
Comment on lines
+311
to
+318
| // Temporary rules until all existing components have the `__next40pxDefaultSize` prop. | ||
| ...[ 'TextControl' ].map( ( componentName ) => ( { | ||
| // Not strict. Allows pre-existing __next40pxDefaultSize={ false } usage until they are all manually updated. | ||
| selector: `JSXOpeningElement[name.name="${ componentName }"]:not(:has(JSXAttribute[name.name="__next40pxDefaultSize"])):not(:has(JSXAttribute[name.name="size"]))`, | ||
| message: | ||
| componentName + | ||
| ' should have the `__next40pxDefaultSize` prop to opt-in to the new default size.', | ||
| } ) ), |
There was a problem hiding this comment.
This is less strict than the rules that will be placed on components with no more existing violations. The goal is to resolve all existing violations for a given component, and move them to the list with the stricter rules.
28 tasks
mirka
requested review from
ellatrix,
artemiomorales and
ajitbohra
as code owners
|
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. |
|
Size Change: +93 B (+0.01%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
Good question! There will be an extra checklist item in #63871 for components that still have remaining violations. I will personally dedicate time to reducing the existing violations as long as I have time remaining in my sprint. We'll see how much I can get through, and we might need to create a separate tracking issue once my stab at it is over. |
getdave
pushed a commit
that referenced
this pull request
Aug 14, 2024
* TextControl: Add lint rule for 40px size prop usage * Fixup * Fixup formatting Co-authored-by: mirka <0mirka00@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.
Part of #63871
What?
Add a lint rule to prevent people from introducing new usages of TextControl that do not adhere to the new default size, while adding a TODO note on existing violations.
Why?
Some components like TextControl have a large number of existing violations, and it would take some time to safely switch them all. I realized that we can more efficiently move everything to the new 40px sizes if we immediately start preventing new violations from entering the codebase, as well as add TODO comments on the existing violations so people who come across that code are more likely to fix it on the spot.
How?
I codemod'ed all existing violations to:
Testing Instructions
The lint error should trigger if you add a TextControl with no
__next40pxDefaultSizeorsizeprop.