commitlint配置说明

[AlfieriChou]

背景




• 我们已经通过husky建立了代码风格提交检查，然而，并没有建立提交规范。所以，急需一个工具库来完成project的pre-commit。通过查找了大量资料，发现commitlint完全能满足我们当前的要求。接下来，就开始配置我们的提交规范。 


  安装

  


  1. 安装包依赖

     npm install --save-dev @commitlint/{config-conventional,cli}

  2. 书写commitlint配置文件

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

  3. 添加husky配置

     {
     "husky": {
     "hooks": {
     "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
     }  
     }
     }

提交规范




• 提交格式

  <type>: <subject>

• 常用type类型
• feat: 新功能（feature）
• fix: 修复bug
• docs: 文档
• refactor: 重构
• style: 风格
• test: 添加测试
• chore: 构建工具
• subject
• subject为commit的内容描述，可以做长度限制，例如，目前项目里限制最小长度为5。 


  commitlint配置规则

  


  rules配置规则

  


• 用例子来说明

  rules: {
  'subject-min-length': async () => [2, 'always', 5]
  }

该rule配置了最小subject提交长度 数组中的第一位为检查level 0为disable 1为warning 2为error 第二位是否应用  always（检查）never（不检查） 第三位为长度 默认为0