Fix to prefer footnote instead of reference label

Closes GH-403. Closes GH-419.
remarkjs · Jul 11, 2019 · c73f409 · c73f409
1 parent e2ea7e8
commit c73f409
Show file tree

Hide file tree

Showing 6 changed files with 388 additions and 9 deletions.
diff --git a/packages/remark-parse/lib/tokenize/reference.js b/packages/remark-parse/lib/tokenize/reference.js
@@ -23,6 +23,7 @@ var caret = '^'
 function reference(eat, value, silent) {
   var self = this
   var commonmark = self.options.commonmark
+  var footnotes = self.options.footnotes
   var character = value.charAt(0)
   var index = 0
   var length = value.length
@@ -55,7 +56,7 @@ function reference(eat, value, silent) {
   queue = ''
 
   // Check whether we’re eating a footnote.
-  if (self.options.footnotes && value.charAt(index) === caret) {
+  if (footnotes && value.charAt(index) === caret) {
     // Exit if `![^` is found, so the `!` will be seen as text after this,
     // and we’ll enter this function again when `[^` is found.
     if (type === image) {
@@ -123,8 +124,13 @@ function reference(eat, value, silent) {
 
   character = value.charAt(index)
 
-  // Inline footnotes cannot have an identifier.
-  if (type !== footnote && character === leftSquareBracket) {
+  // Inline footnotes cannot have a label.
+  // If footnotes are enabled, link labels cannot start with a caret.
+  if (
+    type !== footnote &&
+    character === leftSquareBracket &&
+    (!footnotes || value.charAt(index + 1) !== caret)
+  ) {
     identifier = ''
     queue += character
     index++

diff --git a/test/fixtures/input/footnote-or-reference-label.text b/test/fixtures/input/footnote-or-reference-label.text
@@ -0,0 +1,5 @@
+[alpha][^bravo]
+
+[^bravo]: Footnote definition.
+
+[alpha]: https://example.com
diff --git a/test/fixtures/tree/footnote-like.footnotes.json b/test/fixtures/tree/footnote-like.footnotes.json
@@ -23,9 +23,9 @@
         },
         {
           "type": "linkReference",
-          "identifier": "^foo",
-          "label": "^foo",
-          "referenceType": "full",
+          "identifier": "defined",
+          "label": "defined",
+          "referenceType": "shortcut",
           "children": [
             {
               "type": "text",
@@ -51,6 +51,24 @@
               "column": 21,
               "offset": 20
             },
+            "end": {
+              "line": 1,
+              "column": 30,
+              "offset": 29
+            },
+            "indent": []
+          }
+        },
+        {
+          "type": "footnoteReference",
+          "identifier": "foo",
+          "label": "foo",
+          "position": {
+            "start": {
+              "line": 1,
+              "column": 30,
+              "offset": 29
+            },
             "end": {
               "line": 1,
               "column": 36,

diff --git a/test/fixtures/tree/footnote-matrix.footnotes.json b/test/fixtures/tree/footnote-matrix.footnotes.json
@@ -187,9 +187,9 @@
               "children": [
                 {
                   "type": "linkReference",
-                  "identifier": "^bar",
-                  "label": "^bar",
-                  "referenceType": "full",
+                  "identifier": "foo",
+                  "label": "foo",
+                  "referenceType": "shortcut",
                   "children": [
                     {
                       "type": "text",
@@ -215,6 +215,24 @@
                       "column": 4,
                       "offset": 32
                     },
+                    "end": {
+                      "line": 3,
+                      "column": 9,
+                      "offset": 37
+                    },
+                    "indent": []
+                  }
+                },
+                {
+                  "type": "footnoteReference",
+                  "identifier": "bar",
+                  "label": "bar",
+                  "position": {
+                    "start": {
+                      "line": 3,
+                      "column": 9,
+                      "offset": 37
+                    },
                     "end": {
                       "line": 3,
                       "column": 15,

diff --git a/test/fixtures/tree/footnote-or-reference-label.footnotes.json b/test/fixtures/tree/footnote-or-reference-label.footnotes.json
@@ -0,0 +1,166 @@
+{
+  "type": "root",
+  "children": [
+    {
+      "type": "paragraph",
+      "children": [
+        {
+          "type": "linkReference",
+          "identifier": "alpha",
+          "label": "alpha",
+          "referenceType": "shortcut",
+          "children": [
+            {
+              "type": "text",
+              "value": "alpha",
+              "position": {
+                "start": {
+                  "line": 1,
+                  "column": 2,
+                  "offset": 1
+                },
+                "end": {
+                  "line": 1,
+                  "column": 7,
+                  "offset": 6
+                },
+                "indent": []
+              }
+            }
+          ],
+          "position": {
+            "start": {
+              "line": 1,
+              "column": 1,
+              "offset": 0
+            },
+            "end": {
+              "line": 1,
+              "column": 8,
+              "offset": 7
+            },
+            "indent": []
+          }
+        },
+        {
+          "type": "footnoteReference",
+          "identifier": "bravo",
+          "label": "bravo",
+          "position": {
+            "start": {
+              "line": 1,
+              "column": 8,
+              "offset": 7
+            },
+            "end": {
+              "line": 1,
+              "column": 16,
+              "offset": 15
+            },
+            "indent": []
+          }
+        }
+      ],
+      "position": {
+        "start": {
+          "line": 1,
+          "column": 1,
+          "offset": 0
+        },
+        "end": {
+          "line": 1,
+          "column": 16,
+          "offset": 15
+        },
+        "indent": []
+      }
+    },
+    {
+      "type": "footnoteDefinition",
+      "identifier": "bravo",
+      "label": "bravo",
+      "children": [
+        {
+          "type": "paragraph",
+          "children": [
+            {
+              "type": "text",
+              "value": "Footnote definition.",
+              "position": {
+                "start": {
+                  "line": 3,
+                  "column": 11,
+                  "offset": 27
+                },
+                "end": {
+                  "line": 3,
+                  "column": 31,
+                  "offset": 47
+                },
+                "indent": []
+              }
+            }
+          ],
+          "position": {
+            "start": {
+              "line": 3,
+              "column": 11,
+              "offset": 27
+            },
+            "end": {
+              "line": 3,
+              "column": 31,
+              "offset": 47
+            },
+            "indent": []
+          }
+        }
+      ],
+      "position": {
+        "start": {
+          "line": 3,
+          "column": 1,
+          "offset": 17
+        },
+        "end": {
+          "line": 3,
+          "column": 31,
+          "offset": 47
+        },
+        "indent": []
+      }
+    },
+    {
+      "type": "definition",
+      "identifier": "alpha",
+      "label": "alpha",
+      "title": null,
+      "url": "https://example.com",
+      "position": {
+        "start": {
+          "line": 5,
+          "column": 1,
+          "offset": 49
+        },
+        "end": {
+          "line": 5,
+          "column": 29,
+          "offset": 77
+        },
+        "indent": []
+      }
+    }
+  ],
+  "position": {
+    "start": {
+      "line": 1,
+      "column": 1,
+      "offset": 0
+    },
+    "end": {
+      "line": 6,
+      "column": 1,
+      "offset": 78
+    }
+  }
+}