refactor: extract jsDocs metadata render helper (#72)

Author: peterpeterparker

src/lib/parser/jdocs/mapper.ts

@@ -1,5 +1,5 @@
 import type {JSDocTagInfo, SymbolDisplayPart} from 'typescript';
-import type {Params} from '../types';
+import type {JsDocsMetadata, Params} from '../types';
 
 const jsDocsToSymbolDisplayParts = ({
   jsDocs = [],
@@ -20,12 +20,12 @@ const jsDocsToSymbolDisplayParts = ({
   }, []);
 };
 
-export const jsDocsToReturnType = (jsDocs?: JSDocTagInfo[]): string => {
+const jsDocsToReturnType = (jsDocs?: JSDocTagInfo[]): string => {
   const returns = jsDocsToSymbolDisplayParts({jsDocs, tagInfoName: 'returns'});
   return returns.map((parts) => parts.map(({text}) => text).join('')).join(' ');
 };
 
-export const jsDocsToReferences = (jsDocs?: JSDocTagInfo[]): string[] => {
+const jsDocsToReferences = (jsDocs?: JSDocTagInfo[]): string[] => {
   const sees = jsDocsToSymbolDisplayParts({jsDocs, tagInfoName: 'see'});
 
   return sees
@@ -55,11 +55,17 @@ export const jsDocsToParams = (jsDocs?: JSDocTagInfo[]): Params[] => {
   return params.map(toParam).filter((param) => param !== undefined) as Params[];
 };
 
-export const jsDocsToExamples = (jsDocs: JSDocTagInfo[]): string[] => {
+const jsDocsToExamples = (jsDocs: JSDocTagInfo[]): string[] => {
   const examples: JSDocTagInfo[] = jsDocs.filter(({name}: JSDocTagInfo) => name === 'example');
   const texts = examples
     .map(({text}) => text)
     .filter(Boolean)
     .flat(1) as SymbolDisplayPart[];
   return texts.map(({text}) => text).filter(Boolean);
 };
+
+export const jsDocsMetadata = (jsDocs?: JSDocTagInfo[]): JsDocsMetadata => ({
+  returnType: jsDocsToReturnType(jsDocs),
+  references: jsDocsToReferences(jsDocs),
+  examples: [...jsDocsToExamples(jsDocs ?? [])]
+});

src/lib/parser/markdown.ts

@@ -6,12 +6,7 @@ import type {
   MarkdownHeadingLevel,
   MarkdownOptions
 } from '../types';
-import {
-  jsDocsToExamples,
-  jsDocsToParams,
-  jsDocsToReferences,
-  jsDocsToReturnType
-} from './jdocs/mapper';
+import {jsDocsMetadata, jsDocsToParams} from './jdocs/mapper';
 import {emojiTitle, metadataToMarkdown, sourceCodeLink} from './render';
 import type {Params, Row} from './types';
 
@@ -205,9 +200,7 @@ const toMarkdown = ({
       type: type ?? '',
       documentation: documentation ?? '',
       params: [...toParams(parameters), ...jsDocsToParams(jsDocs)],
-      returnType: jsDocsToReturnType(jsDocs),
-      references: jsDocsToReferences(jsDocs),
-      examples: [...jsDocsToExamples(jsDocs ?? [])],
+      ...jsDocsMetadata(jsDocs),
       url
     })
   );

src/lib/parser/render.ts

@@ -1,6 +1,6 @@
 import type {DocEntry, MarkdownEmoji, MarkdownOptions} from '../types';
 import {inlineReferences} from './jdocs/render';
-import type {MappedJsDocs} from './types';
+import type {JsDocsMetadata} from './types';
 
 export const emojiTitle = ({
   emoji,
@@ -22,7 +22,8 @@ export const metadataToMarkdown = ({
   examples,
   url,
   emoji
-}: MappedJsDocs & Pick<DocEntry, 'url'> & {emoji: MarkdownEmoji | null | undefined}): string[] => {
+}: JsDocsMetadata &
+  Pick<DocEntry, 'url'> & {emoji: MarkdownEmoji | null | undefined}): string[] => {
   const markdown: string[] = [];
 
   if (returnType !== undefined && returnType !== '') {

src/lib/parser/types.ts

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