fix(perf): consolidate visit() calls in metadata gen

Signed-off-by: flakey5 <[email protected]>

Author: flakey5

npm-shrinkwrap.json

@@ -77,6 +77,7 @@
     "unified": "^11.0.5",
     "unist-builder": "^4.0.0",
     "unist-util-find-after": "^5.0.0",
+    "unist-util-is": "^6.0.1",
     "unist-util-position": "^5.0.0",
     "unist-util-remove": "^4.0.0",
     "unist-util-select": "^5.1.0",

package.json

@@ -2,6 +2,7 @@
 
 import { u as createTree } from 'unist-builder';
 import { findAfter } from 'unist-util-find-after';
+import { is } from 'unist-util-is';
 import { remove } from 'unist-util-remove';
 import { selectAll } from 'unist-util-select';
 import { SKIP, visit } from 'unist-util-visit';
@@ -55,21 +56,29 @@ export const parseApiDoc = ({ file, tree }, typeMap) => {
   // Get all Markdown Heading entries from the tree
   const headingNodes = selectAll('heading', tree);
 
-  // Handles Markdown link references and updates them to be plain links
-  visit(tree, createQueries.UNIST.isLinkReference, node =>
-    updateLinkReference(node, markdownDefinitions)
-  );
+  visit(tree, node => {
+    let skip = false;
+
+    // Update Markdown link references to be plain links
+    if (is(node, createQueries.UNIST.isLinkReference)) {
+      skip = true;
+      updateLinkReference(node, markdownDefinitions);
+    }
+
+    // Normalizes URLs that reference API doc files with .md extensions to
+    // be .html instead, since the files will eventually get compiled as HTML
+    if (is(node, createQueries.UNIST.isMarkdownUrl)) {
+      skip = true;
+      updateMarkdownLink(node);
+    }
+
+    return skip ? SKIP : undefined;
+  });
 
   // Removes all the original definitions from the tree as they are not needed
   // anymore, since all link references got updated to be plain links
   remove(tree, markdownDefinitions);
 
-  // Handles the normalisation URLs that reference to API doc files with .md extension
-  // to replace the .md into .html, since the API doc files get eventually compiled as HTML
-  visit(tree, createQueries.UNIST.isMarkdownUrl, node =>
-    updateMarkdownLink(node)
-  );
-
   // If the document has no headings but it has content, we add a fake heading to the top
   // so that our parsing logic can work correctly, and generate content for the whole file
   if (headingNodes.length === 0 && tree.children.length > 0) {
@@ -113,34 +122,44 @@ export const parseApiDoc = ({ file, tree }, typeMap) => {
     // `index + 1` is used to skip the current Heading Node
     const subTree = createTree('root', tree.children.slice(index, stop));
 
-    // Visits all Stability Index nodes from the current subtree if there's any
-    // and then apply the Stability Index metadata to the current metadata entry
-    visit(subTree, createQueries.UNIST.isStabilityNode, node =>
-      addStabilityMetadata(node, ignoreStability ? undefined : apiEntryMetadata)
-    );
-
-    // Visits all HTML nodes from the current subtree and if there's any that matches
-    // our YAML metadata structure, it transforms into YAML metadata
-    // and then apply the YAML Metadata to the current Metadata entry
-    visit(subTree, createQueries.UNIST.isYamlNode, node => {
-      // TODO: Is there always only one YAML node?
-      apiEntryMetadata.setYamlPosition(node.position);
-      addYAMLMetadata(node, apiEntryMetadata);
+    visit(subTree, (node, _, parent) => {
+      let skip = false;
+
+      // Applies stability index metadata if present
+      if (is(node, createQueries.UNIST.isStabilityNode)) {
+        skip = true;
+
+        addStabilityMetadata(
+          node,
+          ignoreStability ? undefined : apiEntryMetadata
+        );
+      }
+
+      // Transform any YAML metadata and then apply it to the current
+      // metadata entry
+      if (is(node, createQueries.UNIST.isYamlNode)) {
+        skip = true;
+
+        // TODO: Is there always only one YAML node?
+        apiEntryMetadata.setYamlPosition(node.position);
+        addYAMLMetadata(node, apiEntryMetadata);
+      }
+
+      // Update any API doc type reference to be a Markdown link
+      if (is(node, createQueries.UNIST.isTextWithType)) {
+        skip = true;
+        updateTypeReference(node, parent);
+      }
+
+      // Update all Unix manual references to be links
+      if (is(node, createQueries.UNIST.isTextWithUnixManual)) {
+        skip = true;
+        updateUnixManualReference(node, parent);
+      }
+
+      return skip ? SKIP : undefined;
     });
 
-    // Visits all Text nodes from the current subtree and if there's any that matches
-    // any API doc type reference and then updates the type reference to be a Markdown link
-    visit(subTree, createQueries.UNIST.isTextWithType, (node, _, parent) =>
-      updateTypeReference(node, parent)
-    );
-
-    // Visits all Unix manual references, and replaces them with links
-    visit(
-      subTree,
-      createQueries.UNIST.isTextWithUnixManual,
-      (node, _, parent) => updateUnixManualReference(node, parent)
-    );
-
     // Removes already parsed items from the subtree so that they aren't included in the final content
     remove(subTree, [createQueries.UNIST.isYamlNode]);
 

src/generators/metadata/utils/parse.mjs

@@ -53,7 +53,7 @@ export default function rehypeShikiji() {
       // We want the contents of the <pre> element, hence we attempt to get the first child
       const preElement = node.children[0];
 
-      // If thereÄs nothing inside the <pre> element... What are we doing here?
+      // If there's nothing inside the <pre> element... What are we doing here?
       if (!preElement || !preElement.properties) {
         return;
       }

src/utils/highlighter.mjs

@@ -1,7 +1,6 @@
 'use strict';
 
 import { u as createTree } from 'unist-builder';
-import { SKIP } from 'unist-util-visit';
 
 import {
   DOC_API_STABILITY_SECTION_REF_URL,
@@ -35,8 +34,6 @@ const createQueries = typeMap => {
     const yamlContent = extractYamlContent(node);
 
     apiEntryMetadata.updateProperties(parseYAMLIntoMetadata(yamlContent));
-
-    return [SKIP];
   };
 
   /**
@@ -64,8 +61,6 @@ const createQueries = typeMap => {
       createQueries.QUERIES.markdownUrl,
       (_, filename, hash = '') => `${filename}.html${hash}`
     );
-
-    return [SKIP];
   };
 
   /**
@@ -96,8 +91,6 @@ const createQueries = typeMap => {
 
     // Replace the original node with the new node(s)
     parent.children.splice(index, 1, ...newNode.children);
-
-    return [SKIP];
   };
 
   /**
@@ -113,8 +106,6 @@ const createQueries = typeMap => {
 
     node.type = 'link';
     node.url = definition.url;
-
-    return [SKIP];
   };
 
   /**
@@ -154,8 +145,6 @@ const createQueries = typeMap => {
       // Adds the Stability Index metadata to the current Metadata entry
       apiEntryMetadata?.addStability(stabilityIndexNode);
     }
-
-    return [SKIP];
   };
 
   /**