Skip to content

规范GIT代码提交信息

约束提交规范

text
为了保证每一次的代码提交都是符合规范的,最好的方式就是通过工具来生成和校验;
`commitizen`是一个nodejs命令行用来格式化commit message工具,通过交互的方式,生成符合规范的git commit;
`husky` 是一个增强的 git hook 工具,借助husky在每次 commit 时执行 commitlint来检查我们输入的 message。
`commitlint` 检测提交commit提交记录是否符合规范
`lint-staged` 检查提交暂存区代码是否符合规范

commitizen 安装流程

text
   yarn global add commitizen
   yarn global add conventional-changelog-cli  // 生成变更记录
   yarn global add standard-version  // 进行版本管理自动化
   commitizen init cz-conventional-changelog --yarn --dev --exact

配置命令

text
    // packages.json
    "config": { 
        "commitizen": { 
            "path": "cz-conventional-changelog" 
         } 
     }
      "scripts": {
          // 运行脚本在CHANGELOG.md 查看变更记录
           "log": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
           "release": "standard-version",
           "release:beta": "standard-version --prerelease beta",
           "release:alpha": "standard-version --prerelease alpha",
           "release:major": "standard-version --release-as major",
           "release:minor": "standard-version --release-as minor",
           "release:patch": "standard-version --release-as patch"
      }

安装完成后可以使用git cz 来代替git commit,然后根据提示一步步输入即可;

Contributors

作者:Long Mo
字数统计:304 字
阅读时长:1 分钟
Long Mo
文章作者:Long Mo
版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 Longmo Docs