git 提交规范强制检查

公司采用的commit规范

<type>: 描述

type

用于说明 commit 的类别,只容许使用下面标识:git

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变更)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变更)
  • perf:优化

git 提交信息进行强制检查

npm install --save-dev validate-commit-msg

而后,添加文件.vcmrcnpm

{
  "types": ["feat", "fix", "docs", "style", "refactor", "perf"],
  "scope": {
    "required": false,
    "allowed": ["*"],
    "validate": false,
    "multiple": false
  },
  "warnOnFail": false,
  "maxSubjectLength": 100,
  "subjectPattern": ".+",
  "subjectPatternErrorMsg": "subject does not match subject pattern!",
  "helpMessage": "",
  "autoFix": false
}

ghooks

npm install ghooks --save-dev

https://www.npmjs.com/package/ghooks
Add a config.ghooks entry in your package.json,配置暂时只须要:json

{
  …
  "config": {
    "ghooks": {
      "commit-msg": "validate-commit-msg"
      …
    }
  }
  …
}
相关文章
相关标签/搜索