-
Notifications
You must be signed in to change notification settings - Fork 800
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
Social: Improve TS error reporting in publicize-components #39133
Social: Improve TS error reporting in publicize-components #39133
Conversation
Thank you for your PR! When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:
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:
Still unsure? Reach out in #jetpack-developers for guidance! |
Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.
Interested in more tips and information?
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code looks reasonable, we also have this dep in the main Jetpack package
Right now, if we use
store
from@wordpress/editor
, it results in TS errors because of messed up TS types for that package. Those errors are not shown in the IDE we we use, rather they are reported only in CI when runningpnpm compile-ts
inplugins/jetpack
.So, installing
"@types/wordpress__editor"
as a dependency inpublicize-components
will show us the errors in the IDE and we won't have to wait for CI to show us the errors.Also, instead of using casting
as any
along witheslint-disable-*
, it's better and recommended to use@ts-expect-error
instead of@ts-ignore
. This way if that package fixes its TS types, we will get to know by that comment.Proposed changes:
"@types/wordpress__editor"
as a dependency topublicize-components
as any
Other information:
Jetpack product discussion
Does this pull request change what data or activity we track or use?
Testing instructions: