Fix Quote to Paragraph transform #66953
Open
Conversation
This file contains hidden or 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
… or at least one paragraph
talldan
added
[Type] Bug
talldan
requested review from
ajitbohra,
artemiomorales and
ellatrix
as code owners
talldan
force-pushed
the
fix/quote-to-paragraph-transform
branch
from
3bf7120 to
918d463
Compare
|
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. |
talldan
requested review from
aaronrobertshaw,
andrewserong,
ramonjd and
tellthemachines
|
Size Change: +39 B (0%) Total Size: 1.82 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 918d463. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11813860105
|
ellatrix
reviewed
Nov 13, 2024
| return ( | ||
| ! RichText.isEmpty( citation ) || | ||
| block.innerBlocks.some( | ||
| ( { name } ) => name === 'core/paragraph' |
Member
There was a problem hiding this comment.
I think this transform should still be possible. Unfortunately the meaning has changed from "convert to paragraph" to just unwrap the entire thing. If we change this, it will no longer be possible to unwrap the quote?
Contributor
Author
There was a problem hiding this comment.
I think this transform should still be possible.
Possibly. How should it work ... convert any non-paragraphs blocks to paragraphs? We can try running transforms to paragraphs for any inner block types that have that transform. The isMatch would have to check if there are available transforms for all inner block types, but it might not be too bad.
The other option is to allow it to simply unwrap, but I think it'd be weird if it's called a Paragraph transform, and yet it doesn't actually convert to paragraphs.
If we change this, it will no longer be possible to unwrap the quote?
There's still an 'Ungroup' option in the block settings menu that unwraps the quote. It's not surfaced in the transform menu. It seems to work for any inner block types that quote may have.
I only found it because it's mentioned in the e2e tests.
Contributor
Author
There was a problem hiding this comment.
The other option is to allow it to simply unwrap, but I think it'd be weird if it's called a Paragraph transform, and yet it doesn't actually convert to paragraphs.
This seems to be what @richtabor mentions in #51934 (comment)
That PR was merged, though I suspect this may be better suited — to have "Unquote" as an option, instead of "Paragraph".
If the ungroup transform supported a label of __( 'Unquote' ), that'd allow it to be shown more clearly in the block settings and transforms menus.
Member
There was a problem hiding this comment.
For what it's worth, "unquote" makes logical sense to me as a permanent option.
I'm likening it to markdown.
To wrap content in a quote we add >
There are multiple entities inside this quote 😄
Removing the > will just 'unwrap' it, regardless of what the internal entities are.
Contributor
Author
I can follow up with that once we have an idea of how we want it to work 👍 |
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?
Fixes something I randomly spotted. If you try transforming a quote block that contains no paragraphs or citations to a paragraph block, an error is thrown. It happens because
switchToBlockType(which handles transforms) requires the transformed blocks to contain one of the destination types (paragraph). The transform instead results in a heading block, soswitchToBlockTypereturnsnullandreplaceBlockschokes on that value.This also unearths another issue, in many places
switchToBlockTypeis called followed by a call toreplaceBlockswith the results ofswitchToBlockType. IfswitchToBlockTypereturnsnull, these errors can be thrown.In this PR I'm also adding some protection against calling
replaceBlockswithnull.Potentially
replaceBlockscould handle this, but I decided not to go that route. If this were typescript we wouldn't add safety toreplaceBlocksitself or weaken the parameter types by acceptingnull, instead it would fail to compile because the call sites try calling with the wrong type. As there may be TS consumers of this code, I decided to go with the more strongly typed approach and fix the call sites.How?
isMatchto the Quote -> Paragraph transform to ensure it only appears when a valid transform is possible.switchToBlockTypeTesting Instructions
Screenshots or screencast
Before
After