commitlint-config-cgz

本包提供了《信息技术部前端编码手册》配套的 commitlint 可共享配置。

使用

安装

yarn add @cgzair/commitlint-config-cgz -D

继承配置

在你的 .commitlintrc.js 中继承本包:

module.exports = {
  extends: ["@cgzair/cgz"],
};

增加 script 民命令

// package.json
{
  "scripts": {
    "commit": "git-cz",
  },
  "config": {
    "commitizen": {
      "path": "@commitlint/cz-commitlint"
    }
  }
}

在每次需要提交代码时，首先提交到暂存区，然后执行以下命令，即可进入到交互式终端：

npm run commit
// 或者
yarn run commit

设置 git hook

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