Merge branch 'master' of https://github.com/tgreyuk/typedoc-plugin-ma…

…rkdown
typedoc2md · Dec 1, 2022 · bde74d1 · bde74d1
2 parents c1e5cdb + d982de4
commit bde74d1
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 22 deletions.
diff --git a/packages/typedoc-plugin-markdown/src/resources/helpers/parameter-table.ts b/packages/typedoc-plugin-markdown/src/resources/helpers/parameter-table.ts
@@ -58,12 +58,23 @@ function table(parameters: any) {
   const rows = parameters.map((parameter) => {
     const row: string[] = [];
 
-    row.push(
-      `\`${parameter.flags.isRest ? '...' : ''}${parameter.name}${
-        parameter.flags.isOptional ? '?' : ''
-      }\``,
+    const nbsp = ' '; // ? <== Unicode no-break space character
+    const rest = parameter.flags.isRest ? '...' : '';
+    const optional = parameter.flags.isOptional ? '?' : '';
+
+    const isDestructuredParam = parameter.name == '__namedParameters';
+    const isDestructuredParamProp = parameter.name.startsWith(
+      '__namedParameters.',
     );
 
+    if (isDestructuredParam) {
+      row.push(`\`${rest}«destructured»\``);
+    } else if (isDestructuredParamProp) {
+      row.push(`›${nbsp}\`${rest}${parameter.name.slice(18)}${optional}\``);
+    } else {
+      row.push(`\`${rest}${parameter.name}${optional}\``);
+    }
+
     row.push(
       parameter.type
         ? Handlebars.helpers.type.call(parameter.type, 'object')

diff --git a/packages/typedoc-plugin-markdown/src/resources/helpers/signature-title.ts b/packages/typedoc-plugin-markdown/src/resources/helpers/signature-title.ts
@@ -50,15 +50,11 @@ const getParameters = (
 ) => {
   return parameters
     .map((param) => {
-      const paramsmd: string[] = [];
-      if (param.flags.isRest) {
-        paramsmd.push('...');
-      }
-      const paramItem = `${param.name}${
-        param.flags.isOptional || param.defaultValue ? '?' : ''
-      }`;
-      paramsmd.push(backticks ? `\`${paramItem}\`` : paramItem);
-      return paramsmd.join('');
+      const isDestructuredParam = param.name == '__namedParameters';
+      const paramItem = `${param.flags.isRest ? '...' : ''}${
+        isDestructuredParam ? '«destructured»' : param.name
+      }${param.flags.isOptional || param.defaultValue ? '?' : ''}`;
+      return backticks ? `\`${paramItem}\`` : paramItem;
     })
     .join(', ');
 };
diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/declarations.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/declarations.spec.ts.snap
@@ -32,7 +32,7 @@ exports[`Declarations: should compile any function type 1`] = `
 
 #### Type declaration
 
-▸ (...\`input\`): \`A\`
+▸ (\`...input\`): \`A\`
 
 ##### Parameters
 

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/signatures.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/signatures.spec.ts.snap
@@ -129,17 +129,17 @@ exports[`Signatures: should compile function with reference type' 1`] = `
 `;
 
 exports[`Signatures: should compile named parameters with comments' 1`] = `
-"▸ **functionWithNamedParamsAndComments**(\`__namedParameters?\`, \`anotherParam\`): \`void\`
+"▸ **functionWithNamedParamsAndComments**(\`«destructured»?\`, \`anotherParam\`): \`void\`
 
 FOO
 
 ##### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| \`__namedParameters\` | \`Object\` | various options |
-| \`__namedParameters.bar?\` | \`number\` | - |
-| \`__namedParameters.foo?\` | \`number\` | - |
+| \`«destructured»\` | \`Object\` | various options |
+|  › \`bar?\` | \`number\` | - |
+|  › \`foo?\` | \`number\` | - |
 | \`anotherParam\` | \`string\` | Another param comment |
 
 ##### Returns
@@ -149,13 +149,13 @@ FOO
 `;
 
 exports[`Signatures: should compile named parameters' 1`] = `
-"▸ **functionWithNamedParams**(\`__namedParameters\`): \`string\`
+"▸ **functionWithNamedParams**(\`«destructured»\`): \`string\`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| \`__namedParameters\` | \`Object\` |
+| \`«destructured»\` | \`Object\` |
 
 ##### Returns
 
@@ -260,7 +260,7 @@ This is a function with multiple arguments and a return value.
 `;
 
 exports[`Signatures: should compile signature with rest params' 1`] = `
-"▸ **functionWithRest**(...\`rest\`): \`string\`
+"▸ **functionWithRest**(\`...rest\`): \`string\`
 
 This is a function with rest parameter.
 
@@ -277,7 +277,7 @@ This is a function with rest parameter.
 `;
 
 exports[`Signatures: should compile signature with union types' 1`] = `
-"▸ **functionWithUnionTypes**(\`arg\`, ...\`args\`): \`any\`
+"▸ **functionWithUnionTypes**(\`arg\`, \`...args\`): \`any\`
 
 ##### Parameters