chore(docs): add a few tweaks in type extraction functions

meliorence · Oct 20, 2021 · 62c013a · 62c013a
1 parent db93464
commit 62c013a
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 18 deletions.
diff --git a/apps/website/src/typeui/reduceReflectionsWith.tsx b/apps/website/src/typeui/reduceReflectionsWith.tsx
@@ -7,10 +7,7 @@ import Indent from './Indent';
 export default function reduceReflectionsWith(
   punct: string | null,
   params: Params,
-  renderCurrent: (
-    curr: JSONOutput.DeclarationReflection,
-    params: Params
-  ) => any,
+  renderCurrent: (curr: JSONOutput.DeclarationReflection, p: Params) => any,
   shouldBreak?: boolean
 ) {
   return (prev: any, curr: JSONOutput.DeclarationReflection) => (

diff --git a/apps/website/src/typeui/renderReflection.tsx b/apps/website/src/typeui/renderReflection.tsx
@@ -257,15 +257,14 @@ export default function renderReflection(
       }
       return ret;
     case ReflectionKind.Method:
-      return renderAttribute(
-        reflection.name,
-        renderArrowSignatures(
-          reflection.signatures,
-          params.withoutMemberLinks()
-        ),
-        reflection.flags,
-        params
-      );
+      return reflection.signatures.map((s) => {
+        return renderAttribute(
+          reflection.name,
+          renderArrowSignatures([s], params.withoutMemberLinks()),
+          reflection.flags,
+          params
+        );
+      });
     case ReflectionKind.Function:
       return renderArrowSignatures(
         (reflection as JSONOutput.DeclarationReflection).signatures,

diff --git a/apps/website/src/typeui/renderType.tsx b/apps/website/src/typeui/renderType.tsx
@@ -127,7 +127,7 @@ export default function renderType(pt: DeclarationType, params: Params) {
         </>
       );
     case 'mapped':
-      const mapped = (pt as unknown) as JSONOutput.MappedType;
+      const mapped = pt as unknown as JSONOutput.MappedType;
       nextParams = params.withIndent();
       return (
         <>
@@ -192,7 +192,7 @@ export default function renderType(pt: DeclarationType, params: Params) {
         </>
       );
     case 'indexedAccess':
-      const acc = (pt as unknown) as JSONOutput.IndexedAccessType;
+      const acc = pt as unknown as JSONOutput.IndexedAccessType;
       return (
         <>
           {renderType(acc.objectType, params)}

diff --git a/doc-tools/doc-docusaurus-typedoc-plugin/src/gen-pages.js b/doc-tools/doc-docusaurus-typedoc-plugin/src/gen-pages.js
@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 /* eslint-disable @typescript-eslint/no-unused-vars */
 const { ReflectionKind } = require('typedoc');
 const { writeFile, readdir, unlink } = require('fs/promises');
@@ -87,6 +88,21 @@ ${parseLinks(remarks.text)}
 `;
 }
 
+/**
+ *
+ * @param {import('typedoc').JSONOutput.CommentTag} remarks
+ */
+function extractDeprecated(deprecated) {
+  return `
+:::warning Deprecated
+
+This feature will be removed in the next major release.
+${parseLinks(deprecated.text)}
+
+:::  
+`;
+}
+
 /**
  *
  * @param {import('typedoc').JSONOutput.CommentTag} warnings
@@ -136,9 +152,13 @@ function extractAdmonitions(comment, isHeader) {
   const remarks = comment.tags && comment.tags.find((t) => t.tag === 'remarks');
   const warning = comment.tags && comment.tags.find((t) => t.tag === 'warning');
   const example = comment.tags && comment.tags.find((t) => t.tag === 'example');
-  return `\n${remarks ? extractRemarks(remarks) : ''}${
-    warning ? extractWarning(warning) : ''
-  }${example ? extractExample(example, isHeader) : ''}\n\n`;
+  const deprecated =
+    comment.tags && comment.tags.find((t) => t.tag === 'deprecated');
+  return `\n${deprecated ? extractDeprecated(deprecated) : ''}${
+    remarks ? extractRemarks(remarks) : ''
+  }${warning ? extractWarning(warning) : ''}${
+    example ? extractExample(example, isHeader) : ''
+  }\n\n`;
 }
 
 /**