Fix footnote keys such as constructor

syntax-tree · Feb 3, 2023 · 0c67e83 · 0c67e83
1 parent ed45ec4
commit 0c67e83
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 3 deletions.
diff --git a/lib/footer.js b/lib/footer.js
@@ -21,14 +21,14 @@ export function footer(state) {
   let index = -1
 
   while (++index < state.footnoteOrder.length) {
-    const def = state.footnoteById[state.footnoteOrder[index].toUpperCase()]
+    const def = state.footnoteById[state.footnoteOrder[index]]
 
     if (!def) {
       continue
     }
 
     const content = state.all(def)
-    const id = String(def.identifier)
+    const id = String(def.identifier).toUpperCase()
     const safeId = normalizeUri(id.toLowerCase())
     let referenceIndex = 0
     /** @type {Array<ElementContent>} */

diff --git a/lib/handlers/footnote-reference.js b/lib/handlers/footnote-reference.js
@@ -17,7 +17,7 @@ import {normalizeUri} from 'micromark-util-sanitize-uri'
  *   hast node.
  */
 export function footnoteReference(state, node) {
-  const id = String(node.identifier)
+  const id = String(node.identifier).toUpperCase()
   const safeId = normalizeUri(id.toLowerCase())
   const index = state.footnoteOrder.indexOf(id)
   /** @type {number} */

diff --git a/test/footnote.js b/test/footnote.js
@@ -278,4 +278,30 @@ test('footnote', () => {
 </section>`,
     'should support a `footnoteLabelProperties`'
   )
+
+  tree = toHast(
+    fromMarkdown(
+      'a[^__proto__] b[^__proto__] c[^constructor]\n\n[^__proto__]: d\n[^constructor]: e',
+      {
+        extensions: [gfm()],
+        mdastExtensions: [gfmFromMarkdown()]
+      }
+    )
+  )
+  assert(tree, 'expected node')
+  assert.equal(
+    toHtml(tree),
+    `<p>a<sup><a href="#user-content-fn-__proto__" id="user-content-fnref-__proto__" data-footnote-ref aria-describedby="footnote-label">1</a></sup> b<sup><a href="#user-content-fn-__proto__" id="user-content-fnref-__proto__-2" data-footnote-ref aria-describedby="footnote-label">1</a></sup> c<sup><a href="#user-content-fn-constructor" id="user-content-fnref-constructor" data-footnote-ref aria-describedby="footnote-label">2</a></sup></p>
+<section data-footnotes class="footnotes"><h2 class="sr-only" id="footnote-label">Footnotes</h2>
+<ol>
+<li id="user-content-fn-__proto__">
+<p>d <a href="#user-content-fnref-__proto__" data-footnote-backref class="data-footnote-backref" aria-label="Back to content">↩</a> <a href="#user-content-fnref-__proto__-2" data-footnote-backref class="data-footnote-backref" aria-label="Back to content">↩<sup>2</sup></a></p>
+</li>
+<li id="user-content-fn-constructor">
+<p>e <a href="#user-content-fnref-constructor" data-footnote-backref class="data-footnote-backref" aria-label="Back to content">↩</a></p>
+</li>
+</ol>
+</section>`,
+    'should support funky footnote identifiers'
+  )
 })