谧怏弦 发表于 2025-5-31 23:24:12

代码提交信息规范插件commitlint/cli的安装和使用

代码提交信息规范插件commitlint/cli的安装和使用
npm install --save-dev @commitlint/cli@^17.6.0 @commitlint/config-conventional@^17.6.0新增commitlint.config.cjs
// commitlint.config.js

/**
* CommitLint 配置文件
* 该配置遵循 Conventional Commits 规范,适用于企业级提交校验标准
*/

module.exports = {
// 使用社区通用规范
extends: ['@commitlint/config-conventional'],

// 自定义规则
rules: {
    // 1. type 类型必须在以下列表中,保证语义清晰
    'type-enum': [
      2,
      'always',
      [
      'feat',   // 新功能 feature
      'fix',      // 修复 bug
      'docs',   // 文档变更
      'style',    // 代码格式(不影响功能,如空格、缩进)
      'refactor', // 代码重构(不包括修复和功能)
      'perf',   // 性能优化
      'test',   // 添加或修改测试
      'build',    // 构建工具变更(webpack、vite、npm scripts 等)
      'ci',       // CI 配置变更(GitHub Actions、GitLab CI 等)
      'chore',    // 其他日常事务(构建过程辅助脚本、依赖升级等)
      'revert'    // 回滚提交
      ]
    ],

    // 2. type 必须小写(例如 "Feat" 会报错)
    'type-case': ,

    // 3. scope(作用域)必须小写,保持统一(如 "auth", "api")
    'scope-case': ,

    // 4. subject(简短描述)不能为空
    'subject-empty': ,

    // 5. subject 不允许以句号结尾(如 "fix: update foo." 会报错)
    'subject-full-stop': ],

    // 6. subject 必须是句首大写(Sentence case)或全部小写(可按需修改)
    'subject-case': ,

    // 7. header(type + scope + subject)总长度不超过 72 字符
    'header-max-length': ,

    // 8. body 每行不能超过 72 字符,便于终端阅读和 changelog 显示
    'body-max-line-length': ,

    // 9. footer 每行不能超过 72 字符(如 BREAKING CHANGE、issue refs)
    'footer-max-line-length': ,

    // 10. footer 前必须有一个空行(与 body 分隔)
    'footer-leading-blank': ,
}
};echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg测试
git commit -m "Feat(auth): add OAuth2 login support"示例
git commit -m "feat(auth): add OAuth2 login support"
来源:程序园用户自行投稿发布,如果侵权,请联系站长删除
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!

咪四 发表于 2025-11-3 10:06:56

感谢分享,下载保存了,貌似很强大

劳暄美 发表于 2025-12-5 16:32:02

前排留名,哈哈哈

菅舛 发表于 2026-1-5 15:29:31

喜欢鼓捣这些软件,现在用得少,谢谢分享!

诞楮 发表于 2026-1-12 02:57:24

很好很强大我过来先占个楼 待编辑

魄柜 发表于 2026-1-14 01:34:10

过来提前占个楼

史穹逊 发表于 2026-1-14 04:01:12

这个有用。

艾曼语 发表于 2026-1-14 13:25:12

分享、互助 让互联网精神温暖你我

顶豌 发表于 2026-1-15 05:37:55

前排留名,哈哈哈

梢疠 发表于 2026-1-15 22:26:37

这个好,看起来很实用

接快背 发表于 2026-1-18 17:31:13

谢谢楼主提供!

曲愍糙 发表于 2026-1-19 11:57:17

感谢分享,下载保存了,貌似很强大

轧岔 发表于 2026-1-21 02:53:58

感谢分享,下载保存了,貌似很强大

麓吆 发表于 2026-1-23 03:29:36

感谢,下载保存了

施婉秀 发表于 2026-1-25 10:20:22

分享、互助 让互联网精神温暖你我

幽淆 发表于 2026-1-26 09:25:33

喜欢鼓捣这些软件,现在用得少,谢谢分享!

赶塑坠 发表于 2026-1-28 07:26:13

喜欢鼓捣这些软件,现在用得少,谢谢分享!

钨哄魁 发表于 2026-2-1 06:06:35

yyds。多谢分享

舒菀菀 发表于 2026-2-5 08:28:15

过来提前占个楼

益竹月 发表于 2026-2-8 12:10:01

懂技术并乐意极积无私分享的人越来越少。珍惜
页: [1] 2
查看完整版本: 代码提交信息规范插件commitlint/cli的安装和使用