Improved error reporting in social plugin

squidfunk · Jul 10, 2023 · 10b1501 · 10b1501
1 parent b3ade9f
commit 10b1501
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/material/plugins/social/plugin.py b/material/plugins/social/plugin.py
@@ -188,6 +188,22 @@ def on_page_markdown(self, markdown, page, config, files):
         if "description" in page.meta:
             description = page.meta["description"]
 
+        # Check type of meta title - see https://t.ly/m1Us
+        if not isinstance(title, str):
+            log.error(
+                f"Page meta title of page '{page.file.src_uri}' must be a "
+                f"string, but is of type \"{type(title)}\"."
+            )
+            sys.exit(1)
+
+        # Check type of meta description - see https://t.ly/m1Us
+        if not isinstance(description, str):
+            log.error(
+                f"Page meta description of '{page.file.src_uri}' must be a "
+                f"string, but is of type \"{type(description)}\"."
+            )
+            sys.exit(1)
+
         # Generate social card if not in cache - TODO: values from mkdocs.yml
         hash = md5("".join([
             site_name,

diff --git a/src/plugins/social/plugin.py b/src/plugins/social/plugin.py
@@ -188,6 +188,22 @@ def on_page_markdown(self, markdown, page, config, files):
         if "description" in page.meta:
             description = page.meta["description"]
 
+        # Check type of meta title - see https://t.ly/m1Us
+        if not isinstance(title, str):
+            log.error(
+                f"Page meta title of page '{page.file.src_uri}' must be a "
+                f"string, but is of type \"{type(title)}\"."
+            )
+            sys.exit(1)
+
+        # Check type of meta description - see https://t.ly/m1Us
+        if not isinstance(description, str):
+            log.error(
+                f"Page meta description of '{page.file.src_uri}' must be a "
+                f"string, but is of type \"{type(description)}\"."
+            )
+            sys.exit(1)
+
         # Generate social card if not in cache - TODO: values from mkdocs.yml
         hash = md5("".join([
             site_name,