Raw handling: preserve empty paragraphs #59476
Merged
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
ellatrix
added
the
[Feature] Raw Handling
|
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 Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @designsimply, @AdrienM76, @housebolt, @u451f, @selimanac, @zackkatz, @vrrobz, @XavDeb-duplicate, @mlaetitia, @petralian, @marcuswisecaesar, @selectedselections, @Studio28, @nboot8, @eoinsav, @jq-87, @eyyddxx04, @AlphaOmega5732, @Blogography. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. 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: +5.96 kB (0%) Total Size: 1.72 MB
ℹ️ View Unchanged
|
mcsf
reviewed
Mar 20, 2024
| node.parentNode.nodeName !== 'P' || | ||
| node.parentNode.childNodes.length === 1 | ||
| ) { | ||
| if ( ! node.parentNode || node.parentNode.nodeName !== 'P' ) { |
There was a problem hiding this comment.
@ellatrix: can you explain this change? The code no longer matches the comment. If you can confirm my intuition here:
- Now the
elsebranch will be run whenever the comment node's parent is a paragraph, even if it only has one child (the comment node). - This forces all paragraphs through the
paragraphBuilderwalk, ensuring that paragraphs that only contained the comment (and would become<p></p>) are destroyed.
If the above is right, some follow-up questions:
- Is it necessary to the current PR, or an adjacent change?
- Looking at the tests in
packages/blocks/src/api/raw-handling/test/special-comment-converter.js, there is now some inconsistency between the handling of<!--more-->and<!--nextpage-->— with the latter, tests still expect empty paragraph nodes to be produced. Should we fix that?
There was a problem hiding this comment.
Not adjacent, it was required to update this because some of the integration tests started failing with extra empty paragraphs that the original change was no longer removing.
I didn't think the comment no longer matched, but I reworded it.
I also fixed it for next page.
mcsf
approved these changes
Mar 28, 2024
| @@ -105,7 +67,35 @@ function moreCommentConverter( node, doc ) { | |||
| } | |||
| } | |||
|
|
|||
| function createMore( customText, noTeaser, doc ) { | |||
| function createBlock( commentNode, doc ) { | |||
There was a problem hiding this comment.
I understand the convenience of folding everything into a single function. However, the resulting function is more difficult to understand for someone who doesn't have our context. Can we add a comment explaining that this function handles both more and nextpage comments, for ease of maintenance?
If we wanted to go the extra mile, we could even make that explicit in code, either with a switch:
switch ( commentNode.nodeValue.match(/\w+/)?.[0] ) {
case 'nextpage':
// do stuff
break;
case 'more':
// do stuff
break;
}Or simply via function delegation:
function createBlock( commentNode, doc ) {
if ( commentNode.nodeValue === 'nextpage' ) {
return createNextPage( doc );
}
return createMore( commentNode, doc );
}There was a problem hiding this comment.
Restored the original functions :)
cbravobernal
pushed a commit
to garridinsi/gutenberg
that referenced
this pull request
Apr 9, 2024
Unlinked contributors: designsimply, AdrienM76, housebolt, u451f, selimanac, zackkatz, vrrobz, XavDeb-duplicate, mlaetitia, petralian, marcuswisecaesar, selectedselections, Studio28, nboot8, eoinsav, jq-87, eyyddxx04, AlphaOmega5732, Blogography. Co-authored-by: ellatrix <ellatrix@git.wordpress.org> Co-authored-by: mcsf <mcsf@git.wordpress.org> Co-authored-by: earnjam <earnjam@git.wordpress.org> Co-authored-by: mrwweb <mrwweb@git.wordpress.org> Co-authored-by: timnicholson <timnicholson@git.wordpress.org> Co-authored-by: TiBiker <steveblum@git.wordpress.org> Co-authored-by: QuietNoise <quietnoise@git.wordpress.org> Co-authored-by: rodrigo-arias <kreppar@git.wordpress.org> Co-authored-by: paaljoachim <paaljoachim@git.wordpress.org> Co-authored-by: YukinobuAsakawa <yukinobu@git.wordpress.org>
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 #11211.
For raw handling (not paste!) we should preserve the original content as much as possible. That means also preserving empty or empty looking paragraphs.
Why?
The philosophy of raw handling, as opposed to paste, is to preserve as much legacy content as possible while also converting to blocks.
How?
Pass a flag. We also need to strip the paragraphs around short codes and handle special comments better.
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast