signature code block

Author: avivkeller

src/generators/jsx-ast/constants.mjs

@@ -95,4 +95,9 @@ export const OVERRIDDEN_POSITIONS = [
 ];
 
 // These types are methods, and have signatures we should enumerate
-export const TYPES_WITH_METHOD_SIGNATURES = ['ctor', 'method', 'classMethod'];
+export const TYPES_WITH_METHOD_SIGNATURES = [
+  'class',
+  'ctor',
+  'method',
+  'classMethod',
+];

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

@@ -34,11 +34,17 @@ export const parseListIntoProperties = node => {
 
     if (children[0].type === 'inlineCode') {
       name = children.shift().value.trimEnd();
-    } else if (children[0].value && children[0].value.startsWith('Returns')) {
-      name = 'Returns';
-      children[0].value = children[0].value.replace(/^Returns:?\s*/i, '');
-      if (!children[0].value.trim()) {
-        children.shift();
+    } else if (children[0].value) {
+      const starter = children[0].value.match(
+        createQueries.QUERIES.typedListStarters
+      );
+
+      if (starter) {
+        name = starter[1] !== 'Type' && starter[1];
+        children[0].value = children[0].value.slice(starter[0].length);
+        if (!children[0].value.trim()) {
+          children.shift();
+        }
       }
     }
 
@@ -89,13 +95,9 @@ export const createPropertyTable = (node, withHeading = true) => {
   const rows = properties.flatMap(prop => {
     const cells = [];
 
-    if (prop.name?.startsWith('Returns')) {
-      cells.push(createElement('td', 'Returns'));
-    } else {
-      cells.push(
-        createElement('td', prop.name ? createElement('code', prop.name) : '-')
-      );
-    }
+    cells.push(
+      createElement('td', prop.name ? createElement('code', prop.name) : '-')
+    );
 
     cells.push(createElement('td', prop.types.length > 0 ? prop.types : '-'));
     cells.push(createElement('td', prop.desc.length > 0 ? prop.desc : '-'));
@@ -139,9 +141,13 @@ export const createPropertyTable = (node, withHeading = true) => {
  */
 export const generateSignature = (
   functionName,
-  { params, return: returnType },
+  { params, return: returnType, extends: extendsType },
   prefix = ''
 ) => {
+  if (extendsType) {
+    return `class ${prefix}${functionName} extends ${extendsType.type}`;
+  }
+
   const returnStr = returnType ? `: ${returnType.type}` : '';
   const paramsStr = params
     .map(param => {
@@ -195,13 +201,19 @@ export const getFullName = ({ name, text }, fallback = name) => {
  */
 export default ({ children }, { data }, idx) => {
   // Find the list in the parent
-  const list = children.find(createQueries.UNIST.isTypedList);
+  const listIdx = children.findIndex(createQueries.UNIST.isTypedList);
 
-  const params = list ? list.children.map(parseListItem) : [];
+  const params =
+    listIdx >= 0 ? children[listIdx].children.map(parseListItem) : [];
 
   const signature = parseSignature(data.text, params);
   const displayName = getFullName(data);
 
+  if (data.type === 'class') {
+    // Remove the 'Extends' list
+    children.splice(listIdx, 1);
+  }
+
   children.splice(
     idx,
     0,

src/generators/legacy-json/constants.mjs

@@ -1,6 +1,3 @@
-// Grabs a method's return value
-export const RETURN_EXPRESSION = /^returns?\s*:?\s*/i;
-
 // Grabs a method's name
 export const NAME_EXPRESSION = /^['`"]?([^'`": {]+)['`"]?\s*:?\s*/;
 

src/generators/legacy-json/utils/parseList.mjs

@@ -2,7 +2,6 @@ import {
   DEFAULT_EXPRESSION,
   LEADING_HYPHEN,
   NAME_EXPRESSION,
-  RETURN_EXPRESSION,
   TYPE_EXPRESSION,
 } from '../constants.mjs';
 import parseSignature from './parseSignature.mjs';
@@ -59,9 +58,11 @@ export function parseListItem(child) {
   let text = current.textRaw;
 
   // Identify return items or extract key properties (name, type, default) from the text
-  if (RETURN_EXPRESSION.test(text)) {
-    current.name = 'return';
-    text = text.replace(RETURN_EXPRESSION, '');
+  const starter = text.match(createQueries.QUERIES.typedListStarters);
+  if (starter) {
+    current.name =
+      starter[1] === 'Returns' ? 'return' : starter[1].toLowerCase();
+    text = text.slice(starter[0].length);
   } else {
     text = extractPattern(text, NAME_EXPRESSION, 'name', current);
   }

src/generators/legacy-json/utils/parseSignature.mjs

@@ -175,10 +175,10 @@ export default (textRaw, markdownParameters) => {
    */
   const signature = { params: [] };
 
-  // Find the return value & filter it out
+  // Find the return/extends value & filter it out
   markdownParameters = markdownParameters.filter(value => {
-    if (value.name === 'return') {
-      signature.return = value;
+    if (value.name === 'return' || value.name === 'extends') {
+      signature[value.name] = value;
       return false;
     }
 

src/generators/web/ui/components/CodeBox.jsx

@@ -45,7 +45,7 @@ export default ({ className, ...props }) => {
       onCopy={onCopy}
       language={getLanguageDisplayName(language)}
       {...props}
-      buttonText='Copy to clipboard'
+      buttonText="Copy to clipboard"
     />
   );
 };

src/utils/queries/index.mjs

@@ -210,6 +210,8 @@ createQueries.QUERIES = {
   yamlInnerContent: /^<!--[ ]?(?:YAML([\s\S]*?)|([ \S]*?))?[ ]?-->/,
   // ReGeX for finding references to Unix manuals
   unixManualPage: /\b([a-z.]+)\((\d)([a-z]?)\)/g,
+  // ReGeX for determing a typed list's non-property names
+  typedListStarters: /^(Returns|Extends|Type):?\s*/,
 };
 
 createQueries.UNIST = {
@@ -282,8 +284,10 @@ createQueries.UNIST = {
       return false;
     }
 
-    // Check for "Returns"
-    if (node.value?.trimStart().startsWith('Returns')) {
+    // Check for other starters
+    if (
+      node.value?.trimStart().match(createQueries.QUERIES.typedListStarters)
+    ) {
       return true;
     }