fix(#45): do not wrap attribute lists

Author: KyleKing

mdformat_mkdocs/mdit_plugins/__init__.py

@@ -17,6 +17,10 @@
 from ._pymd_abbreviations import PYMD_ABBREVIATIONS_PREFIX, pymd_abbreviations_plugin
 from ._pymd_admon import pymd_admon_plugin
 from ._pymd_snippet import PYMD_SNIPPET_PREFIX, pymd_snippet_plugin
+from ._python_markdown_attr_list import (
+    PYTHON_MARKDOWN_ATTR_LIST_PREFIX,
+    python_markdown_attr_list_plugin,
+)
 
 __all__ = (
     "MATERIAL_ADMON_MARKERS",
@@ -26,11 +30,13 @@
     "MKDOCSTRINGS_HEADING_AUTOREFS_PREFIX",
     "PYMD_ABBREVIATIONS_PREFIX",
     "PYMD_SNIPPET_PREFIX",
+    "PYTHON_MARKDOWN_ATTR_LIST_PREFIX",
     "material_admon_plugin",
     "material_content_tabs_plugin",
     "mkdocstrings_autorefs_plugin",
     "mkdocstrings_crossreference_plugin",
     "pymd_abbreviations_plugin",
     "pymd_admon_plugin",
     "pymd_snippet_plugin",
+    "python_markdown_attr_list_plugin",
 )

mdformat_mkdocs/mdit_plugins/_pymd_snippet.py

@@ -1,12 +1,12 @@
-"""Python-Markdown Snippets.
+"""Python-Markdown Extensions: Snippets.
 
 WARNING: matches only the "scissors" portion, leaving the rest unparsed
 
 ```md
 --8<-- ...
 ```
 
-Docs: <https://facelessuser.github.io/pymd-extensions/extensions/snippets>
+Docs: <https://facelessuser.github.io/pymdown-extensions/extensions/snippets>
 
 """
 

mdformat_mkdocs/mdit_plugins/_python_markdown_attr_list.py

@@ -0,0 +1,59 @@
+"""Python-Markdown: Attribute List.
+
+WARNING: does not properly render HTML with the attributes and does not respect escaping '\{ '
+
+Docs: <https://python-markdown.github.io/extensions/attr_list>
+
+"""
+
+from __future__ import annotations
+
+import re
+from typing import TYPE_CHECKING
+
+from markdown_it import MarkdownIt
+
+from mdformat_mkdocs._synced.admon_factories import new_token
+
+if TYPE_CHECKING:
+    from markdown_it import MarkdownIt
+    from markdown_it.rules_inline import StateInline
+
+_ATTR_LIST_PATTERN = re.compile(r"{:? (?P<attrs>[^}]+) }")
+
+PYTHON_MARKDOWN_ATTR_LIST_PREFIX = "python_markdown_attr_list"
+
+
+def _python_markdown_attr_list(state: StateInline, silent: bool) -> bool:
+    match = _ATTR_LIST_PATTERN.match(state.src[state.pos : state.posMax])
+    if not match:
+        return False
+
+    if state.pos > 0 and state.src[state.pos - 1] == "\\":
+        return False
+
+    if silent:
+        return True
+
+    original_pos = state.pos
+    original_pos_max = state.posMax
+    state.pos += 1
+    state.posMax = state.pos + (match.end() - len(" }"))
+    with new_token(state, PYTHON_MARKDOWN_ATTR_LIST_PREFIX, "span") as token:
+        token.attrs = {"attributes": match["attrs"].split(" ")}
+        token.meta = {"content": match.group()}
+
+        state.md.inline.tokenize(state)
+
+    state.pos = original_pos
+    state.posMax = original_pos_max
+    state.pos += match.end()
+
+    return True
+
+
+def python_markdown_attr_list_plugin(md: MarkdownIt) -> None:
+    md.inline.ruler.push(
+        PYTHON_MARKDOWN_ATTR_LIST_PREFIX,
+        _python_markdown_attr_list,
+    )

mdformat_mkdocs/plugin.py

@@ -17,13 +17,15 @@
     MKDOCSTRINGS_HEADING_AUTOREFS_PREFIX,
     PYMD_ABBREVIATIONS_PREFIX,
     PYMD_SNIPPET_PREFIX,
+    PYTHON_MARKDOWN_ATTR_LIST_PREFIX,
     material_admon_plugin,
     material_content_tabs_plugin,
     mkdocstrings_autorefs_plugin,
     mkdocstrings_crossreference_plugin,
     pymd_abbreviations_plugin,
     pymd_admon_plugin,
     pymd_snippet_plugin,
+    python_markdown_attr_list_plugin,
 )
 
 if TYPE_CHECKING:
@@ -79,8 +81,9 @@ def update_mdit(mdit: MarkdownIt) -> None:
     mdit.use(material_content_tabs_plugin)
     mdit.use(mkdocstrings_autorefs_plugin)
     mdit.use(pymd_abbreviations_plugin)
-    mdit.use(pymd_snippet_plugin)
     mdit.use(pymd_admon_plugin)
+    mdit.use(pymd_snippet_plugin)
+    mdit.use(python_markdown_attr_list_plugin)
 
     if cli_is_ignore_missing_references(mdit.options):
         mdit.use(mkdocstrings_crossreference_plugin)
@@ -187,10 +190,11 @@ def add_extra_admon_newline(node: RenderTreeNode, context: RenderContext) -> str
     "content_tab_mkdocs": add_extra_admon_newline,
     "content_tab_mkdocs_title": render_admon_title,
     MKDOCSTRINGS_AUTOREFS_PREFIX: _render_meta_content,
-    MKDOCSTRINGS_HEADING_AUTOREFS_PREFIX: _render_heading_autoref,
     MKDOCSTRINGS_CROSSREFERENCE_PREFIX: _render_cross_reference,
+    MKDOCSTRINGS_HEADING_AUTOREFS_PREFIX: _render_heading_autoref,
     PYMD_ABBREVIATIONS_PREFIX: _render_inline_content,
     PYMD_SNIPPET_PREFIX: _render_inline_content,
+    PYTHON_MARKDOWN_ATTR_LIST_PREFIX: _render_meta_content,
 }
 
 

pyproject.toml

@@ -140,6 +140,9 @@ known-first-party = ['mdformat_mkdocs', 'tests']
   'PT004', # flake8-pytest-style: fixture does not return
   'S101', # Use of `assert` detected
 ]
+'tests/format/test_wrap.py' = [
+  'E501', # Line too long (122 > 88)
+]
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"

tests/format/fixtures/python_markdown_attr_list.md

@@ -0,0 +1,33 @@
+Examples from https://python-markdown.github.io/extensions/attr_list
+.
+{: #someid .someclass somekey='some value' #id1 .class1 id=id2 class="class2 class3" .class4 }
+
+\{ not an attribute list, but not escaped because '\' is dropped during read_fixture_file }
+
+{ #someid .someclass somekey='some value' }
+
+This is a paragraph.
+{: #an_id .a_class }
+
+A setext style header {: #setext}
+=================================
+
+### A hash style header ### {: #hash }
+
+[link](http://example.com){: class="foo bar" title="Some title!" }
+.
+{: #someid .someclass somekey='some value' #id1 .class1 id=id2 class="class2 class3" .class4 }
+
+{ not an attribute list, but not escaped because '' is dropped during read_fixture_file }
+
+{ #someid .someclass somekey='some value' }
+
+This is a paragraph.
+{: #an_id .a_class }
+
+# A setext style header {: #setext}
+
+### A hash style header ### {: #hash }
+
+[link](http://example.com){: class="foo bar" title="Some title!" }
+.

tests/format/test_format.py

@@ -25,6 +25,7 @@ def flatten(nested_list: list[list[T]]) -> list[T]:
             "mkdocstrings_autorefs.md",
             "pymd_abbreviations.md",
             "pymd_snippet.md",
+            "python_markdown_attr_list.md",
             "text.md",
         )
     ],

tests/format/test_wrap.py

@@ -147,6 +147,38 @@
 
 """
 
+WITH_ATTR_LIST = r"""
+{: #someid .someclass somekey='some value' #id1 .class1 id=id2 class="class2 class3" .class4 }
+
+\\{ not an attribute list and should be wrapped at 80 characters and not kept inline }
+
+This is a long paragraph that is more than 80 characters long and should be wrapped.
+{: #an_id .a_class  #an_id .a_class  #an_id .a_class  #an_id .a_class  #an_id .a_class  #an_id .a_class  #an_id .a_class }
+
+A setext style header {: #setext}
+=================================
+
+### A hash style header ### {: #hash }
+
+[link](http://example.com){: class="foo bar" title="Some title!" .a_class1 .a_class2 .a_class1 .a_class2 .a_class1 .a_class2 }
+"""
+WITH_ATTR_LIST_TRUE_80 = r"""
+{: #someid .someclass somekey='some value' #id1 .class1 id=id2 class="class2 class3" .class4 }
+
+\\{ not an attribute list and should be wrapped at 80 characters and not kept
+inline }
+
+This is a long paragraph that is more than 80 characters long and should be
+wrapped.
+{: #an_id .a_class  #an_id .a_class  #an_id .a_class  #an_id .a_class  #an_id .a_class  #an_id .a_class  #an_id .a_class }
+
+# A setext style header {: #setext}
+
+### A hash style header ### {: #hash }
+
+[link](http://example.com){: class="foo bar" title="Some title!" .a_class1 .a_class2 .a_class1 .a_class2 .a_class1 .a_class2 }
+"""
+
 
 @pytest.mark.parametrize(
     ("text", "expected", "align_lists", "wrap"),
@@ -157,6 +189,7 @@
         (CASE_1, CASE_1_TRUE_80, True, 80),
         (TICKET_020, TICKET_020_TRUE_79, True, 79),
         (WITH_CODE, WITH_CODE_TRUE_80, True, 80),
+        (WITH_ATTR_LIST, WITH_ATTR_LIST_TRUE_80, True, 80),
     ],
     ids=[
         "CASE_1_FALSE_40",
@@ -165,6 +198,7 @@
         "CASE_1_TRUE_80",
         "TICKET_020_TRUE_79",
         "WITH_CODE_TRUE_80",
+        "WITH_ATTR_LIST_TRUE_80",
     ],
 )
 def test_wrap(text: str, expected: str, align_lists: bool, wrap: int):