工程化:Commitlint / 规范化Git提交消息格式

一、理解Commitlint

Commitlint是一个用于规范化Git提交消息格式的工具。它基于Node.js,通过一系列的规则来检查Git提交信息的格式,确保它们遵循预定义的标准。

1.1、Commitlint的核心功能

代码规则检查:Commitlint基于代码规则进行检查,这些规则可以自定义以适应项目的特定需求。例如,可以设置规则来要求所有的函数都有明确的参数列表等。

多种编程语言和框架支持:Commitlint支持多种编程语言和框架,如JavaScript、Python、React、Angular等,使其能够适应各种项目需求。

可视化报告和警告:Commitlint提供可视化报告和警告,帮助团队成员了解有关代码问题的详细信息。

1.2、Commitlint的工作流程

它在Git的commit-msg钩子中运行,这意味着每次提交时,Commitlint都会自动检查提交信息。

如果提交信息不符合规则,Commitlint会阻止提交并给出错误提示。

此外,Commitlint与Husky等工具可以配合使用,确保代码在提交到版本控制系统之前经过检查和验证。

二、vue3 + ts 项目使用Commitlint

复制代码
pnpm add  @commitlint/cli @commitlint/config-conventional
复制代码
pnpm add husky

.commitlintrc.js

复制代码
module.exports = {  
   extends: ['@commitlint/config-conventional'],  
};

测试

提交成功

验证通过

三、过程记录

3.1、.commitlintrc.js

.commitlintrc.js 是一个配置文件,用于 Commitlint,一个工具,用于帮助你在 Git 仓库中强制执行一致的 commit message 格式。Commitlint 允许你定义规则,这些规则会在你尝试提交一个新的 Git commit 时被检查。

这个文件通常包含一个配置对象,该对象定义了你希望 Commitlint 遵循的规则。

以下是一个简单的 .commitlintrc.js 示例:

复制代码
module.exports = {  
  extends: ['@commitlint/config-conventional'], // 使用常规的 commitlint 配置文件  
  rules: {  
    'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'build', 'ci', 'chore', 'revert']], // 定义允许的提交类型  
    'scope-case': [2, 'always', 'lower-case'], // 强制提交范围为小写  
    'subject-case': [0], // 不强制主题大小写(但通常建议使用 sentence-case)  
    'subject-empty': [2, 'never'], // 禁止空的提交主题  
    'subject-full-stop': [0, 'never'], // 不强制主题以句号结尾  
    'header-max-length': [2, 'always', 72], // 强制 header 最大长度为 72 个字符  
    'body-leading-blank': [1, 'always'], // 强制 body 前面有一个空行  
    'footer-leading-blank': [1, 'always'], // 强制 footer 前面有一个空行  
    'footer-max-line-length': [2, 'always', 80], // 强制 footer 的每行最大长度为 80 个字符  
  },  
  parserPreset: {  
    parserOpts: {  
      headerPattern: /^(\w*)(?:\(([\w$\.,\s]*?)\))?\s*:(.*)$/, // 自定义 header 的正则表达式  
      headerCorrespondence: ['type', 'scope', 'subject'], // 与 headerPattern 匹配的部分  
    },  
  },  
};

四、欢迎交流指正

相关推荐
爱分享的程序员28 分钟前
前端面试专栏-算法篇:18. 查找算法(二分查找、哈希查找)
前端·javascript·node.js
翻滚吧键盘33 分钟前
vue 条件渲染(v-if v-else-if v-else v-show)
前端·javascript·vue.js
vim怎么退出35 分钟前
万字长文带你了解微前端架构
前端·微服务·前端框架
你这个年龄怎么睡得着的35 分钟前
为什么 JavaScript 中 'str' 不是对象,却能调用方法?
前端·javascript·面试
Java水解38 分钟前
前端常用单位em/px/rem/vh/vm到底有什么区别?
前端
CAD老兵41 分钟前
Vite 如何借助 esbuild 实现极速 Dev Server 体验,并支持无 source map 的源码调试
前端
南屿im42 分钟前
JavaScript 手写实现防抖与节流:优化高频事件处理的利器
前端·javascript
Spider_Man42 分钟前
从零开始构建React天气应用:API集成与UI设计全指南 🌤️
前端·react.js
浩浩测试一下1 小时前
渗透信息收集- Web应用漏洞与指纹信息收集以及情报收集
android·前端·安全·web安全·网络安全·安全架构
西陵1 小时前
Nx带来极致的前端开发体验——借助CDD&TDD开发提效
前端·javascript·架构