fix(pacmak): xmldom error when generating packages #2713
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
In some cases, an `xmldom` error would occur when trying to render C# XML-style documentation blocks, where inline html within a Markdown document is not valid as far as the `xmldom` parser is considered. This introduces a safer fall-back strategy.
iliapolo
reviewed
Mar 16, 2021
| return new XMLSerializer().serializeToString(doc); | ||
| } catch { | ||
| // Could not parse - we'll escape unsafe XML entities here... | ||
| return html.replace(/[<>&]/g, (char: string) => { |
There was a problem hiding this comment.
So in case of success this method returns the result of serializeToString, but in case of failure it just replaces some chars in the html? Shouldn't this go back through the serializer?
There was a problem hiding this comment.
There is no XML/HTML to parse anymore once you've stripped out all the <, and >, is there?
I've tried it out of curiosity, and it results in double-XML-escaping the entities (which is weird, but heh).
There was a problem hiding this comment.
It just dawned on me that the thing we are parsing is an XML comment 👍
iliapolo
approved these changes
Mar 16, 2021
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.
In some cases, an
xmldomerror would occur when trying to render C#XML-style documentation blocks, where inline html within a Markdown
document is not valid as far as the
xmldomparser is considered. Thisintroduces a safer fall-back strategy.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.