现在大部分公司和项目用的代码管理工具基本都是git，在一个大的项目组中，会涉及很多的开发人员，这就会面临着频繁的提交代码。规范的提交代码规则会有利于问题的查找和回归，所以提交规范变得尤其的重要。下面我会为大家介绍一下，关于git的代码提交规则的约束工具：commitlint和husky。

一、commitlint 链接

1、安装

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

2、生成commitlint配置文件

项目根目录下执行：

echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

可以在这个文件里设置自定义的git提交message的规则。

3、常用的commit message的类型

feat - A new feature.
fix - A bug fix.
docs - Documentation only changes.
style - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
refactor - A Code change that neither fixes a bug nor adds a feature.
pref - A code change that improves performance.
test - Adding missing tests or correcting existing tests.
build - Changes that effect the build system or external dependencies (example scopes: glup, broccoli, npm).
ci - Changes to our CI configuration files and scripts (example scopes: Travis, Circle, , BrowserStack, SauceLabs).
chore - Other changes that don’t modify sc or test files.
revert - Reverts a previous commit.

二、husky 链接

husky可以让我们向项目中方便添加git hooks。

1、安装

npm i -D husky

2、编辑package.json > prepare 脚本并运行

npm pkg set scripts.prepare="husky install"
npm run prepare

此时会在项目根目录下创建一个.husky目录
后续，当别人clone了你的仓(意味着项目根目录下有.git目录)，并执行npm install(无参数)时，husky install命令会自动执行

3、添加一个钩子

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

此时会在.husky目录下创建一个commit-msg文件

4、测试

git commit -m "新增了一个xxx功能"这样的commit message将会直接报错
git commit -m "feat(scope?): 新增了一个xxx功能"这样规范的commit message是被允许的

三、根据commit message自动生成changelog

1、安装依赖

npm i -D conventional-changelog conventional-changelog-cli

2、编辑package.json > changelog 脚本

npm pkg set scripts.changelog="conventional-changelog -p angular -i CHANGELOG.md -s"

各参数含义：
-p Name of the preset you want to use. Must be one of the following: angular, atom, codemirror, ember, eslint, express, jquery, jscs or jshint
-i Read the CHANGELOG from this file
-s Outputting to the infile so you don’t need to specify the same file as outfile
-r How many releases to be generated from the latest. If 0, the whole changelog will be regenerated and the outfile will be overwritten. Default: 1

更详细的参数说明请查看这里

3、生成changelog

运行命令即可生成changelog

npm run changelog

最后附上一个开源项目https://github.com/ng-docs/awesome-angular，关于husky的使用，即是从这里学到的。
另外，作者还用到了prestart、prebuild钩子，实现了启动、打包项目之前的一些校验工作。
还有，作者还通过nodejs实现了获取文件git提交历史等的相关信息。
后续如果有需要，可以参考。