From 3378c16231288b195ab82a1a998f961dc35b474e Mon Sep 17 00:00:00 2001 From: David Dal Busco Date: Fri, 4 Jul 2025 15:04:42 +0200 Subject: [PATCH 1/2] chore: run formatter after returns support addition --- src/lib/markdown.ts | 25 ++++++++++++++++++------- src/test/mock.json | 2 +- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/src/lib/markdown.ts b/src/lib/markdown.ts index c325b50..ac6db4b 100644 --- a/src/lib/markdown.ts +++ b/src/lib/markdown.ts @@ -212,13 +212,16 @@ const toMarkdown = ({ const jsDocsToReturnType = (jsDocs: JSDocTagInfo[]): string => { const returns: JSDocTagInfo[] = jsDocs.filter(({name}: JSDocTagInfo) => name === 'returns'); const texts: Array = returns.map(({text}) => text); - const returnType = texts.reduce((acc: SymbolDisplayPart[][], values: SymbolDisplayPart[] | undefined) => { - if (values === undefined) { - return acc; - } + const returnType = texts.reduce( + (acc: SymbolDisplayPart[][], values: SymbolDisplayPart[] | undefined) => { + if (values === undefined) { + return acc; + } - return [...acc, values]; - }, []); + return [...acc, values]; + }, + [] + ); return returnType.map((parts) => parts.map(({text}) => text).join('')).join(' '); }; @@ -271,7 +274,15 @@ const toMarkdown = ({ }) ); - const rowToMarkdown = ({name, documentation, type, params, returnType, examples, url}: Row): string => { + const rowToMarkdown = ({ + name, + documentation, + type, + params, + returnType, + examples, + url + }: Row): string => { const markdown: string[] = [ `${headingLevel}# ${emoji === undefined || emoji === null ? '' : ':gear: '}${name}\n` ]; diff --git a/src/test/mock.json b/src/test/mock.json index 51d7b60..b1587ac 100644 --- a/src/test/mock.json +++ b/src/test/mock.json @@ -560,4 +560,4 @@ ], "fileName": "src/test/mock.ts" } -] \ No newline at end of file +] From d86ede7e3d85dc5032ad5860eb942ce69f9c6ffd Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 4 Jul 2025 13:05:08 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A4=96=20Documentation=20auto-update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8203df7..29ab825 100644 --- a/README.md +++ b/README.md @@ -149,6 +149,9 @@ Parameters: - `params.inputFiles`: The list of files to scan and for which the documentation should be build. - `params.options`: Optional compiler options to generate the docs +Returns: +An array of documentation entries + [:link: Source](https://github.com/peterpeterparker/tsdoc-markdown/tree/main/src/lib/docs.ts#L496) ### :gear: documentationToMarkdown @@ -164,7 +167,7 @@ Parameters: - `params.entries`: The entries of the documentation (functions, constants and classes). - `params.options`: Optional configuration to render the Markdown content. See `types.ts` for details. -[:link: Source](https://github.com/peterpeterparker/tsdoc-markdown/tree/main/src/lib/markdown.ts#L335) +[:link: Source](https://github.com/peterpeterparker/tsdoc-markdown/tree/main/src/lib/markdown.ts#L364) ### :gear: generateDocumentation