Raise SuperFencesException instead of silent fail on invalid JSON schema

Author: timvink

mkdocs_charts_plugin/fences.py

@@ -1,4 +1,5 @@
 from pymdownx.superfences import _escape
+from pymdownx.superfences import SuperFencesException
 
 from mkdocs.exceptions import PluginError
 
@@ -11,7 +12,7 @@ def fence_vegalite(source, language, class_name, options, md, **kwargs):
     """  # noqa
 
     if not _validateJSON(source):
-        raise PluginError(f"Your vegalite syntax is not valid JSON. Fix {source}")
+        raise SuperFencesException from PluginError(f"Your vegalite syntax is not valid JSON. Fix:\n\n{source}")
 
     classes = kwargs["classes"]
     id_value = kwargs["id_value"]

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="mkdocs-charts-plugin",
-    version="0.0.6",
+    version="0.0.7",
     description="MkDocs plugin to add charts from data",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -26,7 +26,7 @@
         "Programming Language :: Python :: 3.10",
         "License :: OSI Approved :: MIT License",
     ],
-    install_requires=["mkdocs>=1.1", "pymdown-extensions>=9.1"],
+    install_requires=["mkdocs>=1.1", "pymdown-extensions>=9.2"],
     packages=find_packages(),
     entry_points={
         "mkdocs.plugins": ["charts = mkdocs_charts_plugin.plugin:ChartsPlugin"]

tests/fixtures/projects/invalid_json/docs/index.md

@@ -5,10 +5,9 @@ For full documentation visit [mkdocs.org](https://www.mkdocs.org).
 
 ## charts on invalid json
 
+This one should give a plugin error because we can parse the JSOn in python (notice the trailing komma on the last line makes the JSON invalid):
 
-This one should give a plugin error because we can parse the JSOn in python (notice the trailing komma makes the JSON invalid):
-
-```chartvegalite
+```vegalite
 {
     "$schema": "https://vega.github.io/schema/vega-lite/v5.json",
     "data": {
@@ -29,5 +28,5 @@ This one should give a plugin error because we can parse the JSOn in python (not
         "contains": "padding",
         "resize": "true"
     }
-}
+},
 ```

tests/fixtures/projects/invalid_json/mkdocs.yml

@@ -6,7 +6,6 @@ site_name: My Docs
 #     - navigation.instant
 
 plugins:
-  # - search
   - charts:
       vega_theme: dark
       vega_renderer: "canvas"
@@ -20,7 +19,7 @@ markdown_extensions:
       custom_fences:
         - name: vegalite
           class: vegalite
-          format: !!python/name:mkdocs_charts_plugin.fence_vegalite_custom
+          format: !!python/name:mkdocs_charts_plugin.fences.fence_vegalite
   - pymdownx.tabbed:
       alternate_style: true 
 

tests/test_building.py

@@ -107,8 +107,7 @@ def test_basic_build(tmp_path):
     check_build(tmp_path, "basic/mkdocs.yml")
 
 
-@pytest.mark.skip(reason="Custom fences currently cannot raise errors")
-def test_error_invalid_json(tmp_path):
+def test_error_invalid_json(tmp_path, capsys):
     """
     Waiting for this feature.
 
@@ -117,8 +116,5 @@ def test_error_invalid_json(tmp_path):
     tmp_proj = setup_clean_mkdocs_folder(
         "tests/fixtures/projects/invalid_json/mkdocs.yml", tmp_path
     )
-
     result = build_docs_setup(tmp_proj)
-
     assert result.exit_code == 1
-    assert "Your vegalite syntax is not valid JSON." in result.output