Add tests for parsing of inline HTML when rendering markdown as HTML #1379
+91
−32
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
Contributor
Author
|
@swift-ci please test |
This was referenced Dec 5, 2025
heckj
approved these changes
Dec 5, 2025
patshaughnessy
approved these changes
Dec 6, 2025
Contributor
patshaughnessy
left a comment
patshaughnessy
left a comment
There was a problem hiding this comment.
This looks much better now - thanks for refactoring this! With the new comments and extracted functions it's much easier for me to follow the algorithm 👍
| continue | ||
| } | ||
|
|
||
| // Otherwise, we need to determine how long this markdown element it. |
Contributor
There was a problem hiding this comment.
Suggested change
| // Otherwise, we need to determine how long this markdown element it. | |
| // Otherwise, we need to determine how long this markdown element is. |
|
|
||
| // On non-Darwin platforms, `XMLElement(xmlString:)` sometimes crashes for certain invalid / incomplete XML strings. | ||
| // To minimize the risk of this happening, don't try to parse the XML string as an empty HTML element unless it ends with "/>" | ||
| if rawHTML.hasSuffix("/>"), let parsed = try? XMLElement(xmlString: rawHTML) { |
Contributor
There was a problem hiding this comment.
Did you run into some crashes while running your new tests in Linux CI?
| let element = elements.removeFirst() | ||
|
|
||
| guard let start = element as? InlineHTML else { | ||
| var remainder = Array(container)[...] |
Contributor
There was a problem hiding this comment.
Since you're using a slice here, I imagine this is quite efficient, even though we are mutating remainder.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Bug/issue #, if applicable:
Summary
This is a follow up change from #1369
It adds tests for how the
DocCHTML/MarkdownRendererprocesses inline HTML—skipping any comments while preserving the rest. With these tests in place, I could refactor the implementation with more confidence and extract the inner loop into a private function.Dependencies
None.
Testing
Nothing in particular for this PR. It only adds tests and makes minor code cleanup to functionality that is only exercised in tests so far. See #1366 for how it eventually does get used.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded