fix(block-tools): enforce list support in schema #4985
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
|
No changes to documentation |
|
Component Testing Report Updated Oct 18, 2023 9:03 AM (UTC)
|
skogsmaskin
force-pushed
the
edx-567
branch
2 times, most recently
from
882e4f1 to
1a9f693
Compare
robinpyon
approved these changes
Oct 13, 2023
rexxars
approved these changes
Oct 17, 2023
Comment on lines
21
to
36
| let listStyle | ||
| switch (listNodeTagName) { | ||
| case 'ul': | ||
| listStyle = 'bullet' | ||
| if (enabledListTypes.includes('bullet')) { | ||
| listStyle = 'bullet' | ||
| } | ||
| break | ||
| case 'ol': | ||
| listStyle = 'number' | ||
| if (enabledListTypes.includes('number')) { | ||
| listStyle = 'number' | ||
| } | ||
| break | ||
| default: | ||
| listStyle = 'bullet' | ||
| listStyle = undefined | ||
| } | ||
| return listStyle |
There was a problem hiding this comment.
This function seems a bit cumbersome to me after the conditionals were added, maybe we could simplify it?
if (listNodeTagName === 'ul' && enabledListTypes.includes('bullet')) {
return 'bullet'
}
if (listNodeTagName === 'ol' && enabledListTypes.includes('number')) {
return 'number'
}
return undefinedThere was a problem hiding this comment.
Better! I've changed it, tnx!
Comment on lines
202
to
195
| const enabledListItem = resolveListItem(parentTag, options.enabledListTypes) | ||
| if (!listItem || !el.parentNode || !HTML_LIST_CONTAINER_TAGS[parentTag]) { | ||
| return undefined | ||
| } |
There was a problem hiding this comment.
This can be moved down below the conditional, in order to not do unnecessary work:
Suggested change
| const enabledListItem = resolveListItem(parentTag, options.enabledListTypes) | |
| if (!listItem || !el.parentNode || !HTML_LIST_CONTAINER_TAGS[parentTag]) { | |
| return undefined | |
| } | |
| if (!listItem || !el.parentNode || !HTML_LIST_CONTAINER_TAGS[parentTag]) { | |
| return undefined | |
| } | |
| const enabledListItem = resolveListItem(parentTag, options.enabledListTypes) |
There was a problem hiding this comment.
Yes, changed this as well!
HTML lists should not be deserialized to list blocks if there is no such support in schema
rexxars
pushed a commit
that referenced
this pull request
Oct 20, 2023
HTML lists should not be deserialized to list blocks if there is no such support in schema
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.
Description
This will make sure that HTML is not deserialized to list blocks where there is no such support in the given schema.
What to review
That pasting HTML lists into Portable Text will not produce any list blocks with the current schema:
Notes for release