NPM 包 @talentui/cz-package-changelog 使用教程

介绍

@talentui/cz-package-changelog 是一个用于自动生成 CHANGELOG.md 文件的 NPM 包。CHANGELOG.md 文件用于记录项目的版本历史和修改内容，方便项目维护和协作开发。使用 @talentui/cz-package-changelog 包可以简化生成 CHANGELOG.md 文件的流程。

该包基于 commitizen 工具和 cz-conventional-changelog 插件进行封装，使用时需要先配置 commitizen 。

安装

使用 NPM 进行安装：

npm install -D @talentui/cz-package-changelog

配置

package.json

在项目的 package.json 中添加如下配置：

-- -------------------- ---- -------
-
  --------- -
    ------------- -
      ------- ---------------------------------------------
    -
  --
  ---------- -
    ------------ ----------------------- -- ------- -- ------------ ---
  -
-

说明：

• config.commitizen.path：指定使用 @talentui/cz-package-changelog 包作为 commitizen 的插件。
• scripts.changelog：用于生成 CHANGELOG.md 文件的脚本。

.czrc

在项目的根目录中添加.czrc 文件，内容如下：

{
  "path": "./node_modules/@talentui/cz-package-changelog"
}

说明：

• path：指定使用 @talentui/cz-package-changelog 包作为 cz-conventional-changelog 的插件。

使用

在进行代码提交前，使用 npm run changelog 命令生成 CHANGELOG.md 文件，同时根据提示输入提交信息，并选择相应的提交类型。提交类型规范参考：Conventional Commits specification

示例：

git add .
npm run changelog
git commit -m "feat: add new feature"
git push

学习与指导意义

• 学习如何在项目中使用 NPM 包。
• 学习如何使用 commitizen 和 cz-conventional-changelog 进行规范化的代码提交和 CHANGELOG.md 生成。
• 学习 Conventional Commits specification，规范化代码提交的方式提高代码可读性、可维护性，并便于更好的和协作者协作。
• 学习代码组织与管理的最佳实践。

示例代码

示例代码可参考React UI 项目的配置文件。

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