Add myst_line_comment

Author: chrisjsewell

markdown_it/common/utils.py

@@ -228,38 +228,38 @@ def isPunctChar(ch):
 
 
 MD_ASCII_PUNCT = {
-    0x21,  # /* ! */:
-    0x22,  # /* " */:
-    0x23,  # /* # */:
-    0x24,  # /* $ */:
-    0x25,  # /* % */:
-    0x26,  # /* & */:
-    0x27,  # /* ' */:
-    0x28,  # /* ( */:
-    0x29,  # /* ) */:
-    0x2A,  # /* * */:
-    0x2B,  # /* + */:
-    0x2C,  # /* , */:
-    0x2D,  # /* - */:
-    0x2E,  # /* . */:
-    0x2F,  # /* / */:
-    0x3A,  # /* : */:
-    0x3B,  # /* ; */:
-    0x3C,  # /* < */:
-    0x3D,  # /* = */:
-    0x3E,  # /* > */:
-    0x3F,  # /* ? */:
-    0x40,  # /* @ */:
-    0x5B,  # /* [ */:
-    0x5C,  # /* \ */:
-    0x5D,  # /* ] */:
-    0x5E,  # /* ^ */:
-    0x5F,  # /* _ */:
-    0x60,  # /* ` */:
-    0x7B,  # /* { */:
-    0x7C,  # /* | */:
-    0x7D,  # /* } */:
-    0x7E,  # /* ~ */:
+    0x21,  # /* ! */
+    0x22,  # /* " */
+    0x23,  # /* # */
+    0x24,  # /* $ */
+    0x25,  # /* % */
+    0x26,  # /* & */
+    0x27,  # /* ' */
+    0x28,  # /* ( */
+    0x29,  # /* ) */
+    0x2A,  # /* * */
+    0x2B,  # /* + */
+    0x2C,  # /* , */
+    0x2D,  # /* - */
+    0x2E,  # /* . */
+    0x2F,  # /* / */
+    0x3A,  # /* : */
+    0x3B,  # /* ; */
+    0x3C,  # /* < */
+    0x3D,  # /* = */
+    0x3E,  # /* > */
+    0x3F,  # /* ? */
+    0x40,  # /* @ */
+    0x5B,  # /* [ */
+    0x5C,  # /* \ */
+    0x5D,  # /* ] */
+    0x5E,  # /* ^ */
+    0x5F,  # /* _ */
+    0x60,  # /* ` */
+    0x7B,  # /* { */
+    0x7C,  # /* | */
+    0x7D,  # /* } */
+    0x7E,  # /* ~ */
 }
 
 

markdown_it/extensions/myst_blocks/index.py

@@ -2,13 +2,19 @@
 
 from markdown_it import MarkdownIt
 from markdown_it.rules_block import StateBlock
-from markdown_it.common.utils import charCodeAt, isSpace
+from markdown_it.common.utils import charCodeAt, isSpace, escapeHtml
 
 
 TARGET_PATTERN = re.compile(r"^\(([a-zA-Z\_\-\+\:]{1,36})\)\=\s*$")
 
 
 def myst_block_plugin(md: MarkdownIt):
+    md.block.ruler.before(
+        "blockquote",
+        "myst_line_comment",
+        line_comment,
+        {"alt": ["paragraph", "reference", "blockquote", "list", "footnote_def"]},
+    )
     md.block.ruler.before(
         "hr",
         "myst_block_break",
@@ -22,6 +28,37 @@ def myst_block_plugin(md: MarkdownIt):
         {"alt": ["paragraph", "reference", "blockquote", "list", "footnote_def"]},
     )
     md.add_render_rule("myst_target", render_myst_target)
