在哪里可以找到常见 Node.js 模块的发行说明/变更日志

问题描述 投票:0回答:2

我可能错过了一些简单的东西,但我似乎找不到流行 Node 模块的最新版本中发生的变化。 Express、Connect、Stylus 等...

我意识到由维护者来编写变更日志,但并不是每个人都这样做。我查看提交,但这通常没有太大帮助,因为我不太熟悉给定代码行的用途,除非它很明显。如果有一个列表(通常很短)以(相对)简单的语言说明这些更改对我作为代码的使用者意味着什么,那就非常方便了。像这样的东西:http://aws.amazon.com/releasenotes/2817276026948755

我是否遗漏了一些东西,或者大多数模块都没有得到这些(大概是因为人们很忙,我应该花时间深入研究源代码)?

node.js module npm changelog
2个回答
3
投票

不幸的是,许多模块作者没有包含任何变更日志或历史记录。不过,幸运的是,一些最受欢迎的产品确实如此。

无独有偶,您发布的所有内容均由 TJ Holowaychuk 撰写,他在更新他命名的文件中的变更日志方面做得很好

History.md

查找名为

history.md
changelog.md
之类的文件,否则您将陷入提交日志中。我希望这对一些人有帮助。


0
投票

NPM 不存储变更日志信息,也不需要它,请参阅 RFC 讨论 https://github.com/npm/rfcs/discussions/505.

但是,有一些工具可以提供帮助。这里有两个需要考虑的:

  • https://www.npmjs.com/package/changelog 将使用公共 GitHub 存储库中的提交来打印更改。这不会读取 CHANGELOG.md,并且不适用于非公共或非 GitHub 存储库。
  • https://www.npmjs.com/package/@readachangelog/cli 将使用 NPM CLI 可以访问的任何注册表中的任何包中的 CHANGELOG.md 文件打印更改。这不会读取提交历史记录,并且如果包没有更改日志则不起作用,请参阅项目中的限制。

在我的搜索中,我发现了一些类似的包,例如 keepachangelog 等,但它们似乎都与读取公共 GitHub 提交的更新日志项目相同。我很高兴听到任何替代方案。

免责声明:我是 readachangelog CLI 的作者,我创建该 CLI 是出于快速查看多个包之间的更改的需要。如果我发现已经存在替代方案,我会很乐意弃用该项目。

© www.soinside.com 2019 - 2024. All rights reserved.