commitlint 从入门到配置,让提交更专业

0 阅读1分钟

commitlint

commitlint是什么

commitlint是检查你的git提交信息规不规范的工具

为什么要用它

防止提交信息乱写到这查看历史提交模糊,便于统一风格

安装

前提安装了husky

pnpm add -D @commitlint/cli @commitlint/config-conventional

配置

在根目录创建 commitment.config.js

module.export = {
  extends:['@commitlint/config-conventional']
}

配置husky的commit-msg钩子:回看husky配置

规范格式

type(scope): subject

type类型

  • feat 新增功能
  • fix 修复bug
  • docs 文档修改
  • style 格式调整(不影响逻辑)
  • refactor 重构(功能不变,改变代码结构写法)
  • test 测试相关
  • chore 构建/工具/依赖调整

scope可选(模块名)

比如login、user、list、layout等

subject简短描述

小写开头,不超过60字,不加标点