mkdocs-include-markdown-plugin 6.2.2__tar.gz → 7.0.0__tar.gz

{mkdocs_include_markdown_plugin-6.2.2 → mkdocs_include_markdown_plugin-7.0.0}/.gitignore

@@ -16,5 +16,6 @@ venv*/
 .vscode
 .mypy_cache/
 *.so
+.prettier-cache
 
 site/

{mkdocs_include_markdown_plugin-6.2.2 → mkdocs_include_markdown_plugin-7.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mkdocs-include-markdown-plugin
-Version: 6.2.2
+Version: 7.0.0
 Summary: Mkdocs Markdown includer plugin.
 Project-URL: Source, https://github.com/mondeja/mkdocs-include-markdown-plugin
 Project-URL: Documentation, https://github.com/mondeja/mkdocs-include-markdown-plugin#documentation
@@ -17,7 +17,6 @@ Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -27,7 +26,7 @@ Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Text Processing
 Classifier: Topic :: Text Processing :: Markup :: Markdown
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Requires-Dist: mkdocs>=1.4
 Requires-Dist: wcmatch
 Provides-Extra: cache
@@ -204,10 +203,10 @@ content to include.
   are rewritten to work correctly in their new location. Possible values are
   `true` and `false`.
 - <a name="include-markdown_comments" href="#include-markdown_comments">#</a>
-  **comments** (_true_): When this option is enabled (default), the content to
-  include is wrapped by `<!-- BEGIN INCLUDE -->` and `<!-- END INCLUDE -->`
-  comments which help to identify that the content has been included. Possible
-  values are `true` and `false`.
+  **comments** (_false_): When this option is enabled, the content to include
+  is wrapped by `<!-- BEGIN INCLUDE -->` and `<!-- END INCLUDE -->` comments
+  which help to identify that the content has been included. Possible values
+  are `true` and `false`.
 - <a name="include-markdown_heading-offset" href="#include-markdown_heading-offset">#</a>
   **heading-offset** (0): Increases or decreases the Markdown headings depth
   by this number. Only supports number sign (`#`) heading syntax. Accepts
@@ -229,7 +228,7 @@ content to include.
     start='<!--\n\ttable-start\n-->'
     end='<!--\n\ttable-end\n-->'
     rewrite-relative-urls=false
-    comments=false
+    comments=true
 %}
 ```
 

{mkdocs_include_markdown_plugin-6.2.2 → mkdocs_include_markdown_plugin-7.0.0}/README.md

@@ -168,10 +168,10 @@ content to include.
   are rewritten to work correctly in their new location. Possible values are
   `true` and `false`.
 - <a name="include-markdown_comments" href="#include-markdown_comments">#</a>
-  **comments** (_true_): When this option is enabled (default), the content to
-  include is wrapped by `<!-- BEGIN INCLUDE -->` and `<!-- END INCLUDE -->`
-  comments which help to identify that the content has been included. Possible
-  values are `true` and `false`.
+  **comments** (_false_): When this option is enabled, the content to include
+  is wrapped by `<!-- BEGIN INCLUDE -->` and `<!-- END INCLUDE -->` comments
+  which help to identify that the content has been included. Possible values
+  are `true` and `false`.
 - <a name="include-markdown_heading-offset" href="#include-markdown_heading-offset">#</a>
   **heading-offset** (0): Increases or decreases the Markdown headings depth
   by this number. Only supports number sign (`#`) heading syntax. Accepts
@@ -193,7 +193,7 @@ content to include.
     start='<!--\n\ttable-start\n-->'
     end='<!--\n\ttable-end\n-->'
     rewrite-relative-urls=false
