OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improved error reporting in social plugin

Browse Source
This commit is contained in:
squidfunk 2023-07-10 17:53:51 +01:00
parent b3ade9fd3a
commit 10b150112e
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
2 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
material/plugins/social/plugin.py
View File

@ -188,6 +188,22 @@ class SocialPlugin(BasePlugin[SocialPluginConfig]):
if "description" in page.meta: if "description" in page.meta:
description = page.meta["description"] 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 # Generate social card if not in cache - TODO: values from mkdocs.yml
hash = md5("".join([ hash = md5("".join([
site_name, site_name,

16
src/plugins/social/plugin.py
View File

@ -188,6 +188,22 @@ class SocialPlugin(BasePlugin[SocialPluginConfig]):
if "description" in page.meta: if "description" in page.meta:
description = page.meta["description"] 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 # Generate social card if not in cache - TODO: values from mkdocs.yml
hash = md5("".join([ hash = md5("".join([
site_name, site_name,