+    md.add_render_rule("myst_line_comment", render_myst_line_comment)
+
+
+def line_comment(state: StateBlock, startLine: int, endLine: int, silent: bool):
+
+    pos = state.bMarks[startLine] + state.tShift[startLine]
+    maximum = state.eMarks[startLine]
+
+    # if it's indented more than 3 spaces, it should be a code block
+    if state.sCount[startLine] - state.blkIndent >= 4:
+        return False
+
+    marker = charCodeAt(state.src, pos)
+    pos += 1
+
+    # Check block marker /* % */
+    if marker != 0x25:
+        return False
+
+    if silent:
+        return True
+
+    state.line = startLine + 1
+
+    token = state.push("myst_line_comment", "", 0)
+    token.attrSet("class", "myst-line-comment")
+    token.content = state.src[pos:maximum].strip()
+    token.map = [startLine, state.line]
+    token.markup = chr(marker)
+
+    return True
 
 
 def block_break(state: StateBlock, startLine: int, endLine: int, silent: bool):
@@ -36,7 +73,7 @@ def block_break(state: StateBlock, startLine: int, endLine: int, silent: bool):
     marker = charCodeAt(state.src, pos)
     pos += 1
 
-    # Check block marker /* + */:
+    # Check block marker /* + */
     if marker != 0x2B:
         return False
 
@@ -96,4 +133,12 @@ def target(state: StateBlock, startLine: int, endLine: int, silent: bool):
 
 def render_myst_target(self, tokens, idx, options, env):
     content = tokens[idx].content
-    return f'<div class=" admonition myst-target">target = <code>{content}</code></div>'
+    return (
+        '<div class=" admonition myst-target">'
+        f"target = <code>{escapeHtml(content)}</code></div>"
+    )
+
+
+def render_myst_line_comment(self, tokens, idx, options, env):
+    content = tokens[idx].content
+    return f"<!--- {escapeHtml(content)} --->"

markdown_it/extensions/myst_role/index.py

@@ -2,7 +2,7 @@
 
 from markdown_it import MarkdownIt
 from markdown_it.rules_inline import StateInline
-from markdown_it.common.utils import charCodeAt
+from markdown_it.common.utils import charCodeAt, escapeHtml
 
 
 PATTERN = re.compile(r"^\{([a-zA-Z\_\-\+\:]{1,36})\}(`+)(?!`)(.+?)(?<!`)\2(?!`)")
@@ -37,4 +37,8 @@ def myst_role(state: StateInline, silent: bool):
 def render_myst_role(self, tokens, idx, options, env):
     token = tokens[idx]
     name = token.meta.get("name", "unknown")
-    return '<code class="sphinx-role">' f"{{{name}}}[{token.content}]" "</code>"
+    return (
+        '<code class="sphinx-role">'
+        f"{{{name}}}[{escapeHtml(token.content)}]"
+        "</code>"
+    )

markdown_it/rules_core/state_core.py

@@ -5,9 +5,9 @@
 
 
 class StateCore(StateBase):
-    def __init__(self, src: str, md, env):
+    def __init__(self, src: str, md, env, tokens=None):
         self.src = src
         self.md = md  # link to parser instance
         self.env = env
-        self.tokens: List[Token] = []
+        self.tokens: List[Token] = tokens or []
         self.inlineMode = False

tests/test_myst_block/fixtures.md

@@ -20,7 +20,7 @@ Block Break Too Few Markers:
 <p>++</p>
 .
 
-Terminates other blocks:
+Block Break terminates other blocks:
 .
 a
 +++
@@ -50,7 +50,7 @@ Target:
 .
 
 
-Terminates other blocks:
+Target terminates other blocks:
 .
 a
 (a)=
@@ -67,4 +67,30 @@ a
 <p>c</p>
 </blockquote>
 <div class=" admonition myst-target">target = <code>a</code></div>
-.
+.
+
+Comment:
+.
+% abc
+.
+<!--- abc --->
+.
+
+Comment terminates other blocks:
+.
+a
+% abc
+- b
+% abc
+> c
+% abc
+.
+<p>a</p>
+<!--- abc ---><ul>
+<li>b</li>
+</ul>
+<!--- abc ---><blockquote>
+<p>c</p>
+</blockquote>
+<!--- abc --->
+.