-    comments=false
+    comments=true
 %}
 ```
 

{mkdocs_include_markdown_plugin-6.2.2 → mkdocs_include_markdown_plugin-7.0.0}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "mkdocs-include-markdown-plugin"
-version = "6.2.2"
+version = "7.0.0"
 description = "Mkdocs Markdown includer plugin."
 readme = "README.md"
 license = "Apache-2.0"
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 classifiers = [
   "Development Status :: 5 - Production/Stable",
   "Operating System :: OS Independent",
@@ -15,7 +15,6 @@ classifiers = [
   "Topic :: Text Processing",
   "Topic :: Text Processing :: Markup :: Markdown",
   "Environment :: Console",
-  "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
@@ -74,7 +73,7 @@ matrix-name-format = "{variable}-{value}"
 dependencies = ["pytest~=7.0", "coverage~=6.4", "covdefaults"]
 
 [[tool.hatch.envs.tests.matrix]]
-python = ["py38", "py39", "py310", "py311", "py312", "py313"]
+python = ["py39", "py310", "py311", "py312", "py313"]
 mkdocs = ["1.4.0", "1.4.3", "1.5.0", "1.5.3", "1.6.0"]
 cache = ["yes", "no"]
 
@@ -105,9 +104,9 @@ targets = [{ file = "pyproject.toml" }]
 [tool.project-config]
 cache = "2 days"
 style = [
-  "gh://mondeja/project-config-styles@v5.3/base/pre-commit/md2po2md.json5",
-  "gh://mondeja/project-config-styles@v5.3/python/base.json5",
-  "gh://mondeja/project-config-styles@v5.3/python/mypy.json5",
+  "gh://mondeja/project-config-styles@v5.4/base/pre-commit/md2po2md.json5",
+  "gh://mondeja/project-config-styles@v5.4/python/base.json5",
+  "gh://mondeja/project-config-styles@v5.4/python/mypy.json5",
 ]
 
 [tool.coverage.run]
@@ -122,7 +121,7 @@ fail_under = 1
 
 [tool.ruff]
 line-length = 80
-target-version = "py38"
+target-version = "py39"
 
 [tool.ruff.lint]
 select = [

{mkdocs_include_markdown_plugin-6.2.2 → mkdocs_include_markdown_plugin-7.0.0}/src/mkdocs_include_markdown_plugin/config.py

@@ -17,7 +17,7 @@ class PluginConfig(Config):  # noqa: D101
     preserve_includer_indent = MkType(bool, default=True)
     dedent = MkType(bool, default=False)
     trailing_newlines = MkType(bool, default=True)
-    comments = MkType(bool, default=True)
+    comments = MkType(bool, default=False)
     rewrite_relative_urls = MkType(bool, default=True)
     heading_offset = MkType(int, default=0)
     start = Optional(MkType(str))

{mkdocs_include_markdown_plugin-6.2.2 → mkdocs_include_markdown_plugin-7.0.0}/src/mkdocs_include_markdown_plugin/process.py

@@ -114,7 +114,7 @@ MARKDOWN_LINK_DEFINITION_REGEX = re.compile(
 )
 
 
-def transform_p_by_p_skipping_codeblocks(
+def transform_p_by_p_skipping_codeblocks(  # noqa: PLR0912, PLR0915
         markdown: str,
         func: Callable[[str], str],
 ) -> str:
@@ -128,45 +128,80 @@ def transform_p_by_p_skipping_codeblocks(
     _current_fcodeblock_delimiter = ''
 
     # inside indented codeblock
-    _inside_icodeblock = False
+    _maybe_icodeblock_lines: list[str] = []
+    _previous_line_was_empty = False
 
     lines, current_paragraph = ([], '')
 
     def process_current_paragraph() -> None:
         lines.extend(func(current_paragraph).splitlines(keepends=True))
 
+    # The next implementation takes into account that indented code
+    # blocks must be surrounded by newlines as per the CommonMark
+    # specification. See https://spec.commonmark.org/0.28/#indented-code-blocks
+    #
+    # However, note that ambiguities with list items are not handled.
+
     for line in io.StringIO(markdown):
-        if not _current_fcodeblock_delimiter and not _inside_icodeblock:
+        if not _current_fcodeblock_delimiter:
             lstripped_line = line.lstrip()
             if (
                 lstripped_line.startswith('```')
                 or lstripped_line.startswith('~~~')
             ):
                 _current_fcodeblock_delimiter = lstripped_line[:3]
-                if current_paragraph:
-                    process_current_paragraph()
-                    current_paragraph = ''
+                process_current_paragraph()
+                current_paragraph = ''
                 lines.append(line)
-            elif (
-                line.replace('\t', '    ').replace('\r\n', '\n')
-                == '    \n'
-            ):
-                _inside_icodeblock = True
-                if current_paragraph:
+            elif line.startswith('    '):
+                if not lstripped_line or _maybe_icodeblock_lines:
+                    # maybe enter indented codeblock
+                    _maybe_icodeblock_lines.append(line)
+                else:
+                    current_paragraph += line
+            elif _maybe_icodeblock_lines:
+                process_current_paragraph()
+                current_paragraph = ''
+                if not _previous_line_was_empty:
+                    # wasn't an indented code block
+                    for line_ in _maybe_icodeblock_lines:
+                        current_paragraph += line_
+                    _maybe_icodeblock_lines = []
+                    current_paragraph += line
                     process_current_paragraph()
                     current_paragraph = ''
-                lines.append(line)
+                else:
+                    # exit indented codeblock
+                    for line_ in _maybe_icodeblock_lines:
+                        lines.append(line_)
+                    _maybe_icodeblock_lines = []
+                    lines.append(line)
             else:
                 current_paragraph += line
+            _previous_line_was_empty = not lstripped_line
         else:
             lines.append(line)
-            if _current_fcodeblock_delimiter:
-                if line.lstrip().startswith(_current_fcodeblock_delimiter):
-                    _current_fcodeblock_delimiter = ''
-            elif not line.startswith('    ') and not line.startswith('\t'):
-                _inside_icodeblock = False
-
-    process_current_paragraph()
+            lstripped_line = line.lstrip()
+            if lstripped_line.startswith(_current_fcodeblock_delimiter):
+                _current_fcodeblock_delimiter = ''
+            _previous_line_was_empty = not lstripped_line
+
+    if _maybe_icodeblock_lines:
+        if not _previous_line_was_empty:
+            # at EOF
+            process_current_paragraph()
+            current_paragraph = ''
+            for line_ in _maybe_icodeblock_lines:
+                current_paragraph += line_
+            process_current_paragraph()
+            current_paragraph = ''
+        else:
+            process_current_paragraph()
+            current_paragraph = ''
+            for line_ in _maybe_icodeblock_lines:
+                lines.append(line_)
+    else:
+        process_current_paragraph()
 
     return ''.join(lines)
 
@@ -180,7 +215,7 @@ def transform_line_by_line_skipping_codeblocks(
     Skip fenced codeblock lines, where the transformation never is applied.
 
     Indented codeblocks are not taken into account because in the practice
-    this function is never used for transformations on indented lines. See
+    this function is only used for transformations of heading prefixes. See
     the PR https://github.com/mondeja/mkdocs-include-markdown-plugin/pull/95
     to recover the implementation handling indented codeblocks.
     """
@@ -269,6 +304,7 @@ def rewrite_relative_urls(
             functools.partial(found_href, url_group_index=2),
             paragraph,
         )
+
     return transform_p_by_p_skipping_codeblocks(
         markdown,
         transform,