fix(core): fix reflection flags

typedoc2md · Jun 16, 2024 · e06b849 · e06b849
1 parent 9b00dca
commit e06b849
Show file tree

Hide file tree

Showing 19 changed files with 154 additions and 49 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -51,7 +51,7 @@
     "ts-morph": "^22.0.0",
     "ts-node": "^10.9.2",
     "tsc-alias": "^1.8.10",
-    "typedoc": "^0.26.0-beta.3",
+    "typedoc": "^0.26.0-beta.4",
     "typescript": "^5.4.5",
     "unified-prettier": "^2.0.1"
   }

diff --git a/packages/typedoc-plugin-markdown/.scripts/prebuild-resources.ts b/packages/typedoc-plugin-markdown/.scripts/prebuild-resources.ts
@@ -138,6 +138,7 @@ async function writeResourcesFile() {
     'ReferenceType',
     'Reflection',
     'ReflectionCategory',
+    'ReflectionFlags',
     'ReflectionGroup',
     'ReflectionKind',
     'ReflectionType',

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/helpers/_index.ts b/packages/typedoc-plugin-markdown/src/theme/context/helpers/_index.ts
@@ -1,3 +1,4 @@
+export * from './get-comment-flags';
 export * from './get-comment-parts';
 export * from './get-declaration-type';
 export * from './get-description-for-reflection';

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-flags.ts b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-comment-flags.ts
@@ -0,0 +1,24 @@
+import { camelToTitleCase } from 'libs/utils';
+import { MarkdownThemeContext } from 'theme';
+import { DeclarationReflection, SignatureReflection } from 'typedoc';
+
+export function getCommentFlags(
+  this: MarkdownThemeContext,
+  reflection: DeclarationReflection | SignatureReflection,
+): string[] {
+  const flagsNotRendered: `@${string}`[] = [
+    '@showCategories',
+    '@showGroups',
+    '@hideCategories',
+    '@hideGroups',
+  ];
+  const flags: string[] = [];
+  if (reflection.comment) {
+    for (const tag of reflection.comment.modifierTags) {
+      if (!flagsNotRendered.includes(tag)) {
+        flags.push(camelToTitleCase(tag.substring(1)));
+      }
+    }
+  }
+  return flags;
+}
diff --git a/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts b/packages/typedoc-plugin-markdown/src/theme/context/helpers/get-reflection-flags.ts
@@ -1,24 +1,32 @@
-import { camelToTitleCase } from 'libs/utils';
+import { backTicks } from 'libs/markdown';
 import { MarkdownThemeContext } from 'theme';
-import { DeclarationReflection, SignatureReflection } from 'typedoc';
+import { ReflectionFlags } from 'typedoc';
 
 export function getReflectionFlags(
   this: MarkdownThemeContext,
-  reflection: DeclarationReflection | SignatureReflection,
-): string[] {
-  const flagsNotRendered: `@${string}`[] = [
-    '@showCategories',
-    '@showGroups',
-    '@hideCategories',
-    '@hideGroups',
-  ];
-  const flags: string[] = [];
-  if (reflection.comment) {
-    for (const tag of reflection.comment.modifierTags) {
-      if (!flagsNotRendered.includes(tag)) {
-        flags.push(camelToTitleCase(tag.substring(1)));
-      }
-    }
+  reflectionFlags: ReflectionFlags,
+): string {
+  const result: string[] = [];
+  if (reflectionFlags.isAbstract) {
+    result.push(backTicks('abstract'));
   }
-  return flags;
+  if (reflectionFlags.isConst) {
+    result.push(backTicks('const'));
+  }
+  if (reflectionFlags.isPrivate) {
+    result.push(backTicks('private'));
+  }
+  if (reflectionFlags.isProtected) {
+    result.push(backTicks('protected'));
+  }
+  if (reflectionFlags.isReadonly) {
+    result.push(backTicks('readonly'));
+  }
+  if (reflectionFlags.isStatic) {
+    result.push(backTicks('static'));
+  }
+  if (reflectionFlags.isOptional) {
+    result.push(backTicks('optional'));
+  }
+  return result.join(' ');
 }
diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declaration.ts
@@ -33,7 +33,7 @@ export function declaration(
 
   md.push(
     this.helpers
-      .getReflectionFlags(model)
+      .getCommentFlags(model)
       .map((item) => backTicks(item))
       .join(' '),
   );

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.declarationTitle.ts
@@ -20,10 +20,10 @@ export function declarationTitle(
 
   const prefix: string[] = [];
 
-  if (model.flags.length) {
-    prefix.push(
-      model.flags?.map((flag) => backTicks(flag.toLowerCase())).join(' '),
-    );
+  const flagsString = this.helpers.getReflectionFlags(model.flags);
+
+  if (flagsString.length) {
+    prefix.push(flagsString);
   }
 
   if (model.flags.isRest) {
@@ -36,8 +36,10 @@ export function declarationTitle(
     prefix.push(keyword);
   }
 
-  if (prefix.length) {
-    md.push(prefix.join(' ') + ' ');
+  const prefixes = prefix.filter((prefix) => prefix.length > 0);
+
+  if (prefixes.length) {
+    md.push(prefixes.join(' ') + ' ');
   }
 
   const name: string[] = [];

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.indexSignature.ts
@@ -12,7 +12,6 @@ export function indexSignature(
   model: SignatureReflection,
 ): string {
   const md = [''];
-
   const params = model.parameters
     ? model.parameters.map((parameter) => {
         return parameter.type

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.memberTitle.ts
@@ -15,11 +15,8 @@ export function memberTitle(
   const md: string[] = [];
   const name: string[] = [];
 
-  if (
-    model?.kind === ReflectionKind.Class &&
-    model.flags?.includes('Abstract')
-  ) {
-    name.push(backTicks('abstract') + ' ');
+  if (model?.kind === ReflectionKind.Class && model.flags?.isAbstract) {
+    name.push(this.helpers.getReflectionFlags(model.flags) + ' ');
   }
 
   name.push(

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.propertiesTable.ts
@@ -107,10 +107,12 @@ export function propertiesTable(
       nameColumn.push(backTicks(propertyName));
     }
 
-    const flags = this.helpers.getReflectionFlags(property);
+    const commentFlags = this.helpers.getCommentFlags(property);
 
-    if (flags?.length) {
-      nameColumn.push(`(${flags.map((flag) => `*${flag}*`).join(', ')})`);
+    if (commentFlags?.length) {
+      nameColumn.push(
+        `(${commentFlags.map((flag) => `*${flag}*`).join(', ')})`,
+      );
     }
 
     row.push(nameColumn.join(' '));

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signature.ts
@@ -21,7 +21,7 @@ export function signature(
 
   md.push(
     this.helpers
-      .getReflectionFlags(model)
+      .getCommentFlags(model)
       .map((item) => backTicks(item))
       .join(' '),
   );

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts b/packages/typedoc-plugin-markdown/src/theme/context/partials/member.signatureTitle.ts
@@ -27,12 +27,11 @@ export function signatureTitle(
     md.push(backTicks(options?.accessor) + ' ');
   }
 
-  if (model.parent && model.parent.flags?.length > 0) {
-    md.push(
-      model.parent.flags
-        .map((flag) => backTicks(flag.toLowerCase()))
-        .join(' ') + ' ',
-    );
+  if (model.parent) {
+    const flagsString = this.helpers.getReflectionFlags(model.parent?.flags);
+    if (flagsString.length) {
+      md.push(this.helpers.getReflectionFlags(model.parent.flags) + ' ');
+    }
   }
 
   if (!['__call', '__type'].includes(model.name)) {

diff --git a/packages/typedoc-plugin-markdown/src/theme/context/resources.ts b/packages/typedoc-plugin-markdown/src/theme/context/resources.ts
@@ -23,6 +23,7 @@ import {
   ReferenceType,
   Reflection,
   ReflectionCategory,
+  ReflectionFlags,
   ReflectionGroup,
   ReflectionKind,
   ReflectionType,
@@ -558,6 +559,9 @@ There is no association list partial for properties as these are handled as a st
 
 export const resourceHelpers = (context: MarkdownThemeContext) => {
   return {
+    getCommentFlags: (
+      reflection: DeclarationReflection | SignatureReflection,
+    ) => helpers.getCommentFlags.apply(context, [reflection]) as string[],
     getCommentParts: (model: CommentDisplayPart[]) =>
       helpers.getCommentParts.apply(context, [model]) as string,
     getDeclarationType: (model: DeclarationReflection) =>
@@ -605,9 +609,8 @@ export const resourceHelpers = (context: MarkdownThemeContext) => {
       ]) as string,
     getPropertyDefaultValue: (model: DeclarationReflection) =>
       helpers.getPropertyDefaultValue.apply(context, [model]) as string | null,
-    getReflectionFlags: (
-      reflection: DeclarationReflection | SignatureReflection,
-    ) => helpers.getReflectionFlags.apply(context, [reflection]) as string[],
+    getReflectionFlags: (reflectionFlags: ReflectionFlags) =>
+      helpers.getReflectionFlags.apply(context, [reflectionFlags]) as string,
     getReturnType: (model?: SomeType | undefined) =>
       helpers.getReturnType.apply(context, [model]) as string,
     isGroupKind: (model: DeclarationReflection | SignatureReflection) =>

diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/interfaces.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/interfaces.ts
@@ -122,6 +122,20 @@ export interface IndexableInterface {
   prop: string;
 }
 
+export interface MultipleIndexableInterface {
+  /**
+   * First index signature
+   */
+  [key: string]: string;
+  /**
+   * Second index signature
+   */
+  [index: number]: string;
+  /**
+   * Prop
+   */
+  prop: string;
+}
 export interface CustomEventInterface<T> {
   detail: string;
   target: T;

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/navigation.spec.ts.snap
@@ -4192,6 +4192,11 @@ exports[`Navigation should gets Navigation Json for single entry point: (Output
         "title": "InterfaceWithTypeParameters",
         "kind": 256,
         "path": "interfaces/InterfaceWithTypeParameters.md"
+      },
+      {
+        "title": "MultipleIndexableInterface",
+        "kind": 256,
+        "path": "interfaces/MultipleIndexableInterface.md"
       }
     ]
   },

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/reflection.interface.spec.ts.snap
@@ -860,3 +860,43 @@ Comments for InterfaceWithTypeParameters
 | \`prop\` | \`A\` | Comments for prop |
 "
 `;
+
+exports[`Interface Reflection should compile multiple indexable interface: (Output File Strategy "members") (Option Group "1") 1`] = `
+"# Interface: MultipleIndexableInterface
+
+## Indexable
+
+ \\[\`key\`: \`string\`\\]: \`string\`
+
+ \\[\`index\`: \`number\`\\]: \`string\`
+
+## Properties
+
+### prop
+
+> **prop**: \`string\`
+
+Prop
+
+#### Source
+
+[interfaces.ts:1](http://source-url)
+"
+`;
+
+exports[`Interface Reflection should compile multiple indexable interface: (Output File Strategy "members") (Option Group "2") 1`] = `
+"# Interface: MultipleIndexableInterface
+
+## Indexable
+
+ \\[\`key\`: \`string\`\\]: \`string\`
+
+ \\[\`index\`: \`number\`\\]: \`string\`
+
+## Properties
+
+| Property | Type | Description |
+| :------ | :------ | :------ |
+| \`prop\` | \`string\` | Prop |
+"
+`;
diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/urls.spec.ts.snap
@@ -813,6 +813,7 @@ exports[`Urls should gets Urls for single entry points: outputFileStrategy: memb
   "interfaces/InterfaceWithEventProperties.md",
   "interfaces/InterfaceWithFlags.md",
   "interfaces/InterfaceWithTypeParameters.md",
+  "interfaces/MultipleIndexableInterface.md",
   "type-aliases/ArrayOfStuff.md",
   "type-aliases/ArrayType.md",
   "type-aliases/ConditionalType.md",
@@ -889,6 +890,7 @@ exports[`Urls should gets Urls for single entry points: outputFileStrategy: memb
   "interfaces/InterfaceWithEventProperties.md",
   "interfaces/InterfaceWithFlags.md",
   "interfaces/InterfaceWithTypeParameters.md",
+  "interfaces/MultipleIndexableInterface.md",
   "type-aliases/ArrayOfStuff.md",
   "type-aliases/ArrayType.md",
   "type-aliases/ConditionalType.md",

diff --git a/packages/typedoc-plugin-markdown/test/specs/reflection.interface.spec.ts b/packages/typedoc-plugin-markdown/test/specs/reflection.interface.spec.ts
@@ -29,6 +29,14 @@ describe(`Interface Reflection`, () => {
     );
   });
 
+  test(`should compile multiple indexable interface`, () => {
+    expectFileToEqual(
+      'reflections',
+      'members',
+      'interfaces/MultipleIndexableInterface.md',
+    );
+  });
+
   test(`should compile interface with event properties`, () => {
     expectFileToEqual(
       'reflections',