highlight sig

Author: avivkeller

src/generators/jsx-ast/utils/buildContent.mjs

@@ -23,7 +23,7 @@ import {
   STABILITY_PREFIX_LENGTH,
   TYPES_WITH_METHOD_SIGNATURES,
 } from '../constants.mjs';
-import createSignatureElements, {
+import insertSignature, {
   createPropertyTable,
   getFullName,
 } from './createSignatureElements.mjs';
@@ -162,12 +162,9 @@ const transformHeadingNode = (entry, node, index, parent) => {
   }
 
   // Add method signatures for appropriate types
-  createSignatureElements(
-    parent,
-    node,
-    index + (sourceLink ? 2 : 1),
-    TYPES_WITH_METHOD_SIGNATURES.includes(node.data.type)
-  );
+  if (TYPES_WITH_METHOD_SIGNATURES.includes(node.data.type)) {
+    insertSignature(parent, node, index + 1);
+  }
 
   return [SKIP];
 };

src/generators/jsx-ast/utils/createSignatureElements.mjs

@@ -1,3 +1,4 @@
+import { highlightToHast } from '@node-core/rehype-shiki';
 import { h as createElement } from 'hastscript';
 
 import createQueries from '../../../utils/queries/index.mjs';
@@ -200,7 +201,7 @@ export const generateSignatures = (functionName, signature) => {
 export const createSignatureCodeBlock = (functionName, signature) => {
   const signatures = generateSignatures(functionName, signature);
   const codeContent = signatures.join('\n');
-  return createElement('pre', codeContent);
+  return highlightToHast(codeContent, 'typescript');
 };
 
 /**
@@ -226,36 +227,16 @@ export const getFullName = ({ name, text }, fallback = name) => {
  * Creates documentation from API metadata entries
  * @param {import('@types/mdast').Parent} parent - The parent node
  * @param {import('@types/mdast').Heading} heading - The heading
- * @param {number} backupIndex - If there isn't a list, use this index
- * @param {boolean} addSignatureCodebox - Is this a method?
+ * @param {number} idx - Index
  */
-export default (parent, heading, backupIndex, addSignatureCodebox) => {
-  // Find the list index in the parent
-  const listIdx = parent.children.findIndex(createQueries.UNIST.isTypedList);
-  const list = parent.children[listIdx];
-  const elements = [];
+export default ({ children }, { data }, idx) => {
+  // Find the list in the parent
+  const list = children.find(createQueries.UNIST.isTypedList);
 
-  // Create a signature code box, if this is a method/ctor.
-  if (addSignatureCodebox) {
-    const params = list ? list.children.map(parseListItem) : [];
+  const params = list ? list.children.map(parseListItem) : [];
 
-    const signature = parseSignature(heading.data.text, params);
-    const displayName = getFullName(heading.data);
+  const signature = parseSignature(data.text, params);
+  const displayName = getFullName(data);
 
-    elements.push(createSignatureCodeBlock(displayName, signature));
-  }
-
-  // Create property table if a list exists
-  if (list) {
-    elements.push(createPropertyTable(list));
-  }
-
-  // Replace the list in the parent with all collected elements
-  if (elements.length > 0) {
-    if (listIdx > -1) {
-      parent.children.splice(listIdx, 1, ...elements);
-    } else {
-      parent.children.splice(backupIndex, 0, ...elements);
-    }
-  }
+  children.splice(idx, 0, createSignatureCodeBlock(displayName, signature));
 };