fix(theme): improve destructured parameters rendering and flatten lists (#167)

* fix(theme): improve destructured parameters rendering and flatten lists

* chore: change the first char in interface to lowercase

Author: moshams272

plugins/processor/index.mjs

@@ -37,6 +37,30 @@ export function load(app) {
       .getReflectionsByKind(ReflectionKind.Reference)
       .forEach(ref => context.project.removeReflection(ref));
 
+    // Destructured parameters are not supported by TypeDoc, so we rename them to
+    // a more generic name.
+    context.project
+      .getReflectionsByKind(ReflectionKind.Parameter)
+      .forEach(param => {
+        if (param.name.startsWith('__namedParameters')) {
+          if (
+            param.type?.type === 'reflection' &&
+            param.type.declaration?.children
+          ) {
+            const destructuredKeys = param.type.declaration.children.map(
+              child => child.name
+            );
+            param.name = `{ ${destructuredKeys.join(', ')} }`;
+          } else if (param.type?.type === 'reference' && param.type.name) {
+            const interfaceName = param.type.name;
+            param.name =
+              interfaceName[0].toLowerCase() + interfaceName.slice(1);
+          } else {
+            param.name = 'options';
+          }
+        }
+      });
+
     applyExportEqualsReflections(context.project);
     applySourceMetadata(context.project);
   });

plugins/theme/partials/index.mjs

@@ -55,9 +55,7 @@ export default ctx => {
         stability,
         stability && '',
         model.parameters?.length &&
-          ctx.partials.parametersList(model.parameters, {
-            headingLevel: options.headingLevel,
-          }),
+          ctx.partials.parametersList(model.parameters),
         ctx.helpers.typedListItem({
           label: 'Returns',
           type: model.type ?? 'void',
@@ -301,7 +299,22 @@ export default ctx => {
 
     memberTitle: model =>
       getMemberTitle(model, { local: isTypePage(ctx.page.model) }),
-    parametersList: ctx.helpers.typedList,
+    parametersList(parameters) {
+      const flatList = [];
+
+      parameters.forEach(param => {
+        if (
+          param.type?.type === 'reflection' &&
+          param.type.declaration?.children
+        ) {
+          flatList.push(...param.type.declaration.children);
+        } else {
+          flatList.push(param);
+        }
+      });
+
+      return ctx.helpers.typedList(flatList);
+    },
     typeDeclarationList: ctx.helpers.typedList,
     propertiesTable: ctx.helpers.typedList,