👌 IMPROVE: susbstitution; configurable delimiters

Author: chrisjsewell

mdit_py_plugins/substitution.py

@@ -3,7 +3,9 @@
 from markdown_it.rules_block import StateBlock
 
 
-def substitution_plugin(md: MarkdownIt):
+def substitution_plugin(
+    md: MarkdownIt, start_delimiter: str = "{", end_delimiter: str = "}"
+):
     """A plugin to create substitution tokens.
 
     These, token should be handled by the renderer.
@@ -15,93 +17,97 @@ def substitution_plugin(md: MarkdownIt):
         a {{ inline }} b
 
     """
-    md.block.ruler.before("fence", "substitution_block", _substitution_block)
-    md.inline.ruler.before("escape", "substitution_inline", _substitution_inline)
 
+    start_char = ord(start_delimiter)
+    end_char = ord(end_delimiter)
 
-def _substitution_inline(state: StateInline, silent: bool):
-    try:
-        if (
-            state.srcCharCode[state.pos] != 0x7B  # /* { */
-            or state.srcCharCode[state.pos + 1] != 0x7B
-        ):
-            return False
-    except IndexError:
-        return False
-
-    pos = state.pos + 2
-    found_closing = False
-    while True:
+    def _substitution_inline(state: StateInline, silent: bool):
         try:
-            end = state.srcCharCode.index(0x7D, pos)  # /* } */
-        except ValueError:
-            return False
-        try:
-            if state.srcCharCode[end + 1] == 0x7D:
-                found_closing = True
-                break
+            if (
+                state.srcCharCode[state.pos] != start_char
+                or state.srcCharCode[state.pos + 1] != start_char
+            ):
+                return False
         except IndexError:
             return False
-        pos = end + 2
 
-    if not found_closing:
-        return False
+        pos = state.pos + 2
+        found_closing = False
+        while True:
+            try:
+                end = state.srcCharCode.index(end_char, pos)
+            except ValueError:
+                return False
+            try:
+                if state.srcCharCode[end + 1] == end_char:
+                    found_closing = True
+                    break
+            except IndexError:
+                return False
+            pos = end + 2
+
+        if not found_closing:
+            return False
 
-    text = state.src[state.pos + 2 : end].strip()
-    state.pos = end + 2
+        text = state.src[state.pos + 2 : end].strip()
+        state.pos = end + 2
 
-    if silent:
-        return True
+        if silent:
+            return True
 
-    token = state.push("substitution_inline", "span", 0)
-    token.block = False
-    token.content = text
-    token.attrSet("class", "substitution")
-    token.attrSet("text", text)
-    token.markup = "{{"
+        token = state.push("substitution_inline", "span", 0)
+        token.block = False
+        token.content = text
+        token.attrSet("class", "substitution")
+        token.attrSet("text", text)
+        token.markup = f"{start_delimiter}{end_delimiter}"
 
-    return True
+        return True
 
+    def _substitution_block(
+        state: StateBlock, startLine: int, endLine: int, silent: bool
+    ):
+        startPos = state.bMarks[startLine] + state.tShift[startLine]
+        end = state.eMarks[startLine]
 
-def _substitution_block(state: StateBlock, startLine: int, endLine: int, silent: bool):
-    startPos = state.bMarks[startLine] + state.tShift[startLine]
-    end = 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
+
+        lineText = state.src[startPos:end].strip()
 
-    # if it's indented more than 3 spaces, it should be a code block
-    if state.sCount[startLine] - state.blkIndent >= 4:
-        return False
+        try:
+            if (
+                lineText[0] != start_delimiter
+                or lineText[1] != start_delimiter
+                or lineText[-1] != end_delimiter
+                or lineText[-2] != end_delimiter
+                or len(lineText) < 5
+            ):
+                return False
+        except IndexError:
+            return False
 
-    lineText = state.src[startPos:end].strip()
+        text = lineText[2:-2].strip()
 
-    try:
-        if (
-            lineText[0] != "{"
-            or lineText[1] != "{"
-            or lineText[-1] != "}"
-            or lineText[-2] != "}"
-            or len(lineText) < 5
-        ):
+        # special case if multiple on same line, e.g. {{a}}{{b}}
+        if (end_delimiter * 2) in text:
             return False
-    except IndexError:
-        return False
 
-    text = lineText[2:-2].strip()
+        state.line = startLine + 1
 
-    # special case if multiple on same line, e.g. {{a}}{{b}}
-    if "}}" in text:
-        return False
+        if silent:
+            return True
 
-    state.line = startLine + 1
+        token = state.push("substitution_block", "div", 0)
+        token.block = True
+        token.content = text
+        token.attrSet("class", "substitution")
+        token.attrSet("text", text)
+        token.markup = f"{start_delimiter}{end_delimiter}"
+        token.map = [startLine, state.line]
 
-    if silent:
         return True
 
-    token = state.push("substitution_block", "div", 0)
-    token.block = True
-    token.content = text
-    token.attrSet("class", "substitution")
-    token.attrSet("text", text)
-    token.markup = "{{"
-    token.map = [startLine, state.line]
-
-    return True
+    md.block.ruler.before("fence", "substitution_block", _substitution_block)
+    md.inline.ruler.before("escape", "substitution_inline", _substitution_inline)

tests/test_substitution/test_tokens.yml

@@ -12,7 +12,7 @@
   map:
   - 0
   - 1
-  markup: '{{'
+  markup: '{}'
   meta: {}
   nesting: 0
   tag: div
@@ -60,7 +60,7 @@
     info: ''
     level: 0
     map: null
-    markup: '{{'
+    markup: '{}'
     meta: {}
     nesting: 0
     tag: span