Clean up some unnecessary any

Author: Gerrit0

src/lib/converter/comments/discovery.ts

@@ -52,7 +52,7 @@ const wantedKinds: Record<ReflectionKind, ts.SyntaxKind[]> = {
         ts.SyntaxKind.PropertySignature,
         ts.SyntaxKind.BinaryExpression,
         ts.SyntaxKind.PropertyAssignment,
-        // class X { constructor(/** Comment */ readonly z: any) }
+        // class X { constructor(/** Comment */ readonly z: string) }
         ts.SyntaxKind.Parameter,
     ],
     [ReflectionKind.Method]: [

src/lib/converter/plugins/CommentPlugin.ts

@@ -48,6 +48,8 @@ const NEVER_RENDERED = [
 /**
  * Handles most behavior triggered by comments. `@group` and `@category` are handled by their respective plugins, but everything else is here.
  *
+ * How it works today
+ * ==================
  * During conversion:
  * - Handle visibility flags (`@private`, `@protected`. `@public`)
  * - Handle module renames (`@module`)
@@ -68,6 +70,36 @@ const NEVER_RENDERED = [
  * - Copy auto inherited comments from heritage clauses
  * - Handle `@inheritDoc`
  * - Resolve `@link` tags to point to target reflections
+ *
+ * How it should work
+ * ==================
+ * During conversion:
+ * - Handle visibility flags (`@private`, `@protected`. `@public`)
+ * - Handle module renames (`@module`)
+ * - Remove excluded tags & comment discovery tags (`@module`, `@packageDocumentation`)
+ *
+ * Resolve begin (100):
+ * - Copy auto inherited comments from heritage clauses
+ * - Apply `@label` tag
+ *
+ * Resolve begin (75)
+ * - Handle `@inheritDoc`
+ *
+ * Resolve begin (50)
+ * - Copy comments on signature containers to the signature if signatures don't already have a comment
+ *   and then remove the comment on the container.
+ * - Copy comments for type parameters from the parent container (for classes/interfaces)
+ *
+ * Resolve begin (25)
+ * - Remove hidden reflections
+ *
+ * Resolve:
+ * - Copy comments to parameters and type parameters (for signatures)
+ * - Apply `@group` and `@category` tags
+ *
+ * Resolve end:
+ * - Resolve `@link` tags to point to target reflections
+ *
  */
 @Component({ name: "comment" })
 export class CommentPlugin extends ConverterComponent {

src/lib/models/types.ts

@@ -652,7 +652,7 @@ export class OptionalType extends Type {
  * Represents a type predicate.
  *
  * ```ts
- * function isString(anything: any): anything is string {}
+ * function isString(x: unknown): x is string {}
  * function assert(condition: boolean): asserts condition {}
  * ```
  */

src/lib/output/themes/MarkedPlugin.ts

@@ -196,7 +196,7 @@ output file :
         ) ?? {}) as Marked.marked.MarkedOptions;
 
         // Set some default values if they are not specified via the TypeDoc option
-        markedOptions.highlight ??= (text: any, lang: any) =>
+        markedOptions.highlight ??= (text, lang) =>
             this.getHighlighted(text, lang);
         markedOptions.renderer ??= customMarkedRenderer;
         markedOptions.mangle ??= false; // See https://github.com/TypeStrong/typedoc/issues/1395

src/lib/output/themes/default/assets/typedoc/utils/debounce.ts

@@ -1,7 +1,7 @@
-export const debounce = (fn: Function, wait: number = 100) => {
+export const debounce = (fn: () => void, wait: number = 100) => {
     let timeout: ReturnType<typeof setTimeout>;
-    return (...args: any[]) => {
+    return () => {
         clearTimeout(timeout);
-        timeout = setTimeout(() => fn(args), wait);
+        timeout = setTimeout(() => fn(), wait);
     };
 };

src/lib/utils/plugins.ts

@@ -4,6 +4,7 @@ import * as Path from "path";
 import type { Application } from "../application";
 import type { Logger } from "./loggers";
 import { nicePath } from "./paths";
+import { validate } from "./validation";
 
 export function loadPlugins(app: Application, plugins: readonly string[]) {
     if (plugins.includes("none")) {
@@ -97,7 +98,7 @@ export function discoverPlugins(app: Application): string[] {
 /**
  * Load and parse the given `package.json`.
  */
-function loadPackageInfo(logger: Logger, fileName: string): any {
+function loadPackageInfo(logger: Logger, fileName: string): unknown {
     try {
         return require(fileName);
     } catch {
@@ -111,20 +112,13 @@ const PLUGIN_KEYWORDS = ["typedocplugin", "typedoc-plugin", "typedoc-theme"];
 /**
  * Test whether the given package info describes a TypeDoc plugin.
  */
-function isPlugin(info: any): boolean {
-    if (typeof info !== "object" || !info) {
+function isPlugin(info: unknown): boolean {
+    if (!validate({ keywords: [Array, String] }, info)) {
         return false;
     }
 
-    const keywords: unknown[] = info.keywords;
-    if (!keywords || !Array.isArray(keywords)) {
-        return false;
-    }
-
-    return keywords.some(
-        (keyword) =>
-            typeof keyword === "string" &&
-            PLUGIN_KEYWORDS.includes(keyword.toLocaleLowerCase())
+    return info.keywords.some((keyword) =>
+        PLUGIN_KEYWORDS.includes(keyword.toLocaleLowerCase())
     );
 }