【问题标题】:Typedoc throws error with a node_modules package.jsonTypedoc 使用 node_modules package.json 引发错误
【发布时间】:2018-11-01 01:00:42
【问题描述】:

我是使用 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

我不明白为什么 Typedoc 会查看 node_modules/ 而我指定在 src/ 上生成文档(两者都在同一级别)。

我也尝试用--exclude "**/node_modules/**/*"--externalPattern "**/node_modules/**/*" 排除node_modules,但它似乎什么也没做。

如果有人可以帮助/解释我为什么会这样,我会很感激他/她。

【问题讨论】:

    标签: typedoc


    【解决方案1】:

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

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

    另见gitter conversation

    【讨论】:

      猜你喜欢
      • 2016-09-30
      • 1970-01-01
      • 2018-02-11
      • 1970-01-01
      • 2023-03-29
      • 2021-01-05
      • 1970-01-01
      • 2020-09-26
      • 2021-03-25
      相关资源
      最近更新 更多