在升级之前如何查看 npm 包的发行说明？

Question

npm 注册表是否以标准化方式公开发行说明？我在以下位置看过发行说明：

• 自述文件.md
• 在 GitHub 上作为标记版本，没有描述
• 在 GitHub 上作为带有描述的标记版本

虽然 SemVer 至少让我知道是否有重大更改，但如果能够查看软件包作者可能添加的功能或错误修复，那就太好了。

Answer 1

不存在这样的标准化，因为完全由项目开发人员来定义如何传达此类信息。有些可能有

NEWS

文件，其他人可能有

Changelog.md

，或者其他人可能在您提到的位置有它。位置和文件格式可能有很大差异。

npm 可能会采用一些可选的东西，可以使用某种固定的命名方案自动显示一些纯文本文件（如果在

package.json

中定义了 git 存储库，则可能会回退到 git diff），但截至目前写的没有这个功能。

Answer 2

我创建了 https://www.npmjs.com/package/@readachangelog/cli 来解决这个问题。

你可以运行：

readachangelog outdated

并获取包含相关 CHANGELOG.md 条目摘录的 Markdown 报告。

请参阅自述文件中的限制，因为大多数包都无法使用此工具，因为大多数包没有 CHANGELOG.md。