Update @wordpress/editor and remove @types/wordpress__editor #40291

manzoorwanijk · 2024-11-21T08:36:30Z

Following the PR I created in Gutenberg (Fix TS types for editor package), we no longer need buggy assertions in TS code.

Proposed changes:

Update @wordpress/editor to the latest version
Remove @types/wordpress__editor which is no longer needed
Fix the TS error following the update

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

Just check if CI is happy

What is next?

Following this PR we should replace the string selector ('core/editor') with store from @wordpress/editor to ensure that the types work correctly. For example, in projects/plugins/jetpack/extensions/plugins/ai-assistant-plugin/components/ai-image/featured-image.tsx.

CC: @Automattic/jetpack-agora

github-actions · 2024-11-21T08:37:26Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Follow this PR Review Process:

Ensure all required checks appearing at the bottom of this PR are passing.
Choose a review path based on your changes:
- A. Team Review: add the "[Status] Needs Team Review" label
  - For most changes, including minor cross-team impacts.
  - Example: Updating a team-specific component or a small change to a shared library.
- B. Crew Review: add the "[Status] Needs Review" label
  - For significant changes to core functionality.
  - Example: Major updates to a shared library or complex features.
- C. Both: Start with Team, then request Crew
  - For complex changes or when you need extra confidence.
  - Example: Refactor affecting multiple systems.
Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
WoA releases happen weekly.
Releases to self-hosted sites happen monthly. The next release is scheduled for none scheduled (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

github-actions · 2024-11-21T08:37:29Z

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the update/wordpress-editor branch.
- For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack update/wordpress-editor

bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/wordpress-editor

Interested in more tips and information?

In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
Read more about our development workflow here: PCYsg-eg0-p2
Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

manzoorwanijk · 2024-11-21T10:41:31Z

projects/plugins/jetpack/extensions/plugins/ai-content-lens/extend/ai-post-excerpt/index.tsx

-		<PostTypeSupportCheck supportKeys="excerpt">
-			<PluginDocumentSettingPanel
-				className={ isBetaExtension( 'ai-content-lens' ) ? 'is-beta-extension inset-shadow' : '' }
-				name="ai-content-lens-plugin"
-				title={ __( 'Excerpt', 'jetpack' ) }
-			>
-				<AiPostExcerpt />
-			</PluginDocumentSettingPanel>
-		</PostTypeSupportCheck>
+		<PostTypeSupportCheck
+			supportKeys="excerpt"
+			// @ts-expect-error Types for PostTypeSupportCheck children are not correct. It's `Element` instead of `ReactElement`.
+			children={
+				<PluginDocumentSettingPanel
+					className={ isBetaExtension( 'ai-content-lens' ) ? 'is-beta-extension inset-shadow' : '' }
+					name="ai-content-lens-plugin"
+					title={ __( 'Excerpt', 'jetpack' ) }
+				>
+					<AiPostExcerpt />
+				</PluginDocumentSettingPanel>
+			}
+		/>
 	);


There are many such issues in various components from @wordpress/editor package. I have created a PR in Gutenberg to fix those - WordPress/gutenberg#67196

Is the switch here from <Parent><Child/></Parent> syntax to <Parent children={ <Child /> } /> just to give it a place to add the @ts-expect-error comment, or is there a greater significance?

Is the switch here from <Parent><Child/></Parent> syntax to <Parent children={ <Child /> } /> just to give it a place to add the @ts-expect-error comment

Yes, that is correct. There is no other reason.

anomiex

Nice, glad to get rid of the @types/ package. One more and we can lose the hack for their outdated deps too.

anomiex · 2024-11-21T14:41:07Z

projects/plugins/jetpack/extensions/plugins/ai-content-lens/extend/ai-post-excerpt/index.tsx

