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],
相关推荐
brzhang几秒前
代码即图表:dbdiagram.io让数据库建模变得简单高效
前端·后端·架构
SummerGao.12 分钟前
【解决】layui layer的提示框,弹出框一闪而过的问题
前端·layui
天天扭码40 分钟前
从数组到对象:JavaScript 遍历语法全解析(ES5 到 ES6 + 超详细指南)
前端·javascript·面试
拉不动的猪42 分钟前
前端开发中常见的数据结构优化问题
前端·javascript·面试
街尾杂货店&42 分钟前
css word
前端·css
Мартин.1 小时前
[Meachines] [Hard] CrimeStoppers LFI+ZIP-Shell+Firefox-Dec+DLINK+rootme-0.5
前端·firefox
冰镇生鲜1 小时前
快速静态界面 MDC规则约束 示范
前端
技术与健康1 小时前
【解读】Chrome 浏览器实验性功能全景
前端·chrome
Bald Monkey1 小时前
【Element Plus】解决移动设备使用 el-menu 和 el-sub-menu 时,子菜单需要点击两次才会隐藏的问题
前端·elementui·vue·element plus
小小小小宇1 小时前
PC和WebView白屏检测
前端