TypeDoc 中如何优雅地展开复杂类型别名

在 TypeScript 项目中，我们经常会使用各种类型工具如 Awaited、ReturnType 和 typeof 来构建复杂的类型别名。这些类型虽然功能强大，但在文档生成工具 TypeDoc 中默认展示的形式往往不够直观，无法直接体现其最终形态。本文将深入探讨如何在 TypeDoc 中优雅地展开这些复杂类型别名，使其文档展示更加清晰易读。

问题背景

开发者在定义类型时，经常会写出类似这样的代码：

export type Product = Awaited<ReturnType<typeof getProduct>>;

默认情况下，TypeDoc 生成的文档会原样显示这个类型表达式，而不是展示其展开后的实际类型结构。这对于阅读文档的用户来说不够友好，因为他们无法直接看到这个类型最终代表的具体数据结构。

解决方案

TypeDoc 提供了 @interface 标签来解决这个问题。通过在类型别名前添加这个标签，可以指示 TypeDoc 展开并显示该类型的实际结构：

/** @interface */
export type Product = Awaited<ReturnType<typeof getProduct>>;

这样生成的文档会显示展开后的接口形式，而不是原始的类型表达式。

特殊情况处理

当处理返回数组类型的函数时，@interface 标签会产生一个包含所有数组方法的完整接口定义。例如：

function doSth() {
  return [{ abc: 123 }];
}

/** @interface */
export type DoSth = ReturnType<typeof doSth>;

这种情况下，文档会显示完整的数组接口定义，包括所有数组方法。虽然这在技术上是准确的，但对于文档阅读者来说可能信息量过大。

高级自定义方案

对于希望更精确控制类型展示方式的开发者，可以创建 TypeDoc 插件来实现自定义的类型展开逻辑。以下是一个示例插件代码，它添加了一个新的 @useHoverType 标签，可以按照 TypeScript 语言服务中悬停提示的方式展开类型：

import td, { ReflectionKind } from "typedoc";

const TAG = "@useHoverType";

export function load(app) {
    app.on(td.Application.EVENT_BOOTSTRAP_END, () => {
        const tags = [...app.options.getValue("modifierTags")];
        if (!tags.includes(TAG)) {
            tags.push(TAG);
        }
        app.options.setValue("modifierTags", tags);
    });

    app.converter.on(td.Converter.EVENT_CREATE_DECLARATION, (context, decl) => {
        const symbol = context.project.getSymbolFromReflection(decl);

        if (!decl.kindOf(ReflectionKind.TypeAlias) || !decl.comment?.hasModifier(TAG) || !symbol) {
            return;
        }

        decl.comment.removeModifier(TAG);
        const type = context.checker.getDeclaredTypeOfSymbol(symbol);
        decl.type = context.converter.convertType(context.withScope(decl), type);
    });
}

这个插件实现了类似于 TypeScript 语言服务中悬停提示的类型展示方式，可以产生更简洁的类型表示。

最佳实践建议

1. 对于简单的对象类型，优先使用 @interface 标签
2. 对于数组类型，考虑是否真的需要展示完整接口，或者可以手动定义更简洁的类型
3. 对于需要精确控制展示形式的场景，可以使用自定义插件
4. 注意类型展开的稳定性，因为 TypeScript 的类型展示方式可能随版本变化

通过合理运用这些技术，开发者可以生成更加清晰、有用的类型文档，提升项目的可维护性和协作效率。