fix doc generation (..until 1.9.0 breaks it again)

OceanicJS · Sep 19, 2023 · 4873ef8 · 4873ef8
1 parent 6dd393b
commit 4873ef8
Show file tree

Hide file tree

Showing 13 changed files with 56 additions and 21 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,3 +1,6 @@
 {
-  "extends": "@uwu-codes/eslint-config/esm"
+  "extends": "@uwu-codes/eslint-config/esm",
+  "rules": {
+    "unicorn/switch-case-braces": "off"
+  }
 }
diff --git a/package.json b/package.json
@@ -47,7 +47,7 @@
     "morgan": "^1.10.0",
     "oceanic.js": "1.8.1-dev.08d3811",
     "semver": "^7.5.1",
-    "typedoc": "^0.23.28"
+    "typedoc": "^0.24.8"
   },
   "devDependencies": {
     "@swc/core": "^1.3.60",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/docs/convertType.ts b/src/docs/convertType.ts
@@ -6,7 +6,7 @@ function resolveArrayType(type: JSONOutput.ArrayType, level = 1): { level: numbe
 
 export default function convertType(type: JSONOutput.SomeType): string {
     if ("name" in type && type.name === "default" && "id" in type && type.id !== undefined) {
-        type.name = getName(type.id);
+        type.name = getName((type as {id: number; }).id);
     }
     switch (type.type) {
         case "array": {
@@ -51,7 +51,7 @@ export default function convertType(type: JSONOutput.SomeType): string {
             return `{ [${readonlyModifier ? "readonly " : ""}${nameType ? `${convertType(nameType)} in ` : ""}${parameter}${optionalModifier ? "?" : ""}: ${convertType(parameterType)}]${templateType ? ` extends ${convertType(templateType)}` : ""} }`;
         }
 
-        case "named-tuple-member": {
+        case "namedTupleMember": {
             const { name, isOptional, element } = type;
             return `${name}${isOptional ? "?" : ""}: ${convertType(element)}`;
         }
@@ -77,6 +77,9 @@ export default function convertType(type: JSONOutput.SomeType): string {
         }
 
         case "reference": {
+            if ("name" in type && type.name === "default" && "target" in type && type.target !== undefined) {
+                type.name = typeof type.target === "object" ? type.target.qualifiedName : getName(type.target);
+            }
             const { name, typeArguments } = type;
             return `${name}${typeArguments ? `<${typeArguments.map(convertType).join(", ")}>` : ""}`;
         }
@@ -110,7 +113,7 @@ export default function convertType(type: JSONOutput.SomeType): string {
             return `...${convertType(type.elementType)}`;
         }
 
-        case "template-literal": {
+        case "templateLiteral": {
             const { head, tail } = type;
             return `\`${head}${tail.map(([t, literal]) => `\${${convertType(t)}}${literal}`).join("")}\``;
         }
@@ -133,6 +136,7 @@ export default function convertType(type: JSONOutput.SomeType): string {
         }
 
         default: {
+            console.log(`TODO Type: ${(type as { type: string; }).type}`);
             return `TODO: ${(type as { type: string; }).type}`;
         }
     }

diff --git a/src/docs/idToName.ts b/src/docs/idToName.ts
@@ -7,6 +7,7 @@ export function getMap() {
 export function getName(id: number) {
     if (!nameMap.has(id)) {
         console.log(`Missing name for ${id}`);
+        console.debug(new TypeError(`Missing name for ${id}`).stack);
     }
     return nameMap.get(id) ?? `default[${id}]`;
 }

diff --git a/src/docs/process/accessor.ts b/src/docs/process/accessor.ts
@@ -7,7 +7,7 @@ export default function processAccessor(data: JSONOutput.DeclarationReflection)
         return;
     }
     if (data.getSignature.type && "name" in data.getSignature.type && data.getSignature.type.name === "default" && "id" in data.getSignature.type && data.getSignature.type.id !== undefined) {
-        data.getSignature.type.name = getName(data.getSignature.type.id);
+        data.getSignature.type.name = getName((data.getSignature.type as { id: number; }).id);
     }
     return {
         comment: data.getSignature.comment?.summary.reduce((a, b) => a + b.text, ""),

diff --git a/src/docs/process/constructor.ts b/src/docs/process/constructor.ts
@@ -16,7 +16,7 @@ export default function processConstructor(data: JSONOutput.DeclarationReflectio
                 continue;
             }
             if (param.type && "name" in param.type && param.type.name === "default" && "id" in param.type && param.type.id !== undefined) {
-                param.type.name = getName(param.type.id);
+                param.type.name = getName((param.type as { id: number; }).id);
             }
             construct.parameters.push({
                 name:     param.name,

diff --git a/src/docs/process/function.ts b/src/docs/process/function.ts
@@ -21,7 +21,7 @@ export default function processFunction(data: JSONOutput.DeclarationReflection,
                 continue;
             }
             if (param.type && "name" in param.type && param.type.name === "default" && "id" in param.type && param.type.id !== undefined) {
-                param.type.name = getName(param.type.id);
+                param.type.name = getName((param.type as { id: number; }).id);
             }
             func.parameters.push({
                 name:     param.name,

diff --git a/src/docs/process/method.ts b/src/docs/process/method.ts
@@ -29,7 +29,7 @@ export default function processMethod(data: JSONOutput.DeclarationReflection) {
                         continue;
                     }
                     if (param.type && "name" in param.type && param.type.name === "default" && "id" in param.type && param.type.id !== undefined) {
-                        param.type.name = getName(param.type.id);
+                        param.type.name = getName((param.type as { id: number; }).id);
                     }
                     overload.parameters.push({
                         name:     param.name,

diff --git a/src/docs/process/property.ts b/src/docs/process/property.ts
@@ -8,7 +8,7 @@ export default function processProperty(data: JSONOutput.DeclarationReflection)
         return;
     }
     if (data.type && "name" in data.type && data.type.name === "default" && "id" in data.type && data.type.id !== undefined) {
-        data.type.name = getName(data.type.id);
+        data.type.name = getName((data.type as { id: number; }).id);
     }
     const prop: Property = {
         comment:  data.comment?.summary.reduce((a, b) => a + b.text, ""),

diff --git a/src/docs/run.ts b/src/docs/run.ts
@@ -28,8 +28,26 @@ export default async function run(data: JSONOutput.ProjectReflection, version: s
     if (data.children) {
         for (const child of data.children) {
             if (child.kind !== ReflectionKind.Module) {
-                throw new Error(`Expected ${ReflectionKind[ReflectionKind.Module]} (${ReflectionKind.Module}), got ${ReflectionKind[child.kind]} (${child.kind}) for ${child.name} (${child.id})`);
+                switch (child.kind) {
+                    case ReflectionKind.Class: {
+                        const clazz = processClass(child, child.name);
+                        root.classes.push(clazz);
+                        break;
+                    }
+
+                    case ReflectionKind.Interface: {
+                        const iface = processInterface(child, child.name);
+                        root.interfaces.push(iface);
+                        break;
+                    }
+
+                    default: {
+                        throw new Error(`Unexpected kind ${ReflectionKind[child.kind]} (${child.kind}) for ${child.name} (${child.id})`);
+                    }
+                }
+                continue;
             }
+
             if (!child.children) {
                 continue;
             }
@@ -79,11 +97,16 @@ export default async function run(data: JSONOutput.ProjectReflection, version: s
                     }
 
                     case ReflectionKind.Reference: {
+                        if (child2.variant !== "reference") {
+                            console.debug(`Skipping ${child2.variant} ${ReflectionKind[child2.kind]} (${child2.kind}) for ${child2.name} (${child2.id})`);
+                            continue;
+                        }
                         const ref = processReference(child2 as JSONOutput.ReferenceReflection);
                         root.references.push(ref);
                         break;
                     }
 
+
                     // I can't be bothered to handle this right now
                     case ReflectionKind.Namespace: {
                         console.debug(`Skipping namespace ${child2.name} (${child2.id})`);

diff --git a/src/docs/saveNames.ts b/src/docs/saveNames.ts
@@ -4,7 +4,7 @@ import { type JSONOutput, ReflectionKind } from "typedoc";
 export default function saveNames(project: JSONOutput.ProjectReflection) {
     if (project.children) {
         for (const child of project.children) {
-            if (child.kind !== ReflectionKind.Module) {
+            if (![ReflectionKind.Module, ReflectionKind.Class, ReflectionKind.Interface].includes(child.kind)) {
                 throw new Error(`Expected ${ReflectionKind[ReflectionKind.Module]} (${ReflectionKind.Module}), got ${ReflectionKind[child.kind]} (${child.kind}) for ${child.name} (${child.id})`);
             }
             setName(child.id, child.name);

diff --git a/src/util/util.ts b/src/util/util.ts
@@ -19,6 +19,10 @@ export interface IConfig {
     };
     cookieSecret: string;
     dataDir: string;
+    degenerateWebhook: {
+        id: string;
+        token: string;
+    };
     docsWebhook: {
         id: string;
         token: string;