-		<PostTypeSupportCheck supportKeys="excerpt">
-			<PluginDocumentSettingPanel
-				className={ isBetaExtension( 'ai-content-lens' ) ? 'is-beta-extension inset-shadow' : '' }
-				name="ai-content-lens-plugin"
-				title={ __( 'Excerpt', 'jetpack' ) }
-			>
-				<AiPostExcerpt />
-			</PluginDocumentSettingPanel>
-		</PostTypeSupportCheck>
+		<PostTypeSupportCheck
+			supportKeys="excerpt"
+			// @ts-expect-error Types for PostTypeSupportCheck children are not correct. It's `Element` instead of `ReactElement`.
+			children={
+				<PluginDocumentSettingPanel
+					className={ isBetaExtension( 'ai-content-lens' ) ? 'is-beta-extension inset-shadow' : '' }
+					name="ai-content-lens-plugin"
+					title={ __( 'Excerpt', 'jetpack' ) }
+				>
+					<AiPostExcerpt />
+				</PluginDocumentSettingPanel>
+			}
+		/>
 	);


Is the switch here from <Parent><Child/></Parent> syntax to <Parent children={ <Child /> } /> just to give it a place to add the @ts-expect-error comment, or is there a greater significance?

manzoorwanijk added 5 commits November 21, 2024 14:01

Update @wordpress/editor to the latest version

413b187

Remove @types/wordpress__editor as it's no longer needed

b926d99

Update pnpm-lock.yaml

7c48e91

Fix TS errors following the update

5fb15b5

Add changelog

4818639

github-actions bot added [Block] Voice To Content [Extension] AI Assistant Plugin [Extension] AI Content Lens [JS Package] Publicize Components [Package] VideoPress [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Status] In Progress RNA labels Nov 21, 2024

manzoorwanijk mentioned this pull request Nov 21, 2024

Update wordpress monorepo #40288

Merged

1 task

Fix TS error in PluginDocumentSettingPanelAiExcerpt

da132e0

github-actions bot added the [Extension] Social Previews Social Preview block editor plugin label Nov 21, 2024

Restore file

d15aec4

manzoorwanijk self-assigned this Nov 21, 2024

manzoorwanijk requested review from a team November 21, 2024 10:06

manzoorwanijk added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] In Progress labels Nov 21, 2024

github-actions bot added the [Status] In Progress label Nov 21, 2024

manzoorwanijk marked this pull request as ready for review November 21, 2024 10:40

manzoorwanijk removed the [Status] In Progress label Nov 21, 2024

manzoorwanijk commented Nov 21, 2024

View reviewed changes

anomiex approved these changes Nov 21, 2024

View reviewed changes

manzoorwanijk merged commit 080a900 into trunk Nov 21, 2024
78 of 79 checks passed

manzoorwanijk deleted the update/wordpress-editor branch November 21, 2024 14:46

github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Nov 21, 2024

This was referenced Nov 28, 2024

Update wordpress monorepo #40363

Open

Update @wordpress/editor and fix issues #40373

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update @wordpress/editor and remove @types/wordpress__editor #40291

Update @wordpress/editor and remove @types/wordpress__editor #40291

manzoorwanijk commented Nov 21, 2024 •

edited

Loading

github-actions bot commented Nov 21, 2024

github-actions bot commented Nov 21, 2024 •

edited

Loading

manzoorwanijk Nov 21, 2024

anomiex Nov 21, 2024

manzoorwanijk Nov 21, 2024

anomiex left a comment

anomiex Nov 21, 2024

Update @wordpress/editor and remove @types/wordpress__editor #40291

Update @wordpress/editor and remove @types/wordpress__editor #40291

Conversation

manzoorwanijk commented Nov 21, 2024 • edited Loading

Proposed changes:

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

What is next?

github-actions bot commented Nov 21, 2024

github-actions bot commented Nov 21, 2024 • edited Loading

manzoorwanijk Nov 21, 2024

Choose a reason for hiding this comment

anomiex Nov 21, 2024

Choose a reason for hiding this comment

manzoorwanijk Nov 21, 2024

Choose a reason for hiding this comment

anomiex left a comment

Choose a reason for hiding this comment

anomiex Nov 21, 2024

Choose a reason for hiding this comment

manzoorwanijk commented Nov 21, 2024 •

edited

Loading

github-actions bot commented Nov 21, 2024 •

edited

Loading