DataViews: Type the ItemActions component #61400
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
youknowriad
added
[Type] Code Quality
|
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. |
|
I see some CI failures on this PR - I think they might be fixed by upgrading our react types (#60796). It seems like ariakit expects a different version of react types than we have. |
sirreal
approved these changes
May 6, 2024
oandregal
reviewed
May 7, 2024
oandregal
reviewed
May 7, 2024
| return ( | ||
| <DropdownMenuGroup> | ||
| { actions.map( ( action ) => { | ||
| if ( !! action.RenderModal ) { | ||
| if ( 'RenderModal' in action ) { |
There was a problem hiding this comment.
This is more readable, I like it. Is this related to any TypeScript thing I should be aware of or just an unrelated change that was nice to have?
There was a problem hiding this comment.
yes, basically when you do this, typescript is able to figure out the type of action that has the "RenderModal" defined. If you keep the old check, typescript will complain that RenderModal may or may not be defined.
youknowriad
force-pushed
the
add/action-types-dataviews
branch
from
bcba371
to
d135703
Compare
youknowriad
requested review from
ajitbohra,
ellatrix,
gziolo and
adamsilverstein
as code owners
youknowriad
requested review from
desrosj,
kevin940726,
ntwb and
nerrad
as code owners
|
I'm squash-merging #61486 here to confirm that fixes all the issues we're seeing here. It's not intended to be landed as part of this PR. EDIT: I should've set this to draft before it pinged all the codeowners. Sorry for the noise, folks! |
sirreal
removed request for
desrosj,
ntwb,
nerrad,
kevin940726,
ajitbohra,
gziolo and
adamsilverstein
youknowriad
force-pushed
the
add/action-types-dataviews
branch
from
8a04cad
to
ffaa966
Compare
youknowriad
force-pushed
the
add/action-types-dataviews
branch
from
3e98949
to
7e30226
Compare
youknowriad
commented
May 14, 2024
| * This should be IconType from the components package | ||
| * but that import is breaking typescript build for the moment. | ||
| */ | ||
| icon?: any; |
There was a problem hiding this comment.
So it turns out that it was the import of IconType from the components package that was breaking the build in this PR. Using any temporarily should fix it.
There was a problem hiding this comment.
😆 Just when #61486 is almost ready.
There was a problem hiding this comment.
Some detail:
I think this works around the issue that #61486 addresses. The problem was a symptom of the skipLibCheck not being present in this package's tsconfig. Because of problems in library types, anything that depended on the components package was effectively "infected" by invalid library types and would then require skipLibCheck.
|
Size Change: +19 B (0%) Total Size: 1.74 MB
ℹ️ View Unchanged
|
|
The failing linting test here is already failing on trunk (order CSS property). It should be addressed separately. |
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.
Related #55083
Follow-up to #61185
What?
The DataViews package is a types heavy package. There's a lot of structures that need to be documented properly. So this continues the effort to add explicit types to the package. This PR focuses on typing the ItemsActions component which forces us to define our Action types properly.
Testing instructions
There's no functional change, it's essentially a code quality + documentation change.