space-front
/
commitlint.config.js

/**
 *  rule由key和配置数组组成
 *  如：'key:[0, 'always', 72]'
 *    数组中第一位为level，可选0,1,2，0为disable，1为warning，2为error，
 *         第二位为是否应用，可选always|never，
 *         第三位该rule的值
 *
 * <类型>:(影响范围) <主题> <禅道?>
 * <body>
 * <footer>
  类型字段包含:
    feature：新功能（feature）
    update:在feature内修改
    fix：修复bug，适合于一次提交直接修复问题
    to：修复bug，适合于多次提交。最终修复问题提交时使用fix
    docs：文档（documentation）
    style：格式化 ESLint调整等（不影响代码运行的变动）
    refactor：重构（即不是新增功能，也不是修改bug的代码变动）
    test：增加测试
    chore：构建过程或辅助工具的变动
  影响范围：
    用于说明 commit 影响的范围，比如修改的登录页、账户中心页等
  描述：
    commit目的的简短描述，不超过50个字符
  禅道:
    如果有对应的禅道任务 请附上禅道任务号
   Body：
    部分是对本次 commit 的详细描述，可以分成多行
   Footer：
   用来关闭 Issue或以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法
 * * */
module.exports = {
	'extends': [`@commitlint/config-conventional`],
	'rules': {
		'type-enum': [2, `always`, [`feature`, `update`, `fix`, `to`, `docs`, `style`, `refactor`, `test`, `chore`]]
	}
};