Cleanups and rename outdated variables

Author: brunobeltran

mdformat_myst/_directives.py

@@ -17,7 +17,14 @@
 
 def longest_consecutive_sequence(seq: str, char: str) -> int:
     """Return length of the longest consecutive sequence of `char` characters
-    in string `seq`."""
+    in string `seq`.
+
+    This measured faster than the more "Pythonic"
+
+    ```
+    max((len(list(g)) for k, g in groupby(s) if k == char), default=0)
+    ```
+    """
     assert len(char) == 1
     longest = 0
     current_streak = 0
@@ -34,15 +41,16 @@ def longest_consecutive_sequence(seq: str, char: str) -> int:
 def fence(node: "RenderTreeNode", context: "RenderContext") -> str:
     """Render fences (and directives).
 
-    Copied from upstream `mdformat` core and should be kept up-to-date
-    if upstream introduces changes. Note that only two lines are added
-    to the upstream implementation, i.e. the condition that calls
-    `format_directive_content` function.
+    Originally copied from upstream `mdformat` core. Key changes so far:
+    - call our `format_directive_content` function when a directive is detected (instead
+      of treating the contents as code in that case).
+    - allow colon fences (and use a heuristic to ensure good spacing when recombining
+      those).
     """
     info_str = node.info.strip()
     lang = info_str.split(maxsplit=1)[0] if info_str else ""
     is_directive = lang.startswith("{") and lang.endswith("}")
-    code_block = node.content
+    unformatted_body = node.content
 
     # Info strings of backtick code fences can not contain backticks or tildes.
     # If that is the case, we make a tilde code fence instead.
@@ -53,11 +61,12 @@ def fence(node: "RenderTreeNode", context: "RenderContext") -> str:
     else:
         fence_char = "`"
 
-    # Format the code block using enabled codeformatter funcs
-    if lang in context.options.get("codeformatters", {}):
+    if is_directive:
+        body = format_directive_content(unformatted_body, context=context)
+    elif lang in context.options.get("codeformatters", {}):
         fmt_func = context.options["codeformatters"][lang]
         try:
-            code_block = fmt_func(code_block, info_str)
+            body = fmt_func(unformatted_body, info_str)
         except Exception:
             # Swallow exceptions so that formatter errors (e.g. due to
             # invalid code) do not crash mdformat.
@@ -66,18 +75,20 @@ def fence(node: "RenderTreeNode", context: "RenderContext") -> str:
                 f"Failed formatting content of a {lang} code block "
                 f"(line {node.map[0] + 1} before formatting)"
             )
-    # This "elif" is the *only* thing added to the upstream `fence` implementation!
-    elif is_directive:
-        code_block = format_directive_content(code_block, context=context)
+            body = unformatted_body
+    else:
+        body = unformatted_body
 
-    # The code block must not include as long or longer sequence of `fence_char`s
-    # as the fence string itself
-    fence_len = max(3, longest_consecutive_sequence(code_block, fence_char) + 1)
+    # The fenced contents must not include as long or longer sequence of `fence_char`s
+    # as the fence string itself.
+    fence_len = max(3, longest_consecutive_sequence(body, fence_char) + 1)
     fence_str = fence_char * fence_len
     formatted_fence = f"{fence_str}{info_str}\n"
-    if code_block.startswith(":::"):
+    # Heuristic to ensure child colon fences recombine with a leading blank line for
+    # consistency.
+    if body.startswith(":::"):
         formatted_fence += "\n"
-    formatted_fence += f"{code_block}{fence_str}"
+    formatted_fence += f"{body}{fence_str}"
     return formatted_fence
 
 

mdformat_myst/plugin.py

@@ -18,23 +18,16 @@
 
 
 def update_mdit(mdit: MarkdownIt) -> None:
-    # Enable mdformat-tables plugin
-    tables_plugin = mdformat.plugins.PARSER_EXTENSIONS["tables"]
-    if tables_plugin not in mdit.options["parser_extension"]:
-        mdit.options["parser_extension"].append(tables_plugin)
-        tables_plugin.update_mdit(mdit)
-
-    # Enable mdformat-front-matters plugin
-    front_matters_plugin = mdformat.plugins.PARSER_EXTENSIONS["front_matters"]
-    if front_matters_plugin not in mdit.options["parser_extension"]:
-        mdit.options["parser_extension"].append(front_matters_plugin)
-        front_matters_plugin.update_mdit(mdit)
-
-    # Enable mdformat-footnote plugin
-    footnote_plugin = mdformat.plugins.PARSER_EXTENSIONS["footnote"]
-    if footnote_plugin not in mdit.options["parser_extension"]:
-        mdit.options["parser_extension"].append(footnote_plugin)
-        footnote_plugin.update_mdit(mdit)
+    plugins_to_enable = [
+        "tables",
+        "front_matters",
+        "footnote",
+    ]
+    for plugin_name in plugins_to_enable:
+        plugin = mdformat.plugins.PARSER_EXTENSIONS[plugin_name]
+        if plugin not in mdit.options["parser_extension"]:
+            mdit.options["parser_extension"].append(plugin)
+            plugin.update_mdit(mdit)
 
     # Enable MyST role markdown-it extension
     mdit.use(myst_role_plugin)