Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix TS types for the editor package #67196

Merged
merged 10 commits into from
Nov 25, 2024

Conversation

manzoorwanijk
Copy link
Member

@manzoorwanijk manzoorwanijk commented Nov 21, 2024

Fixes #67195, #67091

What?

Following #66754, this PR fixes TS types for the components and actions in the editor package

Why?

Since the last release of the editor package, the TS types are broken

How?

  • This PR updates the component JSDoc to reflect the correct types
  • It also replaces the deprecated JSX.Element with React.ReactNode

Testing Instructions

  • Just verify that the types are correct and CI is happy

Testing Instructions for Keyboard

Screenshots or screencast

Copy link

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: .

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

1 similar comment
Copy link

Warning: Type of PR label mismatch

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Technical Prototype, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core, Gutenberg Plugin.
  • Labels found: .

Read more about Type labels in Gutenberg. Don't worry if you don't have the required permissions to add labels; the PR reviewer should be able to help with the task.

Copy link

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: manzoorwanijk <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@manzoorwanijk manzoorwanijk changed the title Fix/types for editor package Fix TS types for editor package Nov 21, 2024
@manzoorwanijk manzoorwanijk changed the title Fix TS types for editor package Fix TS types for the editor package Nov 21, 2024
@manzoorwanijk
Copy link
Member Author

@jsnajdr @tyxla any feedback on this?

The types are broken in the production release (see linked issues). I think it will be good to get those merged and released to npm.

Copy link
Member

@jsnajdr jsnajdr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this is a very nice improvement. Large diff, but exclusively jsdoc comment changes. Improves return types of React components.

@jsnajdr jsnajdr merged commit 7e9e53d into WordPress:trunk Nov 25, 2024
62 checks passed
@github-actions github-actions bot added this to the Gutenberg 19.8 milestone Nov 25, 2024
@manzoorwanijk manzoorwanijk deleted the fix/types-for-editor-package branch November 25, 2024 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

@wordpress/editor component types are broken since the last update
2 participants