前言
在前端开发过程中，我们经常会使用git作为代码版本管理工具。而commit message(提交信息)就是git中非常重要的一部分，因为它能够清晰地描述我们所做的修改，让其他人快速了解代码的变动。
然而，在日常开发中，许多人往往会忽略commit message的规范性，导致同一项目中不同人的commit message格式不一致。这种情况会给后续的代码维护和协作造成极大的麻烦。
为了解决这个问题，@satansdeer团队开发了一个npm包叫做git-cz，它可以帮助我们规范commit message的格式，这篇文章将为大家介绍如何使用这个工具。
安装
首先我们需要安装git-cz这个npm包，可以通过以下两种方式进行安装。
全局安装
全局安装的方式适用于所有git工程。
npm install -g @satansdeer/git-cz
项目内安装
对于个人开发项目，我们可以在项目内进行安装。
npm install --save-dev @satansdeer/git-cz
配置
安装完成后，我们需要配置git-cz。在项目的根目录下创建一个.czrc文件，文件内容如下：
{
"path": "node_modules/@satansdeer/git-cz/"
}或者在package.json中新增如下配置:
"config": {
"commitizen": {
"path": "node_modules/@satansdeer/git-cz/"
}
}这个配置将git-cz注册为我们的提交工具，使其可以在我们使用git commit命令时生效。
使用
使用git-cz提交代码的方式非常简单，只需使用git cz命令，会自动打开一个交互式界面，引导我们填写相关的提交信息。
# 若要提交代码 git cz
其中，交互式界面分为3个部分：type、scope和subject。
type
type用于描述本次提交的种类，它是一个必填项。git-cz内置了多种type，我们也可以根据需要自定义type，例如：
-- -------------------- ---- -------
--------- -
------------- -
------- -----------------------------------
-------- -
------- -
-------------- -------
-------- ----
-------- ------
--
------ -
-------------- --------
-------- -----
-------- -----
--
------- -
-------------- -------
-------- -----
-------- ------
--
-------- -
-------------- ---------
-------- -----
-------- -------
--
----------- -
-------------- -------
-------- -----
-------- ----------
--
------- -
-------------- -------
-------- -----
-------- ------
--
------- -
-------------- ------------
-------- -----
-------- ------
-
-
-
-在上述的type配置中，我们给每个type都配置了一个Emoji，方便其他人在阅读提交信息时快速了解本次提交的内容。除此之外，我们还给每个type写了一个description，描述了这个type所代表的含义。
scope
scope用于描述本次提交的范围，可以是任意字符串，如果不需要，可以直接按回车键跳过。
subject
subject用于描述本次提交的主题，也是一个必填项。我们需要简洁明了地描述本次提交的内容，使其他人能够快速地了解本次提交所做的修改。
示例
下面是一个使用git-cz提交代码的示例。
git cz
然后程序会自动引导你完成输入。
-- -------------------- ---- ------- ------- -- ----------- -- ----- ---- -- ---- ----- -- ----- ---- -- ------ ------ -- --------- ---- -- ----- ---- -- ----- --------- ----------------- ----------- ---- ---------- ----------- ----------
意义
通过使用git-cz，我们可以规范化我们的commit message格式，使得所有人的提交信息形式一致，方便后续代码的维护和协作。不仅如此，我们还可以自定义type，使得每个type都有自己的特点，增加一些个性，便于阅读。
总结
本文为大家介绍了如何使用npm包@satansdeer/git-cz来规范化我们的commit message格式。通过使用这个工具，我们能够定制化我们的提交信息，便于后续代码的维护和协作。希望大家都能够掌握这个工具，提高代码协作效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/satansdeer-git-cz