Fixed a bug where using an alias with the word text would fail

Author: EddyLuten

README.md

@@ -158,6 +158,10 @@ pylint $(git ls-files '*.py') && pytest -vv
 
 ## Changelog
 
+### 0.7.1
+
+**Bug Fix:** fixes a bug where any alias with the word "text" would break the plugin due to faulty logic. Reported in [#7](https://github.com/EddyLuten/mkdocs-alias-plugin/issues/7)
+
 ### 0.7.0
 
 2024-02-01

alias/plugin.py

@@ -150,7 +150,8 @@ def on_files(self, files, **_):
                         'alias': alias,
                         'text': (
                             meta_data['alias']['text']
-                            if 'text' in meta_data['alias']
+                            # if meta_data['alias'] is a dictionary and 'text' is a key
+                            if isinstance(meta_data['alias'], dict) and 'text' in meta_data['alias']
                             else get_page_title(source, meta_data)
                         ),
                         'url': file.src_uri,

setup.py

@@ -7,7 +7,7 @@
 
 setup(
     name='mkdocs-alias-plugin',
-    version='0.7.0',
+    version='0.7.1',
     description=
     'An MkDocs plugin allowing links to your pages using a custom alias',
     long_description=long_description,

test_plugin.py

@@ -222,3 +222,19 @@ def test_replace_tag_with_anchor3():
         markdown
     )
     assert result == 'Test: [The Title](../../../my-alias.md#my anchor)'
+
+def test_plugin_shouldnt_break_with_text():
+    """An alias with the word 'text' in it shouldn't break the plugin"""
+    logger = logging.getLogger()
+    aliases = { 'text': {
+        'text': 'The Text',
+        'alias': 'text',
+        'url': 'my-alias.md'
+    } }
+    markdown = 'Test: [[text]]'
+    result = re.sub(
+        ALIAS_TAG_REGEX,
+        lambda match: replace_tag(match, aliases, logger, PAGE_FILE),
+        markdown
+    )
+    assert result == 'Test: [The Text](../../../my-alias.md)'