Let full reference links override footnotes

commonmark · Jun 1, 2024 · 947b1e5 · 947b1e5
1 parent aa90ab0
commit 947b1e5
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 13 deletions.
diff --git a/...otnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteBracketProcessor.java b/...otnotes/src/main/java/org/commonmark/ext/footnotes/internal/FootnoteBracketProcessor.java
@@ -2,6 +2,7 @@
 
 import org.commonmark.ext.footnotes.FootnoteDefinition;
 import org.commonmark.ext.footnotes.FootnoteReference;
+import org.commonmark.node.LinkReferenceDefinition;
 import org.commonmark.parser.InlineParserContext;
 import org.commonmark.parser.beta.BracketInfo;
 import org.commonmark.parser.beta.BracketProcessor;
@@ -14,6 +15,12 @@ public BracketResult process(BracketInfo bracketInfo, Scanner scanner, InlinePar
         // TODO: Does parsing need to be more strict here?
         var text = bracketInfo.text();
         if (text.startsWith("^")) {
+            if (bracketInfo.label() != null && context.getDefinition(LinkReferenceDefinition.class, bracketInfo.label()) != null) {
+                // If there's a label after the text and the label has a definition -> it's a link, and it should
+                // take preference.
+                return BracketResult.none();
+            }
+
             var label = text.substring(1);
             // Check if we have a definition, otherwise ignore (same behavior as for link reference definitions)
             var def = context.getDefinition(FootnoteDefinition.class, label);

diff --git a/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnotesTest.java b/commonmark-ext-footnotes/src/test/java/org/commonmark/ext/footnotes/FootnotesTest.java
@@ -179,19 +179,24 @@ public void testRefWithBracket() {
         assertNull(tryFind(doc, FootnoteReference.class));
     }
 
-    // Interesting test cases:
-
-    // Test [^*foo*][foo]
-    //
-    // [^*foo*]: /url
-    //
-    // [foo]: /url
-    //
-    // vs
-    //
-    // Test [^*foo*][foo]
-    //
-    // [^*foo*]: /url
+    @Test
+    public void testPreferReferenceLink() {
+        // This is tricky because `[^*foo*][foo]` is a valid link already. If `[foo]` was not defined, the first bracket
+        // would be a footnote.
+        var doc = PARSER.parse("Test [^*foo*][foo]\n\n[^*foo*]: /url\n\n[foo]: /url");
+        assertNull(tryFind(doc, FootnoteReference.class));
+    }
+
+    @Test
+    public void testReferenceLinkWithoutDefinition() {
+        // Similar to previous test but there's no definition
+        var doc = PARSER.parse("Test [^*foo*][foo]\n\n[^*foo*]: def\n");
+        var ref = find(doc, FootnoteReference.class);
+        assertEquals("*foo*", ref.getLabel());
+        var paragraph = (Paragraph) doc.getFirstChild();
+        assertText("Test ", paragraph.getFirstChild());
+        assertText("[foo]", paragraph.getLastChild());
+    }
 
     private static <T> T find(Node parent, Class<T> nodeClass) {
         return Objects.requireNonNull(tryFind(parent, nodeClass), "Could not find a " + nodeClass.getSimpleName() + " node in " + parent);