Checking that internally-defined links resolve.

An internally-defined Markdown link has the form [xxx][yyy]. If the ID 'yyy' doesn't resolve, the text is left as-is, so we check for that, then subtract those that reference configuration values using '{{'. It's a hack, but it'll catch at least a few things.
Boukos · Jul 24, 2016 · cebd855 · cebd855
1 parent 9be4b22
commit cebd855
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/bin/lesson_check.py b/bin/lesson_check.py
@@ -47,6 +47,9 @@
 # Pattern to match figure references in HTML.
 P_FIGURE_REFS = re.compile(r'<img[^>]+src="([^"]+)"[^>]*>')
 
+# Pattern to match internally-defined Markdown links.
+P_INTERNALLY_DEFINED_LINK = re.compile(r'\[[^\]]+\]\[[^\]]+\]')
+
 # What kinds of blockquotes are allowed?
 KNOWN_BLOCKQUOTES = {
     'callout',
@@ -274,6 +277,7 @@ def check(self):
         self.check_trailing_whitespace()
         self.check_blockquote_classes()
         self.check_codeblock_classes()
+        self.check_defined_link_references()
 
 
     def check_metadata(self):
@@ -331,6 +335,26 @@ def check_codeblock_classes(self):
                                 cls)
 
 
+    def check_defined_link_references(self):
+        """Check that defined links resolve in the file.
+
+        Internally-defined links match the pattern [text][label].  If
+        the label contains '{{...}}', it is hopefully a references to
+        a configuration value - we should check that, but don't right
+        now.
+        """
+
+        result = set()
+        for node in self.find_all(self.doc, {'type' : 'text'}):
+            for match in P_INTERNALLY_DEFINED_LINK.findall(node['value']):
+                if '{{' not in match:
+                    result.add(match)
+        self.reporter.check(not result,
+                            self.filename,
+                            'Internally-defined links may be missing definitions: {0}',
+                            ', '.join(sorted(result)))
+
+
     def find_all(self, node, pattern, accum=None):
         """Find all matches for a pattern."""