使用commitlint+husky规范代码提交的信息格式

1、下载husky(使用8.0.1版本)

1)npm install husky@8.0.1 --save-dev

2)初始化目录.husky

npx husky install

3)新增commit-msg目录并写入信息

npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

.husky文件夹是新增在根目录下

2、下载commitlint

commitlint 是检测我们提交的规范的,具体规范如下(冒号匹配的是英文冒号,并且冒号后要有空格):

<type>: <subject>

常见 type 类型

· upd:更新某功能(不是 feat, 不是 fix)

指令 意思
feat 新功能(feature)
fix 修复 bug
docs 文档(documentation)
style 代码格式调整(不影响代码运行的变动,如空格、缩进)
refactor 代码重构(即不是新增功能,也不是修改 bug 的代码变动,不涉及功能变更)
test 测试用例修改或新增
chore 构建过程或辅助工具的变动(如.gitignore调整)
revert 撤销某次提交

1)下载

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

2)在项目根目录新建配置文件commitlint.config.js

代码如下:

js 复制代码
module.exports = {

  extends: ["@commitlint/config-conventional"],

  rules: {

    "type-enum": [

      2,

      "always",

      ["upd", "feat", "fix", "refactor", "docs", "chore", "style", "revert"],

    ],

    "type-case": [0],

    "type-empty": [0],

    "scope-empty": [0],

    "scope-case": [0],

    "subject-full-stop": [0, "never"],

    "subject-case": [0, "never"],

    "header-max-length": [0, "always", 72],

  },

};

3、验证

1)命令行验证:

先git add 想要提交的代码

再git commit -m "bad message",会报错误信息

需要加入规范前缀,提交后再push

2)vsCode验证

不符合规范提交报错:

符合格式正确提交:

4、参考文档:

blog.csdn.net/qq_21197033...

相关推荐
山有木兮木有枝_2 小时前
JavaScript 设计模式--单例模式
前端·javascript·代码规范
hqxstudying3 小时前
Java创建型模式---原型模式
java·开发语言·设计模式·代码规范
肖魏眸7 小时前
vue3 格式化 : antfu 组合 prettier & eslint & 提交格式化校验
前端·代码规范
tianchang1 天前
策略模式(Strategy Pattern)深入解析与实战应用
前端·javascript·代码规范
羊八井1 天前
类型、分类定义时使用 type 还是 kind ?
rust·typescript·代码规范
艾克马斯奎普特1 天前
为什么响应性语法糖最终被废弃了?尤雨溪也曾经试图让你不用写 .value
前端·vue.js·代码规范
hqxstudying2 天前
Java创建型模式---单例模式
java·数据结构·设计模式·代码规范
千楼2 天前
阿里巴巴Java开发手册(1.3.0)
java·代码规范
肖笙XiaoSheng4 天前
使用Gemini2.5 pro 优化我的定时任务(二)
java·后端·代码规范