Markdown: add comment parsing to lexer #2316
Open
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
Prior to this commit, comments were not included in the Markdown lexer. This patch adds comments to the Markdown lexer output. Now comments such as`<!-- comment -->` will be highlighted as comments appropriately. This includes multi-line comments. The regex strings for Markdown headings have been altered to allow for comments at the end of heading lines.
jeanas
reviewed
Jan 29, 2023
| @@ -176,3 +176,33 @@ def test_invalid_code_block(lexer): | |||
| for fragment in fragments: | |||
| for token, _ in lexer.get_tokens(fragment): | |||
| assert token != String.Backtick | |||
|
|
|||
|
|
|||
| def test_comment(lexer): | |||
There was a problem hiding this comment.
The testing method used in this file is legacy. Instead, please use the method described here: https://pygments.org/docs/lexerdevelopment/#adding-and-testing-a-new-lexer
| @@ -540,13 +540,17 @@ def _handle_codeblock(self, match): | |||
| tokens = { | |||
| 'root': [ | |||
| # heading with '#' prefix (atx-style) | |||
| (r'(^#[^#].+)(\n)', bygroups(Generic.Heading, Text)), | |||
| (r'(^#[^#].+?)(<!--.*?-->)?(\n)', | |||
| bygroups(Generic.Heading, Comment, Text)), | |||
There was a problem hiding this comment.
Can a comment only appear at the end, or also in the middle? Same question on other changes.
| @@ -594,6 +598,9 @@ def _handle_codeblock(self, match): | |||
| bygroups(Text, Name.Tag, Text, Text, Name.Label, Text)), | |||
| (r'^(\s*\[)([^]]*)(\]:\s*)(.+)', | |||
| bygroups(Text, Name.Label, Text, Name.Attribute)), | |||
| # comments (can span multiple lines) | |||
| (r'(<!--[\s\S]*?-->)', | |||
There was a problem hiding this comment.
Just
Suggested change
| (r'(<!--[\s\S]*?-->)', | |
| (r'(<!--.*?-->)', |
(note that the lexer has re.MULTILINE in its flags).
|
I'm really sorry, I made this review from the start, and somehow didn't click "Submit" so it just stayed "pending" for 3 weeks :( |
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.
Prior to this commit, comments were not included in the Markdown lexer. This patch adds comments to the Markdown lexer output. Now comments such as
<!-- comment -->will be highlighted as comments appropriately. This includes multi-line comments.The regex strings for Markdown headings have been altered to allow for comments at the end of heading lines.
Fixes #2273