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

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

Author: flakey5

src/generators/json-simple/index.mjs

@@ -50,7 +50,7 @@ export default {
     });
 
     // This simply grabs all the different files and stringifies them
-    const stringifiedContent = JSON.stringify(mappedInput);
+    const stringifiedContent = JSON.stringify(mappedInput, null, 2);
 
     if (options.output) {
       // Writes all the API docs stringified content into one file

src/generators/metadata/utils/parse.mjs

@@ -55,20 +55,39 @@ export const parseApiDoc = ({ file, tree }, typeMap) => {
   // Get all Markdown Heading entries from the tree
   const headingNodes = selectAll('heading', tree);
 
+  // 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;
+  // });
+
   // Handles Markdown link references and updates them to be plain links
-  visit(tree, createQueries.UNIST.isLinkReference, node =>
-    updateLinkReference(node, markdownDefinitions)
-  );
+  visit(tree, createQueries.UNIST.isLinkReference, node => {
+    updateLinkReference(node, markdownDefinitions);
+    return [SKIP];
+  });
 
   // 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)
-  );
+  visit(tree, createQueries.UNIST.isMarkdownUrl, node => {
+    updateMarkdownLink(node);
+    return [SKIP];
+  });
 
   // 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
@@ -113,33 +132,73 @@ 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, index, parent) => {
+      let skip = false;
+
+      // Applies stability index metadata if present
+      if (createQueries.UNIST.isStabilityNode(node)) {
+        skip = true;
+
+        addStabilityMetadata(
+          node,
+          ignoreStability ? undefined : apiEntryMetadata
+        );
+      }
+
+      // Transform any YAML metadata and then apply it to the current
+      // metadata entry
+      if (createQueries.UNIST.isYamlNode(node)) {
+        // TODO: Is there always only one YAML node?
+        apiEntryMetadata.setYamlPosition(node.position);
+        addYAMLMetadata(node, apiEntryMetadata);
+      }
+
+      let valueUpdated = false;
+
+      if (createQueries.UNIST.isTextWithType(node)) {
+        skip = true;
+
+        valueUpdated = true;
+        node.value = updateTypeReference(node);
+      }
+
+      if (createQueries.UNIST.isTextWithUnixManual(node)) {
+        skip = true;
+
+        valueUpdated = true;
+        node.value = updateUnixManualReference(node);
+      }
+
+      if (valueUpdated) {
+        // This changes the type into a link by splitting it up into several nodes,
+        // and adding those nodes to the parent.
+        const {
+          children: [newNode],
+        } = remarkProcessor.parse(node.value);
+
+        // Replace the original node with the new node(s)
+        parent.children.splice(index, 1, ...newNode.children);
+      }
+
+      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)
-    );
+    // visit(subTree, createQueries.UNIST.isTextWithType, (node, _, parent) => {
+    //   updateTypeReference(node, parent);
+    //   return SKIP;
+    // });
 
     // Visits all Unix manual references, and replaces them with links
-    visit(
-      subTree,
-      createQueries.UNIST.isTextWithUnixManual,
-      (node, _, parent) => updateUnixManualReference(node, parent)
-    );
+    // visit(
+    //   subTree,
+    //   createQueries.UNIST.isTextWithUnixManual,
+    //   (node, _, parent) => {
+    //     updateUnixManualReference(node, parent);
+    //     return SKIP;
+    //   }
+    // );
 
     // Removes already parsed items from the subtree so that they aren't included in the final content
     remove(subTree, [createQueries.UNIST.isYamlNode]);

src/utils/highlighter.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/queries/index.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,
@@ -14,7 +13,6 @@ import {
   transformTypeToReferenceLink,
   transformUnixManualToLink,
 } from '../parser/index.mjs';
-import { getRemark } from '../remark.mjs';
 import { transformNodesToString } from '../unist.mjs';
 
 /**
@@ -23,7 +21,6 @@ import { transformNodesToString } from '../unist.mjs';
  * @param {Record<string, string>} typeMap The mapping to types to links
  */
 const createQueries = typeMap => {
-  const remark = getRemark();
   /**
    * Sanitizes the YAML source by returning the inner YAML content
    * and then parsing it into an API Metadata object and updating the current Metadata
@@ -35,8 +32,6 @@ const createQueries = typeMap => {
     const yamlContent = extractYamlContent(node);
 
     apiEntryMetadata.updateProperties(parseYAMLIntoMetadata(yamlContent));
-
-    return [SKIP];
   };
 
   /**
@@ -64,8 +59,6 @@ const createQueries = typeMap => {
       createQueries.QUERIES.markdownUrl,
       (_, filename, hash = '') => `${filename}.html${hash}`
     );
-
-    return [SKIP];
   };
 
   /**
@@ -77,27 +70,15 @@ const createQueries = typeMap => {
    * @param {Function} transformer The function to transform the reference
    *
    */
-  const updateReferences = (query, transformer, node, parent) => {
+  const updateReferences = (query, transformer, node) => {
     const replacedTypes = node.value
       .replace(query, transformer)
       // Remark doesn't handle leading / trailing spaces, so replace them with
       // HTML entities.
       .replace(/^\s/, '&nbsp;')
       .replace(/\s$/, '&nbsp;');
 
-    // This changes the type into a link by splitting it up into several nodes,
-    // and adding those nodes to the parent.
-    const {
-      children: [newNode],
-    } = remark.parse(replacedTypes);
-
-    // Find the index of the original node in the parent
-    const index = parent.children.indexOf(node);
-
-    // Replace the original node with the new node(s)
-    parent.children.splice(index, 1, ...newNode.children);
-
-    return [SKIP];
+    return replacedTypes;
   };
 
   /**
@@ -113,8 +94,6 @@ const createQueries = typeMap => {
 
     node.type = 'link';
     node.url = definition.url;
-
-    return [SKIP];
   };
 
   /**
@@ -154,8 +133,6 @@ const createQueries = typeMap => {
       // Adds the Stability Index metadata to the current Metadata entry
       apiEntryMetadata?.addStability(stabilityIndexNode);
     }
-
-    return [SKIP];
   };
 
   /**