【问题标题】:Typedoc: document only things exported by a specific fileTypedoc:仅记录特定文件导出的内容
【发布时间】:2020-04-27 07:56:16
【问题描述】:

我正在开发两个 npn 包:

我想使用 typedoc 来记录它们。 index.js文件是npm模块提供的,通过index.ts获取。

我只想记录库 index.ts 导出的内容。我可以使用 typedoc 选项过滤未导出的内容。

问题在于 index.ts 从其他 TS 文件中导入内容并仅导出其中的一部分。例如,它从interfaces/index.ts 导入和重新导出一些接口,从errors/index.ts 导入和重新导出错误类,但在不从utils/database/index.ts 导出类Database 的情况下导入。

在实际导出时,即使数据库类是由不同于 index.ts 的文件导出的,也会记录在案。

如何过滤它们?

【问题讨论】:

  • 在 v0.17(目前是typedoc@next 下的测试版)中,--mode library 可以实现这一点
  • 谢谢,我在 github repo 的项目部分注意到了。这什么时候会成为稳定版本的一部分?
  • 我希望这个月能发布它,不过现在回到学校了,所以我没有太多时间去做。

标签: node.js typescript npm typedoc


【解决方案1】:

当前@next 版本的 typedoc 具有 --library 模式。 @beta 版本和未来的 1.0.0 版本似乎会有很大的变化,模式选项甚至会消失。开发似乎进展得非常缓慢,所以我认为现在唯一的方法是使用(可能有错误的)@next 和 @beta 版本并等待。

编辑:0.20.x 不再是测试版并且已经发布,它运行良好,所以问题解决了

【讨论】:

  • 我想我应该非常慢...不过现在已经出来了!
  • 抱歉,我有一些库正在等待稳定的库模式。现在我尝试了它并且它有效,我认为有一个很好的改进。有没有办法仍然使用旧的方式(“模块”模式),以便有一个版本供谁使用该库和另一个版本供谁开发它?
  • "modules" 模式是真正的库模式,入口点是项目中的每个文件
猜你喜欢
  • 2010-11-08
  • 2021-01-23
  • 1970-01-01
  • 2014-02-09
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2015-04-11
  • 1970-01-01
相关资源
最近更新 更多