feat: restore mdformat-gfm dependency

KyleKing · Jan 30, 2024 · 32cf4e1 · 32cf4e1
1 parent a98730f
commit 32cf4e1
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 181 deletions.
diff --git a/mdformat_mkdocs/_copy_of_mdformat_gfm/__init__.py b/mdformat_mkdocs/_copy_of_mdformat_gfm/__init__.py
diff --git a/mdformat_mkdocs/_copy_of_mdformat_gfm/plugin.py b/mdformat_mkdocs/_copy_of_mdformat_gfm/plugin.py
diff --git a/mdformat_mkdocs/plugin.py b/mdformat_mkdocs/plugin.py
@@ -10,7 +10,6 @@
 from mdformat.renderer.typing import Postprocess, Render
 from mdformat_admon import RENDERERS as ADMON_RENDERS  # type: ignore[import-untyped]
 
-from ._copy_of_mdformat_gfm import GFM_POSTPROCESSORS, GFM_RENDERERS, gfm_update_mdit
 from ._normalize_list import normalize_list as unbounded_normalize_list
 from ._postprocess_inline import postprocess_inline
 from .mdit_plugins import content_tabs_plugin, mkdocs_admon_plugin
@@ -44,9 +43,6 @@ def update_mdit(mdit: MarkdownIt) -> None:
         False,
     )
 
-    # HACK: Only temporary pending the mdformat-gfm release
-    gfm_update_mdit(mdit)
-
 
 # A mapping from `RenderTreeNode.type` to a `Render` function that can
 # render the given `RenderTreeNode` type. These override the default
@@ -56,7 +52,6 @@ def update_mdit(mdit: MarkdownIt) -> None:
     "admonition_mkdocs_title": ADMON_RENDERS["admonition_title"],
     "content_tab_mkdocs": ADMON_RENDERS["admonition"],
     "content_tab_mkdocs_title": ADMON_RENDERS["admonition_title"],
-    **GFM_RENDERERS,  # HACK: Only temporary pending the mdformat-gfm release
 }
 
 
@@ -79,5 +74,4 @@ def check_if_align_semantic_breaks_in_lists() -> bool:
     "bullet_list": normalize_list,
     "inline": postprocess_inline,
     "ordered_list": normalize_list,
-    **GFM_POSTPROCESSORS,  # HACK: Only temporary pending the mdformat-gfm release
 }
diff --git a/pyproject.toml b/pyproject.toml
@@ -19,10 +19,8 @@ requires-python = ">=3.8.4"
 dependencies = [
     "mdformat >= 0.7.16",
     "mdformat-admon >= 2.0.1",
-    "more-itertools >= 10.2.0",
-    # "mdformat-gfm >= 0.4.0", TODO: Pending release (https://github.com/hukkin/mdformat-gfm/issues/31)
-    "markdown-it-py[linkify] >= 3.0.0 ",  # HACK: Only temporary pending the mdformat-gfm release
-    "mdformat-tables >= 0.4.1",  # HACK: Only temporary pending the mdformat-gfm release
+    "mdformat-gfm >= 0.3.6",
+    "more-itertools >= 10.2.0"
 ]
 dynamic = ["version", "description"]
 

diff --git a/tests/fixtures-semantic-indent.md b/tests/fixtures-semantic-indent.md
@@ -258,9 +258,9 @@ Table
 |:---------------|---------:|:---------------------|
 | Name           |         2| <!-- Comment -->     |
 .
-| Label | Rating | Comment          |
-| :---- | -----: | :--------------- |
-| Name  |      2 | <!-- Comment --> |
+| Label          |   Rating | Comment              |
+|:---------------|---------:|:---------------------|
+| Name           |         2| <!-- Comment -->     |
 .
 
 Floating Link
@@ -306,8 +306,8 @@ Task List / Check List (WARN: escaping is prevented by mdformat-gfm. Tested by p
 - [x] #739
   - [ ] Add delight to the experience when all tasks are complete :tada:
 .
-- [x] #739
-    - [ ] Add delight to the experience when all tasks are complete :tada:
+- \[x\] #739
+    - \[ \] Add delight to the experience when all tasks are complete :tada:
 .
 
 Footnotes (WARN: escaping is prevented by mdformat-gfm. Tested by py#-hook)

diff --git a/tests/format/fixtures/text.md b/tests/format/fixtures/text.md
@@ -251,15 +251,15 @@ Nested semantic lines (https://github.com/KyleKing/mdformat-mkdocs/issues/7)
 .
 
 
-Table (with GFM formatting)
+Table
 .
 | Label          |   Rating | Comment              |
 |:---------------|---------:|:---------------------|
 | Name           |         2| <!-- Comment -->     |
 .
-| Label | Rating | Comment          |
-| :---- | -----: | :--------------- |
-| Name  |      2 | <!-- Comment --> |
+| Label          |   Rating | Comment              |
+|:---------------|---------:|:---------------------|
+| Name           |         2| <!-- Comment -->     |
 .
 
 Floating Link
@@ -300,13 +300,13 @@ Headings
 ###### \[h6\] The smallest heading
 .
 
-Task List / Check List (temporarily fixed with mdformat-gfm HACK)
+Task List / Check List (WARN: escaping is prevented by mdformat-gfm. Tested by py#-hook)
 .
 - [x] #739
   - [ ] Add delight to the experience when all tasks are complete :tada:
 .
-- [x] #739
-    - [ ] Add delight to the experience when all tasks are complete :tada:
+- \[x\] #739
+    - \[ \] Add delight to the experience when all tasks are complete :tada:
 .
 
 Footnotes (WARN: escaping is prevented by mdformat-gfm. Tested by py#-hook)

diff --git a/tests/pre-commit-test-numbered.md b/tests/pre-commit-test-numbered.md
@@ -6,6 +6,6 @@
     list item 2
 2. If you store artifacts in the
     repository, you need to remember to
-    compile the application before every
-    commit.
+    compile the application before
+    every commit.
 3. Compiled application.
diff --git a/tests/test_wrap.py b/tests/test_wrap.py
@@ -25,7 +25,8 @@
 # Content
 
 - Test Testing Test Testing Test Testing
-    Test Testing Test Testing Test Testing
+    Test Testing Test Testing Test
+    Testing
     - Test Testing Test Testing Test
         Testing Test Testing Test Testing
         Test Testing Test Testing Test
@@ -58,7 +59,8 @@
 # Content
 
 - Test Testing Test Testing Test Testing
-  Test Testing Test Testing Test Testing
+  Test Testing Test Testing Test
+  Testing
     - Test Testing Test Testing Test
       Testing Test Testing Test Testing
       Test Testing Test Testing Test