git提交规范

[txw2018]

我们在用git提交代码的时候，希望生成规范的commit message，所以我们需要借用根据工具规范我们的提交信息
目前社区用的最广泛的就是Angular 规范，

<type, 必填>(<scope，可省略>): <subject，必填>
// 空一行
<body，可省略>
// 空一行
<footer，可省略>

• type: commit 的类型
• feat: 新特性
• fix: 修改问题
• refactor: 代码重构
• docs: 文档修改
• style: 代码格式修改, 注意不是 css 修改
• test: 测试用例修改
• chore: 其他修改, 比如构建流程, 依赖管理.
• scope: commit 影响的范围, 比如: route, component, utils, build...
• subject: commit 的概述, 建议符合 50/72 formatting
• body: commit 具体修改内容, 可以分为多行, 建议符合 50/72 formatting
• footer: 一些备注, 通常是 BREAKING CHANGE 或修复的 bug 的链接.

Commitizen: 替代你的 git commit

commitizen/cz-cli, 我们需要借助它提供的 git cz 命令替代我们的 git commit 命令, 帮助我们生成符合规范的 commit message.

除此之外, 我们还需要为 commitizen 指定一个 Adapter 比如: cz-conventional-changelog (一个符合 Angular团队规范的 preset). 使得 commitizen 按照我们指定的规范帮助我们生成 commit message.
安装

npm install -D commitizen cz-conventional-changelog

package.json配置

  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  }

Commitlint: 校验你的 message

commitlint: 可以帮助我们 lint commit messages, 如果我们提交的不符合指向的规范, 直接拒绝提交, 比较狠.
同样的, 它也需要一份校验的配置, 这里推荐 @commitlint/config-conventional (符合 Angular团队规范).

安装

npm i -D @commitlint/config-conventional @commitlint/cli

同时需要在项目目录下创建配置文件 .commitlintrc.js, 写入:

module.exports = {
  extends: [
    ''@commitlint/config-conventional''
  ],
  rules: {
  }
};

结合 Husky

校验 commit message 的最佳方式是结合 git hook, 所以需要配合 Husky.

安装

npm install husky --save-dev

启用 Git 挂钩

npx husky install

要在安装后自动启用 Git 挂钩，请编辑package.json

  "scripts": {
    "prepare": "husky install"
  },

添加钩子

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

这时你根目录就有有个.husky文件,里面有配置

现在如果是你commit message 不规范的话就会拒绝提交，husky还能配合Eslint限制eslint报错拒绝提交

学习文章