HTML-escape filenames in include-markdown comments (#120)

* HTML-escape filenames in `include-markdown` comments * Bump version * Remove example * Test examples in CI
mondeja · Sep 7, 2022 · 0c5dba6 · 0c5dba6
1 parent 31be084
commit 0c5dba6
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 10 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.7.0
+current_version = 3.7.1
 
 [bumpversion:file:mkdocs_include_markdown_plugin/__init__.py]
 

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -42,6 +42,8 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           COVERALLS_SERVICE_NAME: github
+      - name: Test examples
+        run: pytest -svv tests/_test_examples.py
 
   build-sdist:
     if: startsWith(github.ref, 'refs/tags/')

diff --git a/mkdocs_include_markdown_plugin/__init__.py b/mkdocs_include_markdown_plugin/__init__.py
@@ -1,2 +1,2 @@
 __title__ = 'mkdocs_include_markdown_plugin'
-__version__ = '3.7.0'
+__version__ = '3.7.1'
diff --git a/mkdocs_include_markdown_plugin/event.py b/mkdocs_include_markdown_plugin/event.py
@@ -624,7 +624,7 @@ def found_include_markdown_tag(match):
             start_end_part += f"'{html.escape(end)}' " if end else "'' "
 
         return (
-            f'{_includer_indent}<!-- BEGIN INCLUDE {filename}'
+            f'{_includer_indent}<!-- BEGIN INCLUDE {html.escape(filename)}'
             f' {start_end_part}-->{separator}{text_to_include}'
             f'{separator}{_includer_indent}<!-- END INCLUDE -->'
         )

diff --git a/setup.cfg b/setup.cfg
@@ -1,6 +1,6 @@
 [metadata]
 name = mkdocs_include_markdown_plugin
-version = 3.7.0
+version = 3.7.1
 description = Mkdocs Markdown includer plugin.
 long_description = file: README.md
 long_description_content_type = text/markdown

diff --git a/tests/test_examples.py → tests/_test_examples.py b/tests/test_examples.py → tests/_test_examples.py
diff --git a/tests/test_arguments.py b/tests/test_arguments.py
@@ -10,13 +10,12 @@
 from testing_helpers import parametrize_directives
 
 
-WINDOWS_DOUBLE_QUOTES_PATHS_NOT_ALLOWED_REASON = (
-    'Double quotes are reserved characters not allowed for paths under Windows'
-)
-
 double_quotes_windows_path_skip = pytest.mark.skipif(
     sys.platform.startswith('win'),
-    reason=WINDOWS_DOUBLE_QUOTES_PATHS_NOT_ALLOWED_REASON,
+    reason=(
+        'Double quotes are reserved characters not allowed for'
+        ' paths under Windows'
+    ),
 )
 
 
@@ -25,7 +24,11 @@
     (
         pytest.param(
             'include',
-            ['preserve-includer-indent', 'dedent', 'trailing-newlines'],
+            [
+                'preserve-includer-indent',
+                'dedent',
+                'trailing-newlines',
+            ],
             id='include',
         ),
         pytest.param(