@jzo/commitlint-config-esbing v0.0.5

CommitLint 规范

前端 CommitLint 规范

相关依赖

npm install husky commitlint @commitlint/config-conventional  --save-dev

安装组件

npm install @jzo/commitlint-config-esbing -D
# OR
yarn add @jzo/commitlint-config-esbing --dev

使用

在你的工程根目录下创建一个commitlint.config.js配置文件

配置如下即可:

module.exports = {
  extends: '@jzo/commitlint-config-esbing'
}

安装 husky

对于 commit-msg hook 我们可以使用以下命令来创建 git hook 所要执行的脚本

依次在项目根目录执行如下两条命令

npx husky install
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
npm set-script cz "git add . && git cz && git push"

package.json 修改:

  "husky": {
    "hooks": {
      "commit-msg": "commitlint -e HUSKY_GIT_PARAMS"
    }
  },
  "config": {
    "commitizen":{
      "path":"./node_modules/@jzo/commitlint-config-esbing/lib/cz"
    }
  },

规范

格式： <type>[(scope)]: <description>

示例

git commit -a -m 'build: xxxxx'
git commit -a -m 'feat(cli): xxxxx'
git commit -a -m 'feat(cli): xxxxx' --no-verify // 不验证规范

字段说明

type