fix: Ui improvements

typedoc2md · Feb 7, 2024 · eadda01 · eadda01
1 parent 750a871
commit eadda01
Show file tree

Hide file tree

Showing 27 changed files with 848 additions and 369 deletions.
diff --git a/.changeset/poor-gorillas-march.md b/.changeset/poor-gorillas-march.md
@@ -0,0 +1,6 @@
+---
+"typedoc-plugin-markdown": patch
+---
+
+- Remove blockquotes on signature and declarations.
+- Minor ui tweaks.
diff --git a/packages/typedoc-github-wiki-theme/test/specs/__snapshots__/github-wiki.spec.ts.snap b/packages/typedoc-github-wiki-theme/test/specs/__snapshots__/github-wiki.spec.ts.snap
@@ -92,7 +92,7 @@ exports[`GithubWiki should output member docs 1`] = `
 
 ### new ClassA()
 
-> **new ClassA**(): [\`ClassA\`](../wiki/module-1.Class.ClassA)
+**new ClassA**(): [\`ClassA\`](../wiki/module-1.Class.ClassA)
 
 #### Returns
 

diff --git a/...ges/typedoc-plugin-markdown/src/theme/resources/partials/member.declaration.identifier.ts b/...ges/typedoc-plugin-markdown/src/theme/resources/partials/member.declaration.identifier.ts
@@ -15,13 +15,13 @@ export function declarationMemberIdentifier(
 
   const prefix: string[] = [];
 
-  const modifiers = reflection.flags.filter(
-    (flag) => flag !== 'Optional' && !reflection.flags.isRest,
-  );
+  //const modifiers = reflection.flags.filter(() => !reflection.flags.isRest);
 
-  if (modifiers.length) {
+  if (reflection.flags.length) {
     prefix.push(
-      modifiers.map((flag) => bold(backTicks(flag.toLowerCase()))).join(' '),
+      reflection.flags
+        .map((flag) => bold(backTicks(flag.toLowerCase())))
+        .join(' '),
     );
   }
 
@@ -60,7 +60,7 @@ export function declarationMemberIdentifier(
   }
 
   if (reflection.flags.isOptional) {
-    name.push('?');
+    //name.push('?');
   }
 
   if (declarationType) {
@@ -86,5 +86,5 @@ export function declarationMemberIdentifier(
   }
 
   const result = md.join('');
-  return useCodeBlocks ? codeBlock(result) : `> ${result}`;
+  return useCodeBlocks ? codeBlock(result) : `${result}`;
 }
diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/partials/member.signature.identifier.ts b/packages/typedoc-plugin-markdown/src/theme/resources/partials/member.signature.identifier.ts
@@ -61,5 +61,5 @@ export function signatureMemberIdentifier(
   }
 
   const result = md.join('');
-  return useCodeBlocks ? codeBlock(result) : `> ${result}`;
+  return useCodeBlocks ? codeBlock(result) : `${result}`;
 }
diff --git a/packages/typedoc-plugin-markdown/src/theme/resources/partials/member.signature.returns.ts b/packages/typedoc-plugin-markdown/src/theme/resources/partials/member.signature.returns.ts
@@ -4,7 +4,6 @@ import {
   ReflectionType,
   SignatureReflection,
   SomeType,
-  UnionType,
 } from 'typedoc';
 import { MarkdownThemeRenderContext } from '../..';
 import { backTicks, blockQuoteBlock, codeBlock, heading } from '../markdown';
@@ -75,13 +74,13 @@ function getReturnType(
   }
   if (type) {
     const returnType = context.partials.someType(type);
-    if (
-      type instanceof UnionType ||
-      (type instanceof ReflectionType &&
-        context.options.getValue('expandObjects') &&
-        context.options.getValue('useCodeBlocks'))
-    ) {
-      return codeBlock(returnType);
+    if (context.options.getValue('useCodeBlocks')) {
+      if (
+        type instanceof ReflectionType &&
+        context.options.getValue('expandObjects')
+      ) {
+        return codeBlock(returnType);
+      }
     }
     return returnType;
   }

diff --git a/packages/typedoc-plugin-markdown/test/fixtures/config.ts b/packages/typedoc-plugin-markdown/test/fixtures/config.ts
@@ -33,11 +33,11 @@ const config: Record<string, Fixture> = {
       disableSources: true,
       expandObjects: true,
       expandParameters: true,
+      useCodeBlocks: true,
     },
     options: [
       {},
       {
-        useCodeBlocks: true,
         parametersFormat: 'table',
         propertiesFormat: 'table',
       },

diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/functions.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/functions.ts
@@ -80,6 +80,13 @@ export function functionWithNamedParams(
   anotherParam: string,
 ) {}
 
+/**
+ * Function with reset parmas
+ */
+export function functionWithRestParams(param: string, ...restParams: string[]) {
+  return true;
+}
+
 /**
  * Function with type parameters
  * @typeParam T Comments for T
@@ -112,6 +119,9 @@ export function functionWithMultipleSignatures(): string {
 
 /**
  * Comments for function
+ *
+ * @default {}
+ *
  * @returns Return comments
  */
 export function functionReturningAnObject() {
@@ -126,6 +136,18 @@ export function functionReturningAString() {
   return 'hello';
 }
 
+/**
+ * Comments for function
+ * @returns Return comments
+ */
+export function functionReturningAUnionType():
+  | string
+  | boolean
+  | 'string1'
+  | 'string2' {
+  return 'hello';
+}
+
 /**
  * Comments for function
  */

diff --git a/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/interfaces.ts b/packages/typedoc-plugin-markdown/test/fixtures/src/reflections/interfaces.ts
@@ -38,7 +38,7 @@ export interface BasicInterface {
   /**
    * Comments for propReturningSignatureDeclaration
    */
-  propReturningSignatureDeclaration: () => any;
+  propReturningSignatureDeclaration?: () => string | boolean | number;
 
   /**
    * Comments for propReturningSignatureDeclarations

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap
@@ -329,25 +329,25 @@ This is a simple example on how to use include.
 
 ### SameName
 
-> **SameName**: \`true\`
+**SameName**: \`true\`
 
 ***
 
 ### \\_prop\\_with\\_underscore
 
-> **\`const\`** **\\_prop\\_with\\_underscore**: \`true\` = \`true\`
+**\`const\`** **\\_prop\\_with\\_underscore**: \`true\` = \`true\`
 
 ***
 
 ### prop
 
-> **\`const\`** **prop**: \`true\` = \`true\`
+**\`const\`** **prop**: \`true\` = \`true\`
 
 ***
 
 ### propb
 
-> **\`const\`** **propb**: \`true\` = \`true\`
+**\`const\`** **propb**: \`true\` = \`true\`
 "
 `;
 
