Do not escape tildes in safe constructs that are nested in unsafe constructs #2
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
Note that the safe constructs must be wrapped by an unsafe construct like a paragraph or heading, because gfmStrikethroughToMarkdown will only escape them inside constructs where strikethroughs can be used (ie paragraphs and headings).
github-actions
bot
added
👋 phase/new
4 tasks
wooorm
reviewed
Nov 4, 2022
wooorm
approved these changes
Nov 4, 2022
This comment has been minimized.
This comment has been minimized.
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.
Initial checklist
Description of changes
Fix for the issue described in remarkjs/remark-gfm#42
I've first added tests to prove that tildes are in fact being escaped in some safe constructs like link URLs (among others). See the results here: https://github.com/bertramakers/mdast-util-gfm-strikethrough/actions/runs/3394305801
Results with the code fix: https://github.com/bertramakers/mdast-util-gfm-strikethrough/actions/runs/3394322969
Tests & code are heavily based on syntax-tree/mdast-util-to-markdown@7b381da so credits go to @wooorm for doing the heavy lifting before and sharing how to fix this.