coderabbitai[bot]
commented
1 month ago Walkthrough
## Walkthrough The changes primarily involve the creation of a TypeScript wrapper for Gutenberg components to address deprecation warnings introduced in WordPress 6.6. This wrapper dynamically imports components like `PluginDocumentSettingPanel` and `PluginSidebar` based on the environment, enhancing type safety and compatibility. Additionally, the modules that utilize these components have been updated to source them from the new wrapper, ensuring alignment with the latest WordPress structure and reducing potential TypeScript errors. ## Changes | Files | Change Summary | |-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| | `src/@types/gutenberg/wrapper.ts` | Introduced a TypeScript wrapper for Gutenberg components to handle deprecation warnings and dynamic imports based on the WordPress environment. | | `src/content-helper/editor-sidebar/editor-sidebar.tsx``src/content-helper/excerpt-generator/components/excerpt-panel.tsx` | Updated import statements for `PluginSidebar` and `PluginDocumentSettingPanel` to use the new wrapper, improving type safety and compatibility. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Editor as Editor Component participant Wrapper as Gutenberg Wrapper participant Plugin as PluginSidebar/PluginDocumentSettingPanel Editor->>Wrapper: Import PluginSidebar/PluginDocumentSettingPanel activate Wrapper Wrapper->>Plugin: Check wp object alt wp object defined Wrapper->>Plugin: Import from wp.editor else wp object not defined Wrapper->>Plugin: Fallback import end deactivate Wrapper Editor->>Plugin: Use PluginSidebar/PluginDocumentSettingPanel ``` ## Assessment against linked issues | Objective | Addressed | Explanation | |----------------------------------------------------------|-----------|--------------------------------------------------| | Address deprecation warnings related to `PluginSidebar` and `PluginDocumentSettingPanel` (##2667) | ✅ | | | Ensure compatibility with different WordPress versions (##2667) | ✅ | | | Refactor import paths for improved type safety (##2667) | ✅ | |
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Description
As reported in #2667, on WordPress >= 6.6, the plugin is generating a few deprecation warnings. This is due to an unification of the extensibility APIs in 6.6, where some of the components we use are being moved from
@wordpress/edit-postto@wordpress/editor.The
@wordpress/editortype definition from@types/wordpress__editorstill does not account for these changes, so it required some creativity to workaround this warning. Although, in the near future it will updated, as there's already a PR open on that repository to implement these new changes.However, the solution I came up for this - a wrapper for the components - might still be necessary even after that PR is merged, since I'm not sure that the components that have been moved to
@wordpress/editorwill work on WordPress older than 6.6.Motivation and context
How has this been tested?
Tested locally in three different WordPress versions (6.6, 6.5, and 6.4), and validated that the fallback code works on older WP versions, and the new code works on 6.6.
Summary by CodeRabbit
Summary by CodeRabbit
New Features
Improvements
Bug Fixes