fix(tokenizer): require full --> to close comments in xmlMode#2383
Merged
fix(tokenizer): require full --> to close comments in xmlMode#2383
--> to close comments in xmlMode#2383Conversation
In HTML, `<!-->` is a valid empty comment per the spec. However, in XML comments must be closed by `-->`, so `<!-->` should be treated as an opening — not a complete comment. Skip the short-comment shortcut when xmlMode is enabled. Fixes #1823
There was a problem hiding this comment.
Pull request overview
This PR adjusts the tokenizer’s comment-closing behavior so that XML mode no longer treats the HTML-only shorthand <!--> as a complete (empty) comment, matching XML’s requirement that comments close with -->. It also adds a regression test covering the reported issue (#1823).
Changes:
- Skip the
<!-->short-comment fast path whenxmlModeis enabled. - Add a tokenizer snapshot test reproducing the XML-mode misparse from #1823.
- Update snapshots to reflect the corrected tokenization behavior.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
src/Tokenizer.ts |
Changes initial comment-end sequence matching to require a real --> close in xmlMode (no <!--> shortcut). |
src/Tokenizer.spec.ts |
Adds a regression test asserting <!--> is not treated as a complete comment in XML mode. |
src/__snapshots__/Tokenizer.spec.ts.snap |
Records expected event stream for the new regression test. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| ).toMatchSnapshot(); | ||
| }); | ||
|
|
||
| it("should not treat <!--> as a complete comment in xmlMode", () => { |
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
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 HTML,
<!-->is a valid empty comment per the spec. However, in XML comments must be closed by-->, so<!-->should be treated as an opening — not a complete comment. Skip the short-comment shortcut when xmlMode is enabled.Fixes #1823