jimwmg / git-learn

使用 commitlint 步骤

首先了解下业界比较认同的commit规范 angular提交规范-github

config-conventional-github

vue.js 也是这么做的参见

1 在项目根目录执行

npm install --save-dev husky

npm install --save-dev @commitlint/cli @commitlint/config-angular 
echo "module.exports = {extends: ['@commitlint/config-angular']};" > commitlint.config.js

2 配置package.json

"husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },

3 git commit -m"xxx: xxx"

4 commit message 格式要求如下

git commit -m"feat(commit-config): add commit"

以后不能再随便的写

git commit -m'xxx'

也不能写不符合规范的提交信息

git commit -m'testfafaf: fdfaf'
husky > pre-commit (node v8.10.0)
pre
husky > commit-msg (node v8.10.0)
⧗   input: testfafaf: fdfaf
✖   type must be one of [build, ci, docs, feat, fix, perf, refactor, revert, style, test] [type-enum]

✖   found 1 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

husky > commit-msg hook failed (add --no-verify to bypass)

可以使用 angular 提交规范，参考commitlint-angular

angular提交规范-github

config-conventional-github

5 自己配置校验规则

5.1 新增commit-ling.js 文件，内容如下; 注意这里获取 commit 信息的路径，对于 husky ,是 HUSKY_GIT_PARAMS 这个变量，指向 .git/COMMIT_EDITMSG

cd .git
ls 

COMMIT_EDITMSG HEAD           TAG_EDITMSG    description    index          logs           refs
FETCH_HEAD     ORIG_HEAD      config         hooks          info           objects

const chalk = require('chalk')
const msgPath = process.env.HUSKY_GIT_PARAMS
console.log('process.env',process.env.HUSKY_GIT_PARAMS)
debugger;
const msg = require('fs').readFileSync(msgPath, 'utf-8').trim()

const commitRE = /^(revert: )?(feat|fix|polish|docs|style|refactor|perf|test|workflow|ci|chore|types|build)(\(.+\))?: .{1,50}/
console.log(msg)
console.log('process.env',process.env)
if (!commitRE.test(msg)) {
  console.log()
  console.error(
    `  ${chalk.bgRed.white(' ERROR ')} ${chalk.red(`invalid commit message format.`)}\n\n` +
    chalk.red(`  Proper commit message format is required for automated changelog generation. Examples:\n\n`) +
    `    ${chalk.green(`feat(compiler): add 'comments' option`)}\n` +
    `    ${chalk.green(`fix(v-model): handle events on blur (close #28)`)}\n\n` +
    chalk.red(`  See .github/COMMIT_CONVENTION.md for more details.\n`) +
    chalk.red(`  You can also use ${chalk.cyan(`npm run commit`)} to interactively generate a commit message.\n`)
  )
  process.exit(1)
}

package.json 中 githooks 中修改为如下：

"husky": {
    "hooks": {
      "commit-msg": "node commit-lint.js"
    }
  },

Commit Message格式

每次提交，Commit message 都包括两个部分：Header，Body 。header中的 type 和 subject有特殊的规定

<type>(<scope>): <subject>

其中，Header 是必需的，Body 可以省略。 不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。

Header ：包括三个type（必填）、scope（选填）和 subject（必填）

type:用于声明此次commit的主要目的类别：

* feat：新功能（feature）
* fix：修补bug
* docs：文档（documentation）
* style： 格式（不影响代码运行的变动）
* refactor：重构（即不是新增功能，也不是修改bug的代码变动）
* test：增加测试
* chore：构建过程或辅助工具的变动

注：如果type为feat和fix，则该 commit 将肯定出现在 Change log 之中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change log，建议是不要。

scope:用于说明commit影响的范围；如数据层(model)，视图层(view)，控制层（controller）等。

subject :是 commit 目的的简短描述，不超过50个字符。

* 以动词开头，使用第一人称现在时，比如change，而不是changed或changes

Body

Body 部分是对本次 commit 的详细描述，可以分成多行

* 使用第一人称现在时，比如使用change而不是changed或changes。
* 应该说明代码变动的动机，以及与以前行为的对比。

使用git-flow 规范工作流

git-flow官网

git-flow使用教程

git-flow 可以大大的优化遵循git 分支规范的团队开发效率；提升开发体验。减少人工操作失误率；

如果不是强烈规范团队，也不是特别适合团队使用 git-flow；可以按照约定手动遵循改规范即可；