Merge branch 'main' into feat/jsdocs-class-interface

Author: peterpeterparker

src/lib/parser/jdocs/parser.ts src/lib/parser/jdocs/render.tssrc/lib/parser/jdocs/parser.ts renamed to src/lib/parser/jdocs/render.ts

@@ -12,7 +12,7 @@ import {
   jsDocsToReferences,
   jsDocsToReturnType
 } from './jdocs/mapper';
-import {inlineReferences} from './jdocs/parser';
+import {emojiTitle, metadataToMarkdown, sourceCodeLink} from './render';
 import type {Params, Row} from './types';
 
 const toParams = (parameters?: DocEntry[]): Params[] =>
@@ -180,12 +180,6 @@ const interfacesToMarkdown = ({
   return markdown.join('\n');
 };
 
-const sourceCodeLink = ({
-  url,
-  emoji
-}: Pick<MarkdownOptions, 'emoji'> & Required<Pick<DocEntry, 'url'>>): string =>
-  `[${emojiTitle({emoji, key: 'link'}).trim()}${emoji !== null && emoji !== undefined ? ' ' : ''}Source](${url})\n`;
-
 // Avoid issue if the Markdown table gets formatted with Prettier
 const parseType = (type: string): string =>
   type
@@ -248,26 +242,15 @@ const toMarkdown = ({
       markdown.push('\n');
     }
 
-    if (returnType !== undefined && returnType !== '') {
-      markdown.push(`Returns:\n`);
-      markdown.push(`${returnType}\n`);
-    }
+    const metadata = metadataToMarkdown({
+      returnType,
+      references,
+      examples,
+      url,
+      emoji
+    });
 
-    if (references?.length) {
-      markdown.push(`References:\n`);
-      markdown.push(...inlineReferences(references));
-      markdown.push('\n');
-    }
-
-    if (examples.length) {
-      markdown.push('Examples:\n');
-      markdown.push(...examples);
-      markdown.push('\n');
-    }
-
-    if (url !== undefined) {
-      markdown.push(sourceCodeLink({emoji, url}));
-    }
+    markdown.push(...metadata);
 
     return markdown.join('\n');
   };
@@ -290,14 +273,6 @@ const tableOfContent = ({
     )
     .join('\n');
 
-const emojiTitle = ({
-  emoji,
-  key
-}: {
-  key: keyof MarkdownEmoji;
-} & Pick<MarkdownOptions, 'emoji'>): string =>
-  emoji === undefined || emoji === null ? '' : ` :${emoji[key]}:`;
-
 const DEFAULT_EMOJI: MarkdownEmoji = {
   classes: 'factory',
   functions: 'toolbox',

src/lib/parser/markdown.ts

@@ -0,0 +1,50 @@
+import type {DocEntry, MarkdownEmoji, MarkdownOptions} from '../types';
+import {inlineReferences} from './jdocs/render';
+import type {MappedJsDocs} from './types';
+
+export const emojiTitle = ({
+  emoji,
+  key
+}: {
+  key: keyof MarkdownEmoji;
+} & Pick<MarkdownOptions, 'emoji'>): string =>
+  emoji === undefined || emoji === null ? '' : ` :${emoji[key]}:`;
+
+export const sourceCodeLink = ({
+  url,
+  emoji
+}: Pick<MarkdownOptions, 'emoji'> & Required<Pick<DocEntry, 'url'>>): string =>
+  `[${emojiTitle({emoji, key: 'link'}).trim()}${emoji !== null && emoji !== undefined ? ' ' : ''}Source](${url})\n`;
+
+export const metadataToMarkdown = ({
+  returnType,
+  references,
+  examples,
+  url,
+  emoji
+}: MappedJsDocs & Pick<DocEntry, 'url'> & {emoji: MarkdownEmoji | null | undefined}): string[] => {
+  const markdown: string[] = [];
+
+  if (returnType !== undefined && returnType !== '') {
+    markdown.push(`Returns:\n`);
+    markdown.push(`${returnType}\n`);
+  }
+
+  if (references?.length) {
+    markdown.push(`References:\n`);
+    markdown.push(...inlineReferences(references));
+    markdown.push('\n');
+  }
+
+  if (examples.length) {
+    markdown.push('Examples:\n');
+    markdown.push(...examples);
+    markdown.push('\n');
+  }
+
+  if (url !== undefined) {
+    markdown.push(sourceCodeLink({emoji, url}));
+  }
+
+  return markdown;
+};

src/lib/parser/render.ts

@@ -5,10 +5,13 @@ export interface Params {
   documentation: string;
 }
 
+export interface MappedJsDocs {
+  examples: string[];
+  returnType?: string;
+  references?: string[];
+}
+
 export type Row = Required<Pick<DocEntry, 'name' | 'type' | 'documentation'>> &
   Pick<DocEntry, 'url'> & {
     params: Params[];
-    examples: string[];
-    returnType?: string;
-    references?: string[];
-  };
+  } & MappedJsDocs;