.commitlint.config.cjs 1.2 KB

123456789101112131415161718192021222324252627282930
  1. module.exports = {
  2. extends: ['@commitlint/config-conventional', 'gitmoji'],
  3. rules: {
  4. 'type-enum': [ // type枚举
  5. 2, 'always',
  6. [
  7. 'feat', // 新功能
  8. 'fix', // 修补bug
  9. 'docs', // 文档修改
  10. 'style', // 代码格式修改, 注意不是 css 修改
  11. 'refactor', // 重构
  12. 'perf', // 优化相关,比如提升性能、体验
  13. 'test', // 测试用例修改
  14. 'chore', // 构建过程或辅助工具的调整
  15. 'build', // 编译相关的修改,例如发布版本、对项目构建或者依赖的改动
  16. 'revert', // 代码回滚
  17. ],
  18. ],
  19. 'type-empty': [2, 'never'], // never: type不能为空; always: type必须为空
  20. 'type-case': [0, 'always', 'lower-case'], // type必须小写,upper-case大写,camel-case小驼峰,kebab-case短横线,pascal-case大驼峰,等等
  21. 'scope-empty': [0],
  22. 'scope-case': [0],
  23. 'subject-empty': [2, 'never'], // subject不能为空
  24. 'subject-case': [0],
  25. 'subject-full-stop': [0, 'never', '.'], // subject以.为结束标记
  26. 'header-max-length': [2, 'always', 72], // header最长72
  27. 'body-leading-blank': [0], // body换行
  28. 'footer-leading-blank': [0, 'always'], // footer以空行开头
  29. }
  30. }