在前端开发中，使用 git 进行团队协作是非常常见的，而 commit message 是 git 协作中非常重要的一部分。cz-conventional-changelog-befe 是一个 npm 包，它提供了一套符合约定的 commit message 规范及其对应的 changelog 自动生成。
本篇文章将会介绍 cz-conventional-changelog-befe 的使用方法并提供样例代码。
为什么需要 cz-conventional-changelog-befe
在多人协作开发中，使用统一的 commit message 规范可以增加代码版本管理的可读性和可维护性。
cz-conventional-changelog-befe 遵循 Angular 团队的提交 message 格式约定，并且可以自动生成符合规范的 changelog，简化维护工作，提高团队开发效率。
起步
安装
安装 cz-conventional-changelog-befe：
--- ------- -- ------------------------------
配置
添加配置文件 .czrc 到项目的根目录下：
- ------- -------------------------------- -
确定好配置之后，它会自动读取此配置文件，并覆盖自己的默认行为。
使用
运行 git cz 命令来替代默认的 git commit 命令。
规范
cz-conventional-changelog-befe 使用了 Angular 团队的提交 message 格式，该格式约定包括以下几个部分：
[<type>][optional scope]: <description> [optional issue]
其中，各部分所代表的含义如下：
type（必填）：此次提交的类型，常见的包括以下几种：feat：新功能（feature）fix：修复 bugdocs：文档更新style：代码样式（不影响功能）refactor：代码重构（不涉及功能、 bug 修复）perf：性能优化test：测试相关chore：构建过程或辅助工具变动
scope（可选）：本次提交涉及到的模块或文件等description（必填）：本次提交的简要描述，首字母大写issue（可选）：本次提交出现了和哪个 issue 相关
例如：feat: add new feature 或 chore(config): update webpack config。
自动生成 changelog
在进行一次版本发布之前，需先生成 changelog 以便更好地向用户展示本次更新的内容。cz-conventional-changelog-befe 自动将 commit message 转换成格式化良好的 changelog。
安装
使用 npm 安装 cz-conventional-changelog-befe：
--- ------- -- --------------------------
使用
运行 conventional-changelog 命令，将生成 changelog。默认情况下，它会将所有的提交记录转换为 markdown 格式的 changelog，并将其存储在 /CHANGELOG.md 文件中：
---------------------- -- ------- -- ------------ --
其中：
-p：使用提交 message 格式规范，此处选择 Angular 团队的提交 message 格式规范。-i：指定 changelog 文件名。-s：从第一个 commit 记录生成 changelog，而不是从最新版本 tag 之后的记录开始。
结语
在本文中，我们介绍了什么是 cz-conventional-changelog-befe，以及在前端开发中的重要性。我们还提供了该包的安装、配置、使用说明，并提供了样例代码帮助大家更好地了解使用方法。
使用 cz-conventional-changelog-befe 可以让我们更好地管理代码的版本，增加代码的可读性和可维护性，并且方便用户查看版本更新信息。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/600668e2d9381d61a35409ab