随着前端应用不断增多，我们面临的代码质量问题变得越来越重要。要保证代码质量，让代码风格统一，我们可以使用 gw-commit-lint 这个 npm 包来进行代码审查和约束。
什么是 gw-commit-lint
gw-commit-lint 是一个基于 Git commit message 的规范性检查工具。它可以检查我们的 commit message 是否符合预先定义的规范。
安装
首先，需要全局安装 gw-commit-lint：
npm install -g gw-commit-lint
使用
安装完成后，我们可以在项目的根目录下进行如下配置：
在 package.json 中，添加如下配置：
"commitlint": {
"extends": [
"@guangzhou/preset-config-gitlly"
],
"rules": {}
}这里选用了 @guangzhou/preset-config-gitlly 这个 preset，也就是预先配置好了一些常用的规则和错误提示，可以在根目录下的 commitlint.config.js 中进行配置。
为了使我们的每一次 Git commit 都能受到检查，我们可以在 package.json 的 scripts 中添加：
"scripts": {
"commitmsg": "commitlint -E HUSKY_GIT_PARAMS"
}这样在每次进行 Git commit 操作时，gw-commit-lint 都会对我们的 commit message 进行检查，确保格式规范。
指南
gw-commit-lint 已经提供了一些配置模板，我们只需要在其基础上进行修改即可。以下是一些常用的规则指南：
【规则1】[feat] 新特性/功能
git commit -m "feat: add new feature A"【规则2】[fix] bug 修复
git commit -m "fix: fix bug A"【规则3】[docs] 文档更新
git commit -m "docs: add/update document A"【规则4】[style] 代码格式/样式调整
git commit -m "style: update code style A"【规则5】[refactor] 代码重构
git commit -m "refactor: refactor code A"【规则6】[test] 测试相关
git commit -m "test: add test for feature A"【规则7】[chore] 构建/工具/文档等其他更新
git commit -m "chore: update build script A"
以上是一些常见的规则设定，也可以根据自身项目的实际情况进行修改。
示例代码
git commit -m "feat: 新增功能A"
在使用中，如果发现不符合规则，会收到如下警告信息：
✖ 1 problem (1 error, 0 warnings) ℹ︎ 你的 commit 信息 "新增功能A" 不符合规范.
祝大家使用 gw-commit-lint 愉快，早日拥有代码质量信仰！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671a430d0927023822434