Git Commit 提交规范，变更日志、版本发布自动化和 Emoji 提交标准

前言

Git Commit 是开发的日常操作, 一个优秀的 Commit Message 不仅有助于他人 Review, 还可以有效的输出 CHANGELOG, 对项目的管理实际至关重要, 但是实际工作中却常常被大家忽略，希望通过本文，能够帮助大家规范 Git Commit，并且展示相关 Commit 工具库或包，及相关变更日志和版本发布自动化工具

规范格式

那么如何能优雅而又不失体面的提交你的代码呢？其实我们的 git commit message 是应该具备一些规范的。目前规范用的比较多的是 Angular 团队的规范

message 样例：

text 复制代码

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Type：必须是下列之一
- feat：一个新功能
fix：bug 修复
- docs：编辑文档
- style：不影响代码含义的更改 (空格、格式、缺少分号等，不是 css 的更改)
- refactor：既不修复 bug 也不添加特性的代码更改
- perf：提高性能的代码更改
- test：添加缺失的或纠正现有的测试
- chore：对构建过程或辅助工具和库 (如文档生成)的更改
Subject：主题包含对变更的简洁描述
Body：具体的修改内容，可以包括与之前的对比
Footer：通常是 BREAKING CHANGE 或修复的 issue 链接

简介

commitizen git commit 格式化工具, 为我们提供标准化的 commit 信息。帮助我们统一项目 commit ，便于信息的回溯或日志的生成。# commit message 格式

commitizen 只是提供一个 commit 格式化或交互工具, 最终需要输出符合 commit 规则的信息给 git，所以需要线了解 commit 格式规则

安装

bash 复制代码

npm install -D commitizen cz-conventional-changelog

package. json 中添加

bash 复制代码

  "scripts": {
  	...
    "commit": "git-cz"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  }

自定义 Adapter

如果 Angular 的规范不符合我们的实际，同样我们也可以通过 cz-customizable 定制一套符合自己或者团队的规范。

bash 复制代码

npm install -D cz-customizable

同时 package. json 需要修改

json 复制代码

"config": {
  "commitizen": {
    "path": "node_modules/cz-customizable"
  }
}

之后对应项目目录下创建 .cz-config. js 文件，用来维护自己的格式

官网中有对应的样例配置文件：cz-customizable/cz-config-EXAMPLE.js at master · leoforfree/cz-customizable · GitHub

校验 Message

工具：

可以做到如果不符合校验规范，就会直接拒绝 commit 请求

安装

bash 复制代码

# Angular 团队的规范
npm install -D @commitlint/config-conventional @commitlint/cli
# 自定义规范
npm install -D commitlint-config-cz @commitlint/cli

配置文件

在项目目录下创建配置文件 .commitlintrc. js

Angular 团队的规范

js 复制代码

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

自定义规范

bash 复制代码

module.exports = {
  extends: [
    'cz'
  ],
  rules: {
  }
};

Husky

在做前端工程化时 husky 可以说是一个必不可少的工具。husky 可以让我们向项目中方便添加 git hooks。

官方链接：typicode/husky: Git hooks made easy 🐶 woof! (github.com)

安装

sh 复制代码

npm install -D husky

配置

package. json 中添加：

json 复制代码

"husky": {
    "hooks": {
      ...,
      "commit-msg": "commitlint -e $GIT_PARAMS"
    }
  },

或者在 .huskyrc 文件中

json 复制代码

{
  "hooks": {
    ...,
    "commit-msg": "commitlint -e $GIT_PARAMS"
  }
}

Git Commit 提交规范，变更日志、版本发布自动化和 Emoji 提交标准

前言

规范格式

简介

安装

自定义 Adapter

校验 Message

工具：

安装

配置文件

自定义规范

Husky

安装

配置

自动化生成

变更日志（Changelog）