From bf130cb99a08861116f8c2a7c54ebdc48cfba4f8 Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Mon, 30 Sep 2024 23:34:58 +0100 Subject: [PATCH] fix(core): add parentheses on function names in type declaration table views (#696) --- .changeset/quiet-ducks-thank.md | 5 +++++ .../theme/context/partials/member.typeDeclarationTable.ts | 8 +++++++- .../__snapshots__/reflection.type-alias.spec.ts.snap | 2 +- 3 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 .changeset/quiet-ducks-thank.md diff --git a/.changeset/quiet-ducks-thank.md b/.changeset/quiet-ducks-thank.md new file mode 100644 index 000000000..cbcc3a8d2 --- /dev/null +++ b/.changeset/quiet-ducks-thank.md @@ -0,0 +1,5 @@ +--- +'typedoc-plugin-markdown': patch +--- + +- Add parentheses on function names in type declaration table views (#696) diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts index b358e2432..c09f8ca19 100644 --- a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts +++ b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.typeDeclarationTable.ts @@ -51,8 +51,14 @@ export function typeDeclarationTable( declarations.forEach((declaration: DeclarationReflection) => { const row: string[] = []; + const name: string[] = [declaration.name]; + + if (declaration.signatures?.length) { + name.push('()'); + } + const optional = declaration.flags.isOptional ? '?' : ''; - row.push(`${backTicks(declaration.name)}${optional}`); + row.push(`${backTicks(name.join(''))}${optional}`); row.push(this.partials.someType(declaration.type)); diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap index 895af1af4..b52330629 100644 --- a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap +++ b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.type-alias.spec.ts.snap @@ -237,7 +237,7 @@ Comments for LiteralType | \`set accessorA\` | \`void\` | Comments for accessorA setter | | \`get accessorB\` | \`string\` | - | | \`set accessorB\` | \`void\` | - | -| \`someFunction\` | [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`any\`\\> | Comments for someFunction | +| \`someFunction()\` | [\`Promise\`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)\\<\`any\`\\> | Comments for someFunction | ## Source