npm 包 commit-msg-must-use-emoji 使用教程

作为前端开发者，我们不仅需要关注代码质量和规范，还需要注重 git commit message 的规范，今天我们来介绍一款 npm 包 commit-msg-must-use-emoji，它可以校验 commit message 是否符合规范，规定我们必须要使用表情符号（emoji）进行开发。本文将详细解释如何使用这个 npm 包。

准备工作

在使用 commit-msg-must-use-emoji 之前，我们需要安装 git 和 npm，安装过程不再赘述。

安装

运行以下命令安装 commit-msg-must-use-emoji：

npm install -D commit-msg-must-use-emoji

在 package.json 文件中添加以下配置：

{
  "husky": {
    "hooks": {
      "commit-msg": "commit-msg-must-use-emoji"
    }
  }
}

使用

在 commit 时，我们需要添加 emoji，例如下面以增加一个新功能为例，提交的 commit message 应该是这样的：

:sparkles: 添加了一个新功能

为方便大家演示和使用，我们可以新建一个 Git 仓库，并运行以下命令初始化：

git init

npm init -y

npm install -D husky

输入命令后，我们可以打开 package.json 文件，加入以下配置：

{
  "husky": {
    "hooks": {
      "commit-msg": "commit-msg-must-use-emoji"
    }
  }
}

然后，在终端输入以下命令，安装 commit-msg-must-use-emoji：

npm install -D commit-msg-must-use-emoji

添加文件并提交：

touch index.js

git add .

git commit -m ":sparkles: 添加新功能"

如果未使用 emoji，或者使用了不规范的 emoji，提交将无法成功。

规范 emoji

commit message 中需要使用标准的 emoji，如下表所示：

总结

git commit message 的规范化是一个质量管理问题。如果所有开发者都能遵循同样的规范，有助于保证代码的可读性和可维护性，使工作更加高效和一致。

在开发前，我们需要根据项目的实际情况制定一套规范，并通过工具来帮助我们实现规范和校验，以避免偏离和 代码质量下降，commit-msg-must-use-emoji 就是一款很好的辅助工具。

以上就是 commit-msg-must-use-emoji 的使用教程，如果您对表情符号的使用还有不明白的地方，可以去 Emoji 官网，里面有详细介绍。祝大家 coding 顺利。

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