Fix support for comments #260
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
Previous implementation of comments was simply converting all "<!--" and
"-->" to "{/*" and "*/}". This was very naive and caused a lot of edge
cases. This also supported nesting Markdown comments in JSX, which isn't
how regular Markdown works; nesting comments inside regular HTML doesn't
work, so it doesn't make sense that it works here.
This fix simply takes advantage of remark's support for comments, which
takes care of all of the edge cases and doesn't reinvent the wheel.
Fixes #256
Fixes #244
|
This pull request is automatically deployed with Now. |
silvenon
commented
Sep 15, 2018
| node.type = node.mdxType || 'jsx' | ||
| if ( | ||
| node.value.startsWith('<!--') && | ||
| node.value.endsWith('-->') |
There was a problem hiding this comment.
Remark contains all comments as separate html nodes.
| @@ -20,7 +20,6 @@ I'm an awesome paragraph. | |||
| <Bar>hi</Bar> | |||
| {hello} | |||
| {/* another commment */} | |||
| <!-- one more comment --> | |||
There was a problem hiding this comment.
I removed this line because, now that this is no longer treated as a comment, it causes an error when Babel tries to parse it.
| <div> | ||
| {/* a nested JSX comment */} | ||
| <!-- a nested Markdown comment --> | ||
| <!-- div content --> |
There was a problem hiding this comment.
This would technically cause a Babel error (as mentioned above), but I included it in the test to ensure that it doesn't turn into a comment.
This was referenced Sep 20, 2018
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.
Previous implementation of comments was simply converting all
<!--and-->to{/*and*/}. This was very naive and caused a lot of edgecases. It also supported nesting Markdown comments in JSX, which isn't
how regular Markdown works; nesting comments inside regular HTML doesn't
work, so it doesn't make sense that it works here. So that part is a breaking change.
This fix simply takes advantage of remark's support for comments, which
takes care of all of the edge cases and doesn't reinvent the wheel.