npm 包 @citycide/cz-conventional 使用教程

阅读时长 3 分钟读完

1. 简介

@citycide/cz-conventional 是一个 npm 包,用于在 git commit 时规范化 commit message。该包按照 conventional commit 的规范来生成 commit message,配合工具可以用于提交代码,同时也方便地生成 CHANGELOG

2. 安装

3. 使用方法

使用 @citycide/cz-conventional 需要先安装相关工具,比如 commitizen

3.1. 配置

安装完相关工具后,需要对项目进行配置,才能开始使用 @citycide/cz-conventional

创建项目根目录下的 .czrc.js 文件,加入以下代码:

3.2. 使用

安装完 commitizen 并配置项目后,就可以愉快地在终端使用了。输入以下命令,使用 commitizen

按步骤填写之后,就可以生成规范的 commit message 了。

3.3. change log

使用 @citycide/cz-conventional 不仅可以生成规范的 commit message ,还可以方便地生成 CHANGELOG。只需要在 package.json 文件中加入以下代码:

之后,就可以使用以下代码来生成 CHANGELOG 了:

4. 示例

例如,我们提交一次代码:

然后按步骤操作,填写信息:

完成后,就可以在 git log 中,看到这样一个规范的 commit message

5. 总结

@citycide/cz-conventional 可以快速规范化 commit message,同时也方便生成 CHANGELOG。它符合开源社区上的 conventional commit 规范,并且使用方便。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005582c81e8991b448d55a1

纠错
反馈

纠错反馈