TypeDoc无法识别TypeScript静态块语法报错问题咨询

问题原因 #

TypeScript 类静态块是4.4版本新增、ES2022标准正式纳入的语法，你遇到的解析报错和两个配置疏漏有关：

1. 项目tsconfig中target设置为ES6，该版本标准未纳入静态块语法，TS解析器按低版本规则校验时会直接抛出语法错误
2. 执行命令时如果没有显式指定加载本地tsconfig，TypeDoc可能不会读取项目内的TS编译配置；若本地未安装≥4.4版本的TypeScript，TypeDoc调用的内置解析器版本过低也会无法识别该语法

解决步骤 #

• 调整tsconfig.json编译配置
  将compilerOptions下的target字段修改为ES2022及以上，移除配置中多余的尾逗号避免JSON解析异常，修改后参考配置如下：

{
  "compilerOptions": {
    "module": "ES2020",
    "target": "ES2022",
    "sourceMap": true,
    "outDir": "build"
  },
  "include": [
    "src/**/*"
  ]
}

• 确认本地TypeScript版本符合要求
  在项目根目录执行npm ls typescript，查看安装的TypeScript版本是否在4.4~4.7区间内，如果版本过低或者未安装，执行如下命令安装兼容版本：
  npm install typescript@4.7 --save-dev
• 调整TypeDoc执行命令
  执行生成命令时显式指定读取本地tsconfig配置，避免绕过项目编译规则，正确命令如下：
  npx typedoc --tsconfig tsconfig.json --out html src/hello.ts

配置完成后重新执行命令，即可正常解析包含静态块的TS文件，不会再抛出语法错误。

内容的提问来源于stack exchange，提问作者Adam Gawne-Cain