Typedoc使用node_modules package.json

时间:2018-10-23 06:15:57

标签: typedoc

我对使用Typedoc感到很陌生,并且遇到抛出错误的麻烦。

当我在项目中运行Typedoc时,会正确生成该文档,但也会出现错误:

$ ./node_modules/.bin/typedoc --mode file --module commonjs --out ./docs/typescript --target es5 src/ Error: Could not parse /home/michael/workspace/test/node_modules/paralleljs/package.json

当我指定在src /上生成文档时,我不理解为什么Typedoc会查看node_modules /(两者处于同一级别)。

我还尝试用node_modules--exclude "**/node_modules/**/*"排除--externalPattern "**/node_modules/**/*",但似乎无济于事。

如果有人可以帮助/解释我为什么这样做,我将不胜感激。

1 个答案:

答案 0 :(得分:0)

Typedoc将从项目的依赖项中读取类型信息,因此它将查看node_modules目录。避免这种情况的最佳方法是排除node_modules目录(请参见错误#313)。

TypeDoc还looks at当前项目的package.json文件,因此也需要使用有效的JSON。

另请参见gitter conversation