fix(core): allow htmlTable format key for indexes (#618)

typedoc2md · Jun 22, 2024 · aff7c1a · aff7c1a
1 parent 3a5640d
commit aff7c1a
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 30 deletions.
diff --git a/docs/pages/docs/options/display-options.mdx b/docs/pages/docs/options/display-options.mdx
@@ -115,7 +115,7 @@ This option should be set when a full type representation is preferred.
 
 <Callout emoji="💡">Sets the format of index items.</Callout>
 
-> Accepts either `"list"` or `"table"`. Defaults to `"list"`.
+> Accepts one of `"list"` | `"table"` | `"htmlTable"`. Defaults to `"list"`.
 
 This option renders index items either as a simple unordered list or in a table.
 

diff --git a/packages/typedoc-plugin-markdown/src/_typedoc.d.ts b/packages/typedoc-plugin-markdown/src/_typedoc.d.ts
@@ -17,7 +17,7 @@ declare module 'typedoc' {
     hideGroupHeadings: boolean;
     hidePageHeader: boolean;
     hidePageTitle: boolean;
-    indexFormat: 'list' | 'table';
+    indexFormat: 'list' | 'table' | 'htmlTable';
     interfacePropertiesFormat: 'list' | 'table' | 'htmlTable';
     membersWithOwnFile: (
       | 'Enum'

diff --git a/packages/typedoc-plugin-markdown/src/options/declarations.ts b/packages/typedoc-plugin-markdown/src/options/declarations.ts
@@ -21,7 +21,7 @@
  */
 import { DeclarationOption, ParameterType } from 'typedoc';
 import { ALLOWED_OWN_FILE_MEMBERS, TEXT_CONTENT_MAPPINGS } from './constants';
-import { IndexFormat, OutputFileStrategy, ReflectionFormat } from './maps';
+import { DisplayFormat, OutputFileStrategy } from './maps';
 
 /**
  * TypeDoc creates documentation according to exports derived from the given [`entryPointsStrategy`](https://typedoc.org/options/input/#entrypointstrategy) configuration.
@@ -304,8 +304,8 @@ export const expandParameters: Partial<DeclarationOption> = {
 export const indexFormat: Partial<DeclarationOption> = {
   help: 'Sets the format of index items.',
   type: ParameterType.Map,
-  map: IndexFormat,
-  defaultValue: IndexFormat.List,
+  map: DisplayFormat,
+  defaultValue: DisplayFormat.List,
 };
 
 /**
@@ -320,8 +320,8 @@ export const indexFormat: Partial<DeclarationOption> = {
 export const parametersFormat: Partial<DeclarationOption> = {
   help: 'Sets the format of parameter and type parameter groups.',
   type: ParameterType.Map,
-  map: ReflectionFormat,
-  defaultValue: ReflectionFormat.List,
+  map: DisplayFormat,
+  defaultValue: DisplayFormat.List,
 };
 
 /**
@@ -336,8 +336,8 @@ export const parametersFormat: Partial<DeclarationOption> = {
 export const interfacePropertiesFormat: Partial<DeclarationOption> = {
   help: 'Sets the format of property groups for interfaces.',
   type: ParameterType.Map,
-  map: ReflectionFormat,
-  defaultValue: ReflectionFormat.List,
+  map: DisplayFormat,
+  defaultValue: DisplayFormat.List,
 };
 
 /**
@@ -352,8 +352,8 @@ export const interfacePropertiesFormat: Partial<DeclarationOption> = {
 export const classPropertiesFormat: Partial<DeclarationOption> = {
   help: 'Sets the format of property groups for classes.',
   type: ParameterType.Map,
-  map: ReflectionFormat,
-  defaultValue: ReflectionFormat.List,
+  map: DisplayFormat,
+  defaultValue: DisplayFormat.List,
 };
 
 /**
@@ -368,8 +368,8 @@ export const classPropertiesFormat: Partial<DeclarationOption> = {
 export const enumMembersFormat: Partial<DeclarationOption> = {
   help: 'Sets the format of enumeration members.',
   type: ParameterType.Map,
-  map: ReflectionFormat,
-  defaultValue: ReflectionFormat.List,
+  map: DisplayFormat,
+  defaultValue: DisplayFormat.List,
 };
 
 /**
@@ -384,8 +384,8 @@ export const enumMembersFormat: Partial<DeclarationOption> = {
 export const typeDeclarationFormat: Partial<DeclarationOption> = {
   help: 'Sets the format of style for type declaration members.',
   type: ParameterType.Map,
-  map: ReflectionFormat,
-  defaultValue: ReflectionFormat.List,
+  map: DisplayFormat,
+  defaultValue: DisplayFormat.List,
 };
 
 /**
@@ -402,8 +402,8 @@ export const typeDeclarationFormat: Partial<DeclarationOption> = {
 export const propertyMembersFormat: Partial<DeclarationOption> = {
   help: 'Sets the format of style for property members for interfaces and classes.',
   type: ParameterType.Map,
-  map: ReflectionFormat,
-  defaultValue: ReflectionFormat.List,
+  map: DisplayFormat,
+  defaultValue: DisplayFormat.List,
 };
 
 /**
@@ -416,8 +416,8 @@ export const propertyMembersFormat: Partial<DeclarationOption> = {
 export const propertiesFormat: Partial<DeclarationOption> = {
   help: 'Sets the format of property groups for interfaces and classes.',
   type: ParameterType.Map,
-  map: ReflectionFormat,
-  defaultValue: ReflectionFormat.List,
+  map: DisplayFormat,
+  defaultValue: DisplayFormat.List,
 };
 
 /**

diff --git a/packages/typedoc-plugin-markdown/src/options/maps.ts b/packages/typedoc-plugin-markdown/src/options/maps.ts
@@ -13,18 +13,10 @@ export enum OutputFileStrategy {
 }
 
 /**
- * The allowed values for formatting reflections.
+ * The allowed values for formatting reflections and indexes.
  */
-export enum ReflectionFormat {
+export enum DisplayFormat {
   List = 'list',
   Table = 'table',
   HtmlTable = 'htmlTable',
 }
-
-/**
- * The allowed values for formatting indexes.
- */
-export enum IndexFormat {
-  List = 'list',
-  Table = 'table',
-}
diff --git a/packages/typedoc-plugin-markdown/src/types/options.ts b/packages/typedoc-plugin-markdown/src/types/options.ts
@@ -83,7 +83,7 @@ export interface PluginOptions {
   /**
    * Sets the format of index items.
    */
-  indexFormat: 'list' | 'table';
+  indexFormat: 'list' | 'table' | 'htmlTable';
 
   /**
    * Sets the format of property groups for interfaces.