npm 包 changelog-verify 使用教程-JavaScript中文网-JavaScript教程资源分享门户

作为前端开发者，我们每天都需要与大量的依赖包打交道。一个好的依赖包不仅要解决问题，更要易于维护。而一个易于维护的依赖包必然需要一个完整、详细的变更日志。本文将介绍一款 npm 包 changelog-verify，它能够为我们快速生成变更日志，并且可以检测日志的格式是否正确。

安装

使用 npm 安装 changelog-verify。

npm install changelog-verify --save-dev

在 package.json 中的 scripts 中添加如下脚本。

"scripts": {
  "changelog-verify": "changelog-verify"
}

由于 changelog-verify 是一个全局变量，所以我们不必指定其路径即可直接运行。

现在，我们只需要在项目根目录下运行以下命令，即可得到一个自动生成的日志文件。

npm run changelog-verify

changelog-verify 可以通过参数来定制我们的变更日志。

例如，我们可以通过 npx changelog-verify --config=./config.json 来配置 changelog-verify。

配置文件 config.json 的内容如下。

{
  "owner": "changlog-verify",
  "repo": "test",
  "nextRelease": {
    "type": "minor",
    "name": "v0.2.0"
  }
}

其中，owner 和 repo 都是我们的项目信息，nextRelease 用于指定即将发布的版本。

除了自动生成日志文件，changelog-verify 还可以检查日志是否符合标准格式。

我们可以在 package.json 中的 scripts 中添加如下脚本。

"scripts": {
  "changelog": "conventional-changelog -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md"
}

运行 npm run changelog 命令后，即可自动生成 CHANGELOG.md 文件，并将其加入 git 索引。

使用 changelog-verify 检测日志文件的格式是否符合标准。

"scripts": {
  "changelog-verify": "changelog-verify check CHANGELOG.md"
}

通过以上的介绍，我们已经学会了使用 changelog-verify 自动生成变更日志，同时又可以使用 changelog-verify 来检测日志的格式是否正确。从而帮助我们更好地维护依赖包。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/5eedb53cb5cbfe1ea06113fc