tools: External markdowns are treated as internal links (#12)

Author: codeallthethingz

tools/github_readme_sync/hierarchy.py

@@ -149,6 +149,8 @@ def check_links(path):
     errors = []
 
     for match in md_link_matches:
+        if match[1].startswith(("http://", "https://", "mailto:")):
+            continue
         path_to_check = os.path.join(current_dir, match[1].split("#")[0])
         path_to_check = os.path.normpath(path_to_check)
         if any(placeholder in match[1] for placeholder in IGNORE_DOCS):

tools/github_readme_sync/tests/hierarchy_test.py

@@ -13,6 +13,7 @@
 import tempfile
 import threading
 import unittest
+from pathlib import Path
 
 from tools.github_readme_sync.hierarchy import (
     CATEGORY_PREFIX,
@@ -21,6 +22,7 @@
     INDENTATION_UNIT,
     check_external,
     check_hierarchy_file,
+    check_links,
     create_hierarchy_file,
     extract_links,
 )
@@ -233,6 +235,21 @@ def extract(input_string, expected_output):
             ["https://a.com/quotes"],
         )
 
+    def test_check_links_ignores_external(self):
+        """Test that check_links ignores external links (http/https/mailto)."""
+        with tempfile.NamedTemporaryFile(mode="w", suffix=".md", delete=False) as f:
+            f.write("""
+            [External Link](https://example.com/page.md)
+            [Another External](http://test.com/doc.md)
+            [Email Link](mailto:[email protected])
+            """)
+            temp_path = f.name
+
+        try:
+            self.assertEqual(check_links(temp_path), [])
+        finally:
+            Path(temp_path).unlink()
+
 
 if __name__ == "__main__":
     unittest.main()