React TypeScript项目package.json中--tsconfig参数的作用是什么？

核心解答 #

你误解了--tsconfig参数的所属命令，它和rimraf没有任何关系。你给出的docs脚本是两段通过&&连接的独立命令，&&表示只有前一段命令执行成功，才会执行后一段命令：

"docs": "rimraf typedoc.json && typedoc --tsconfig"

• 前半段rimraf typedoc.json的作用就是删除项目根目录下的typedoc.json配置文件，这一步执行完毕后就结束，没有后续参数，所以你看不到rimraf和tsconfig相关的操作是完全正常的。
• 后半段typedoc --tsconfig才是--tsconfig参数的归属，它是TypeDoc工具的入参。

--tsconfig参数的具体作用 #

TypeDoc是专门为TypeScript项目生成API文档的工具，--tsconfig参数用于指定文档生成时要遵循的TypeScript编译配置文件路径：

• 如果参数后没有填写具体路径，TypeDoc会默认读取项目根目录下的tsconfig.json文件
• 文档生成的全过程会完全遵循该tsconfig中的配置，比如包含哪些文件、忽略哪些文件、类型校验规则等，保证最终生成的文档内容和项目实际编译逻辑一致。

额外补充：为什么要先删除typedoc.json #

如果项目根目录存在typedoc.json文件，TypeDoc会默认优先读取该文件的配置，脚本先删除这个文件，就是为了避免旧的TypeDoc配置覆盖预期的tsconfig关联逻辑，保证文档生成完全按照tsconfig的规则执行。

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