简介
npm 是前端开发经常使用的包管理工具，通过 npm 安装的包很多都是开源项目。有些好的开源项目，有着详细的变更记录，以及对应版本的一些 bug 修复、新增功能等信息，而这个信息记录通常是放在项目的 CHANGELOG.md 文件中。而 detect-repo-changelog 就是一个 npm 包，可以方便地侦测指定 npm 包的 CHANGELOG.md 文件，让我们能够简单快速地通过读取 CHANGELOG.md 来查看版本更新历史，更好地了解该 npm 包的变更过程和使用方法。
安装
使用 npm 安装 detect-repo-changelog
npm i --save-dev detect-repo-changelog
使用
下面我们以常用的 jQuery 库为例来演示 detect-repo-changelog 的使用。
加载模块
const detectRepoChangelog = require('detect-repo-changelog');基本使用方法
在 detectRepoChangelog 函数中传递 jQuery 的名称来检查该项目的 CHANGELOG 文件。
detectRepoChangelog('jquery').then((html) => {
console.log(html);
})
.catch((err) => {
console.log(err);
});上述代码的意思是检测 jQuery 的 CHANGELOG 文件并返回其内容。
强制获取 Github 中的 CHANGELOG.md
如果一个库并没有发布到 npm 但在 Github 上存在，那么就无法直接获取该库的 CHANGELOG 文件，如果使用 detectRepoChangelog 函数时遇到了这种情况，可以通过指定 github 的用户名、repo 名称、branch 名称（可选）来强制 detect-repo-changelog 获取 Github 上的该 npm 库的 CHANGELOG。
-- -------------------- ---- ------- -------------------------- - ----------- -------- ------- ------ --------- ----- -------------- -- - ------------------ -- ------------ -- - ----------------- ---
总结
detect-repo-changelog 是一个很有用的 npm 包，能够方便地帮助我们查看某个项目的版本更新历史，了解其变更过程。detect-repo-changelog 的使用也十分简单，只需传递 npm 包名称即可。当然，如果一个 npm 包仅仅存在于 Github 上而未发布到 npm 上时，也可以通过 detect-repo-changelog 来强制获取其 CHANGELOG 文件。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/detect-repo-changelog