前端工程化1--自动校验Git Commit

时间 2019-11-08

标签前端工程自动校验 git commit 栏目 Git 繁體版

原文原文链接

Git Commit 规范及自动校验

目标：对项目开发人员的每次commit书写格式进行自动校验css

推荐使用 Angular 团队提交规范node

1 主要有如下组成git

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
复制代码

2 具体说明github

经常使用的修改项npm

例如本次开发实现了用户登陆的功能；则commit提交样式以下：json

feat(login): add login feature

1.mobile login
2.email login
3.find password
复制代码

能够使用Commitizen代替 git commit 能够使用cz-cli工具代替 git commitgulp

全局安装，并在项目根目录初始化安装性能优化

yarn add -g commitizen cz-conventional-changelog

commitizen init cz-conventional-changelog --yarn --dev --exact
复制代码

then some change in your package.jsonbash

"config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  }
复制代码

全局安装后使用git cz代替 git commit就能够了。工具

1.安装工具

npm install -g @commitlint/cli @commitlint/
复制代码

2.生成配置文件commitlint.config.js

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

项目根目录下建立commitlint.config.js这个文件，并配置

module.exports = { extends: ["@commitlint/config-conventional"] };
复制代码

yarn add -D husky
复制代码

2 配置husky校验规则 //package.json

"husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
复制代码

由此就能够实现每次提交git commit时候自动校验commit的书写是否符合规范。