commitlint校验git提交信息

文章目录

commitlint校验git提交信息

1、安装

javascript 复制代码
// 一次安装两个包,@commitlint下面cli和config-conventional子包
npm install --save-dev @commitlint/{cli,config-conventional}

2、配置文件

javascript 复制代码
// echo 'code' > [file] 输出代码到file文件,默认覆盖文件,如果没有file文件,会自动新增
// echo输出代码到commitlint.config.js文件,会创建commitlint.config.js
// module.exports 表示cjs规范导出
echo "module.exports { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js

3、husky

在提交或推送时自动检查你的提交消息、代码并运行测试。自定义git提交时的钩子

javascript 复制代码
npm install --save-dev husky
// 将生成 .husky文件
npx husky init
// 提交commit消息校验;$1表示commitlint默认配置,这是husky新版本的写法
echo "npx --no-install commitlint --edit $1" > .husky/commit-msg

4、格式

javascript 复制代码
// :后有一个空格
<type>[optional scope]: <subject>
// 换行
[optional body]
// 换行
[optional footer(s)]

// 例子
fix(range): preblom

5、自定义本地配置

javascript 复制代码
// commitlint.config.js
module.exports = { 
  extends: ['@commitlint/config-conventional'],
  rules: {
   // 例子:type只能写fix或者feat
    "type-enum": [2, "always", ["fix", 'feat']],
  }
};
// rules;自定义rules优先于默认规则
// conditionLevel 可选0,1,2;0表示不使用规则,1表示警告,2使用规则并且会报错
// Applicable可选 always、never,always表示总是使用value;never表示从不使用value
// Value表示匹配值,可以是string|number|[]
"rule-name": [conditionLevel, Applicable, Value]
// 例子:规定内容subject最大长度不超过5,否则会报错(2表示报错)
"subject-max-length": [2, 'always', 5],
相关推荐
yanyu-yaya18 分钟前
@progress/kendo-react-dropdowns <ComboBox>组件报错,解决
前端·javascript·react.js
小破孩呦23 分钟前
动态循环表单+动态判断表单类型+动态判断表单是否必填方法
前端·javascript·html
ElasticPDF-新国产PDF编辑器41 分钟前
React PDF Annotation plugin library online API examples
前端·react.js·pdf
Bruce_Liuxiaowei2 小时前
构建macOS命令速查手册:基于Flask的轻量级Web应用实践
前端·macos·flask
Python私教2 小时前
安装electron项目是为什么要执行postinstall script
前端·javascript·electron
shmily_yyA2 小时前
Nextjs15 实战 - React Notes之SidebarNoteList优化和Suspense的使用
前端·react.js·前端框架
知识分享小能手2 小时前
CSS3学习教程,从入门到精通, 化妆品网站 HTML5 + CSS3 完整项目(26)
前端·javascript·css·学习·css3·html5·媒体
了不起的码农3 小时前
ES6对函数参数的新设计
前端·ecmascript·es6
XH2763 小时前
Android 通知用法详解
前端
陈随易3 小时前
盘点23个Nodejs的替代品Bun的实用功能
前端·后端·程序员