Media Utils: Add TypeScript support and export more utils #64784
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
swissspidy
added
[Type] Enhancement
|
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. |
|
Size Change: +275 B (+0.02%) Total Size: 1.78 MB
ℹ️ View Unchanged
|
swissspidy
force-pushed
the
fix/61447-media-utils
branch
2 times, most recently
from
957d50a to
db379b4
Compare
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
swissspidy
force-pushed
the
fix/61447-media-utils
branch
from
db379b4 to
1b70586
Compare
swissspidy
force-pushed
the
fix/61447-media-utils
branch
from
1b70586 to
6a73fa4
Compare
7 tasks
|
Flaky tests detected in 602a0b2. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/10644454071
|
gziolo
reviewed
Aug 28, 2024
|
I see that the README file doesn't contain auto-generated documentation for the public API. I'm wondering if we should put to test out how it all plays out together? It would also be easier to review if it existed before, as we would see the difference unless everything was undocumented ... |
|
Just added the auto-generated API reference to the readme. Your observation is correct. React components are not part of the generated API reference. And TypeScript types are also not properly detected by that tool, so it says "Undocumented declaration." |
gziolo
changed the title
media-utils
ntsekouras
reviewed
Aug 31, 2024
Co-authored-by: Nik Tsekouras <ntsekouras@outlook.com>
tyxla
reviewed
Sep 2, 2024
There was a problem hiding this comment.
Great work @swissspidy, thanks for adding all the tests!
Would be nice if we can document all the newly exported utilities.
I've also left a few drive-by questions, let me know what you think.
@jsnajdr could potentially be interested to review the types.
jsnajdr
reviewed
Sep 5, 2024
6 tasks
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.
What?
See #61447 for full context.
Split out from #64278, this converts the
media-utilspackage to TypeScript and simultaneously exports more of the utils for consumers to use.Why?
With client-side media processing, there is a need to validate files twice: once before they're processed in the browser, and once before upload. This is only possible if
media-utilsutils are exported so theblock-editorpackage can use them.How?
Very simple, introduces TypeScript to this package and adds more exports.
Testing Instructions
Tests should pass
Testing Instructions for Keyboard
N/A
Screenshots or screencast
N/A