使用Typedoc生成API文档时出现大量无关.d.ts文件报错如何解决？

你遇到的报错是TypeDoc默认启用了全量类型校验，会拉取node_modules下所有相关类型文件做检查，第三方类型版本冲突、语法不兼容都会触发报错，可通过以下方法解决：

• 方案1：直接跳过类型检查（最快生效）
  给执行命令添加--skipErrorChecking参数，TypeDoc会跳过所有类型校验，只基于你的源码结构生成文档，完全不会理会第三方类型报错：

  typedoc ./src/ts/api --out ./docs --skipErrorChecking
  

• 方案2：排除无关文件扫描
  可以通过参数或者配置文件指定排除node_modules目录，避免TypeDoc扫描第三方类型文件：
  1. 命令行传参方式：

     typedoc ./src/ts/api --out ./docs --exclude "node_modules/**/*"
     

  2. 配置文件方式：在项目根目录的tsconfig.json或typedoc.json中添加exclude配置：

     {
       "exclude": ["node_modules"]
     }
     

• 方案3：修复根因避免报错
  如果你不想跳过检查，可以针对性修复报错根源：
  1. 针对重复@types/react的冲突报错：在package.json中指定统一的@types/react版本，避免多版本共存。
     • pnpm/npm项目添加overrides配置：

       {
         "pnpm": { // npm项目直接把pnpm字段去掉，把overrides放在外层
           "overrides": {
             "@types/react": "你项目中使用的React对应类型版本"
           }
         }
       }
       

     • yarn项目添加resolutions配置：

       {
         "resolutions": {
           "@types/react": "你项目中使用的React对应类型版本"
         }
       }
       

     配置完成后重新安装依赖即可解决类型重复冲突。
  2. 针对第三方库类型语法报错：比如react-simplemde-editor的类型用了高版本TS才支持的语法，将项目的typescript依赖升级到最新LTS版本即可兼容。

内容的提问来源于stack exchange，提问作者Cutewarriorlover