refactor(core/data-cite): simplify linking (#2836)

Author: sidvishnoi

src/core/dfn-map.js

@@ -1,5 +1,7 @@
 // @ts-check
 import { CaseInsensitiveMap } from "./utils.js";
+
+/** @type {CaseInsensitiveMap<Set<HTMLElement>>} */
 export const definitionMap = new CaseInsensitiveMap();
 
 /**

src/core/link-to-dfn.js

@@ -56,23 +56,30 @@ export async function run(conf) {
   /** @type {HTMLAnchorElement[]} */
   const badLinks = [];
 
-  const localLinkSelector =
-    "a[data-cite=''], a:not([href]):not([data-cite]):not(.logo):not(.externalDFN)";
-  document.querySelectorAll(localLinkSelector).forEach((
-    /** @type {HTMLAnchorElement} */ anchor
-  ) => {
+  /** @type {NodeListOf<HTMLAnchorElement>} */
+  const localAnchors = document.querySelectorAll(
+    "a[data-cite=''], a:not([href]):not([data-cite]):not(.logo):not(.externalDFN)"
+  );
+  for (const anchor of localAnchors) {
     const linkTargets = getLinkTargets(anchor);
-    const foundDfn = linkTargets.some(target => {
-      return findLinkTarget(target, anchor, titleToDfns);
-    });
-    if (!foundDfn && linkTargets.length !== 0) {
+    const linkTarget = linkTargets.find(
+      target =>
+        titleToDfns.has(target.title) &&
+        titleToDfns.get(target.title).has(target.for)
+    );
+    if (linkTarget) {
+      const foundLocalMatch = processAnchor(anchor, linkTarget, titleToDfns);
+      if (!foundLocalMatch) {
+        possibleExternalLinks.push(anchor);
+      }
+    } else {
       if (anchor.dataset.cite === "") {
         badLinks.push(anchor);
       } else {
         possibleExternalLinks.push(anchor);
       }
     }
-  });
+  }
 
   showLinkingError(badLinks);
 
@@ -86,6 +93,7 @@ export async function run(conf) {
 }
 
 function mapTitleToDfns() {
+  /** @type {CaseInsensitiveMap<Map<string, HTMLElement>>} */
   const titleToDfns = new CaseInsensitiveMap();
   for (const key of definitionMap.keys()) {
     const { result, duplicates } = collectDfns(key);
@@ -128,43 +136,36 @@ function collectDfns(title) {
 }
 
 /**
- * @param {import("./utils.js").LinkTarget} target
  * @param {HTMLAnchorElement} anchor
- * @param {CaseInsensitiveMap} titleToDfns
+ * @param {import("./utils.js").LinkTarget} target
+ * @param {ReturnType<typeof mapTitleToDfns>} titleToDfns
  */
-function findLinkTarget(target, anchor, titleToDfns) {
+function processAnchor(anchor, target, titleToDfns) {
+  let noLocalMatch = false;
   const { linkFor } = anchor.dataset;
-  if (
-    !titleToDfns.has(target.title) ||
-    !titleToDfns.get(target.title).get(target.for)
-  ) {
-    return false;
-  }
   const dfn = titleToDfns.get(target.title).get(target.for);
   if (dfn.dataset.cite) {
     anchor.dataset.cite = dfn.dataset.cite;
   } else if (linkFor && !titleToDfns.get(linkFor)) {
-    possibleExternalLinks.push(anchor);
+    noLocalMatch = true;
   } else if (dfn.classList.contains("externalDFN")) {
     // data-lt[0] serves as unique id for the dfn which this element references
     const lt = dfn.dataset.lt ? dfn.dataset.lt.split("|") : [];
     anchor.dataset.lt = lt[0] || dfn.textContent;
-    possibleExternalLinks.push(anchor);
+    noLocalMatch = true;
+  } else if (anchor.dataset.idl !== "partial") {
+    anchor.href = `#${dfn.id}`;
+    anchor.classList.add("internalDFN");
   } else {
-    if (anchor.dataset.idl === "partial") {
-      possibleExternalLinks.push(anchor);
-    } else {
-      anchor.href = `#${dfn.id}`;
-      anchor.classList.add("internalDFN");
-    }
+    noLocalMatch = true;
   }
   if (!anchor.hasAttribute("data-link-type")) {
     anchor.dataset.linkType = "idl" in dfn.dataset ? "idl" : "dfn";
   }
   if (isCode(dfn)) {
     wrapAsCode(anchor, dfn);
   }
-  return true;
+  return !noLocalMatch;
 }
 
 /**

src/core/utils.js

@@ -903,9 +903,13 @@ function* walkTree(walker) {
   }
 }
 
+/**
+ * @template ValueType
+ * @extends {Map<string, ValueType>}
+ */
 export class CaseInsensitiveMap extends Map {
   /**
-   * @param {Array<[String, HTMLElement]>} [entries]
+   * @param {Array<[string, ValueType]>} [entries]
    */
   constructor(entries = []) {
     super();
@@ -916,7 +920,7 @@ export class CaseInsensitiveMap extends Map {
   }
   /**
    * @param {String} key
-   * @param {*} value
+   * @param {ValueType} value
    */
   set(key, value) {
     super.set(key.toLowerCase(), value);