如何从 tsdoc / typedoc 中正确排除测试文件

如何解决如何从 tsdoc / typedoc 中正确排除测试文件

我正在测试一些各种文档引擎，我想为我们的大型项目尝试使用 typedoc。我们在整个项目中有各种测试文件（somefile.test.ts 或 someotherfile.test.tsx）。我正在努力让 typedoc 忽略这些文件。我做了 npm i -D typedoc，然后在我的 tsconfig.json

{
  "compilerOptions": {
    "configOptions": "some_options"
  },"include": ["src"],"typedocoptions": {
    "out": "docs","entryPoints": "src/index.tsx","exclude": [
      "**/*.test.ts*","**/*.test.tsx*"
    ]
  }
}

然后我运行我的 npm 命令 "tsdoc": "typedoc" - npm run tsdoc。 Typedoc 遍历我的文件并在我的测试文件中发现了大量的打字稿检查错误，因此它无法运行。 （我们最近更新了 @types/jest，所以 eslint 和 ts 抱怨 Property 'toEqual' does not exist on type 'Assertion' 和 Property 'toMatchSnapshot' does not exist on type 'Assertion' 之类的东西。eslint 和 ts 抱怨这些东西，但它不会阻止测试运行. 但是我的 typedocoptions 没有正确忽略这些文件有什么问题？

解决方法

这完全是一头雾水，但我会猜测 typedoc 在尝试生成文档之前运行 tsc，以创建文件之间的链接。如果 tsc/eslint 出现错误，它可能无法检查要排除哪些文件。

我建议您调查一下 Jest 升级为何会爆炸的原因。一旦编译器/linting 错误消失，我想 typedoc 会合作。您也可以告诉 tsc/eslint 忽略这些文件，但我想不编译测试文件会导致进一步的问题。