@@ -496,30 +496,30 @@ This is a simple example on how to use include.
 
 ### SameName
 
-> **SameName**: \`true\`
+**SameName**: \`true\`
 
 ***
 
 <a id="_prop_with_underscore" name="_prop_with_underscore"></a>
 
 ### \\_prop\\_with\\_underscore
 
-> **\`const\`** **\\_prop\\_with\\_underscore**: \`true\` = \`true\`
+**\`const\`** **\\_prop\\_with\\_underscore**: \`true\` = \`true\`
 
 ***
 
 <a id="prop-3" name="prop-3"></a>
 
 ### prop
 
-> **\`const\`** **prop**: \`true\` = \`true\`
+**\`const\`** **prop**: \`true\` = \`true\`
 
 ***
 
 <a id="propb-3" name="propb-3"></a>
 
 ### propb
 
-> **\`const\`** **propb**: \`true\` = \`true\`
+**\`const\`** **propb**: \`true\` = \`true\`
 "
 `;
diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/customization.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/customization.spec.ts.snap
@@ -26,7 +26,7 @@ Some other comments
 
 ### someFunction()
 
-> **someFunction**(): \`void\`
+**someFunction**(): \`void\`
 
 #### Returns
 

diff --git a/packages/typedoc-plugin-markdown/test/specs/__snapshots__/entryfiles.spec.ts.snap b/packages/typedoc-plugin-markdown/test/specs/__snapshots__/entryfiles.spec.ts.snap
@@ -43,7 +43,7 @@ exports[`EntryFiles should get module member for members: (Output File Strategy
 
 ### new ModuleClass()
 
-> **new ModuleClass**(): [\`ModuleClass\`](ModuleClass.md)
+**new ModuleClass**(): [\`ModuleClass\`](ModuleClass.md)
 
 #### Returns
 
@@ -64,7 +64,7 @@ exports[`EntryFiles should get module member for members: (Output File Strategy
 
 ### new ModuleClass()
 
-> **new ModuleClass**(): [\`ModuleClass\`](ModuleClass.md)
+**new ModuleClass**(): [\`ModuleClass\`](ModuleClass.md)
 
 #### Returns