Skip to content

refactor: extract duplicated reducer #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
peterpeterparker merged 2 commits into from
Jul 4, 2025
Merged

refactor: extract duplicated reducer #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
05fc510
refactor: extract duplicated reducer
peterpeterparker Jul 4, 2025
a81910f
🤖 Documentation auto-update
github-actions[bot] Jul 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,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#L364)
[:link: Source](https://github.com/peterpeterparker/tsdoc-markdown/tree/main/src/lib/markdown.ts#L360)

### :gear: generateDocumentation

Expand Down
54 changes: 25 additions & 29 deletions src/lib/markdown.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,36 +209,32 @@ const toMarkdown = ({
headingLevel: MarkdownHeadingLevel | '####';
docType: 'Constant' | 'Function' | 'Method' | 'Property' | 'Type' | 'Enum';
} & Pick<MarkdownOptions, 'emoji'>): string => {
const jsDocsToReturnType = (jsDocs: JSDocTagInfo[]): string => {
const returns: JSDocTagInfo[] = jsDocs.filter(({name}: JSDocTagInfo) => name === 'returns');
const texts: Array<SymbolDisplayPart[] | undefined> = returns.map(({text}) => text);
const returnType = texts.reduce(
(acc: SymbolDisplayPart[][], values: SymbolDisplayPart[] | undefined) => {
if (values === undefined) {
return acc;
}
const jsDocsToSymbolDisplayParts = ({
jsDocs = [],
tagInfoName
}: {
jsDocs?: JSDocTagInfo[];
tagInfoName: 'returns' | 'param';
}): SymbolDisplayPart[][] => {
const tags = jsDocs.filter(({name}: JSDocTagInfo) => name === tagInfoName);
const texts = tags.map(({text}) => text);

return texts.reduce<SymbolDisplayPart[][]>((acc, values) => {
if (values === undefined) {
return acc;
}

return [...acc, values];
},
[]
);
return [...acc, values];
}, []);
};

return returnType.map((parts) => parts.map(({text}) => text).join('')).join(' ');
const jsDocsToReturnType = (jsDocs?: JSDocTagInfo[]): string => {
const returns = jsDocsToSymbolDisplayParts({jsDocs, tagInfoName: 'returns'});
return returns.map((parts) => parts.map(({text}) => text).join('')).join(' ');
};
const jsDocsToParams = (jsDocs: JSDocTagInfo[]): Params[] => {
const params: JSDocTagInfo[] = jsDocs.filter(({name}: JSDocTagInfo) => name === 'param');
const texts: Array<SymbolDisplayPart[] | undefined> = params.map(({text}) => text);

const parts: SymbolDisplayPart[][] = texts.reduce(
(acc: SymbolDisplayPart[][], values: SymbolDisplayPart[] | undefined) => {
if (values === undefined) {
return acc;
}

return [...acc, values];
},
[]
);
const jsDocsToParams = (jsDocs?: JSDocTagInfo[]): Params[] => {
const params = jsDocsToSymbolDisplayParts({jsDocs, tagInfoName: 'param'});

const toParam = (parts: SymbolDisplayPart[]): Params | undefined => {
if (parts.find(({kind, text}) => kind === 'parameterName' && text !== '') === undefined) {
Expand All @@ -251,7 +247,7 @@ const toMarkdown = ({
return {name, documentation};
};

return parts.map(toParam).filter((param) => param !== undefined) as Params[];
return params.map(toParam).filter((param) => param !== undefined) as Params[];
};
const jsDocsToExamples = (jsDocs: JSDocTagInfo[]): string[] => {
const examples: JSDocTagInfo[] = jsDocs.filter(({name}: JSDocTagInfo) => name === 'example');
Expand All @@ -267,8 +263,8 @@ const toMarkdown = ({
name,
type: type ?? '',
documentation: documentation ?? '',
params: [...toParams(parameters), ...jsDocsToParams(jsDocs ?? [])],
returnType: jsDocsToReturnType(jsDocs ?? []),
params: [...toParams(parameters), ...jsDocsToParams(jsDocs)],
returnType: jsDocsToReturnType(jsDocs),
examples: [...jsDocsToExamples(jsDocs ?? [])],
url
})
Expand Down