当前位置：首页 > news >正文

使用 commitlint 和 husky 检查提交描述是否符合规范要求

news 来源：原创 2025/7/5 7:38:25

在上一小节中，我们了解了 Git hooks 的概念，那么接下来我们就使用 Git hooks 来去校验我们的提交信息。

要完成这么个目标，那么我们需要使用两个工具：

注意：npm 需要在 7.x 以上版本。

1. commitlint 用于检查提交信息

1.1. 安装依赖

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

1.2. 创建配置文件commitlint.config.js

echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

1.3. 增加配置项

module.exports = {// 继承的规则extends: ['@commitlint/config-conventional'],// 定义规则类型rules: {// type 类型定义，表示 git 提交的 type 必须在以下类型范围内'type-enum': [2,'always',['feat', // 新功能 feature'fix', // 修复 bug'docs', // 文档注释'style', // 代码格式(不影响代码运行的变动)'refactor', // 重构(既不增加新功能，也不是修复bug)'perf', // 性能优化'test', // 增加测试'chore', // 构建过程或辅助工具的变动'revert', // 回退'build' // 打包]],// subject 大小写不做校验'subject-case': [0]}
}

注意：确保保存为 UTF-8 的编码格式，否则可能出现错误。

2. husky：是Git hooks工具

2.1. 安装依赖

npm install husky@7.0.1 --save-dev

2.2. 启动 hooks ，生成 .husky 文件夹

npx husky install

2.3. 在 package.json 中生成 prepare 指令（需要 npm > 7.0 版本）

npm set-script prepare "husky install"

生成后效果如下：

2.4. 执行 prepare 指令

npm run prepare

执行后效果如下：

2.5. 添加 commitlint 的 hook 到 husky中，并在 commit-msg 的 hooks 下执行 npx --no-install commitlint --edit "$1" 指令

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

此时的 .husky 的文件结构如下：

至此，不符合规范的 commit 将不再可提交：

PS F:\xxxxxxxxxxxxxxxxxxxxx\imooc-admin> git commit -m "测试"
⧗   input: 测试
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlinthusky - commit-msg hook exited with code 1 (error)

那么至此，我们就已经可以处理好了强制规范化的提交要求，到现在不符合规范的提交信息，将不可再被提交。

前三篇文章介绍了代码提交规范，接下来在《使用ESLint与Prettier配合解决代码格式问题》中将开始介绍代码格式规范。

使用 commitlint 和 husky 检查提交描述是否符合规范要求

在上一小节中，我们了解了 Git hooks 的概念，那么接下来我们就使用 Git hooks 来去校验我们的提交信息。要完成这么个目标，那么我们需要使用两个工具： 注意：npm 需要在 7.x 以上版本。 1. commitlint 用于检查提交信…...

编程日记 2025/7/5 7:38:25

QT集成IntelRealSense双目摄像头3，3D显示

前两篇文章，介绍了如何继承intel realsense相机和opengl。这里介绍如何给深度数据和色彩数据一块显示到opengl里面。首先，需要了解深度数据和彩色数据是如何存储的。先说彩色数据。彩色图像一般都是RGB，也就是每个像素有三个字节&#xf…...

编程日记 2025/7/5 7:29:25

Vue 中el-table-column 进行循环，页面没渲染成功

文章目录前言效果图代码示例可能出现的问题及原因解决思路前言实现效果：el-table-column 进行循环，使之代码简化遇到的问题： data进行默认赋值，操作列的删除都可以出来，其他表格里面的数据没出来效果图示例&am…...

编程日记 2025/7/4 5:04:15

渗透测试-非寻常漏洞案例

声明本文章所分享内容仅用于网络安全技术讨论，切勿用于违法途径，所有渗透都需获取授权，违者后果自行承担，与本号及作者无关，请谨记守法. 此文章不允许未经授权转发至除先知社区以外的其它平台！&#xff0…...

编程日记 2025/7/2 18:46:35

Spring Boot 实战篇（四）：实现用户登录与注册功能

目录 Spring Boot 实战篇（四）：实现用户登录与注册功能一、用户注册功能 （一）前端页面设计（简要提及） （二）后端实现二、用户登录功能 （一）…...

编程日记 2025/7/5 7:34:03

VScode SSH 错误：Got bad result from install script 解決

之前vscode好好的，某天突然连接报错如下尝试1. 服务器没有断开,ssh可以正常连接 2. 用管理员权限运行vscode，无效 3. 删除服务器上的~/.vscode-server 文件夹，无效试过很多后，原来很可能是前一天anaconda卸载导致注册表项步…...

编程日记 2025/7/3 15:10:56

openGauss与GaussDB系统架构对比

openGauss与GaussDB系统架构对比系统架构对比openGauss架构GaussDB架构 GaussDB集群管理组件系统架构对比 openGauss架构 openGauss是集中式数据库系统，业务数据存储在单个物理节点上，数据访问任务被推送到服务节点执行，通过服务器的高并…...

编程日记 2025/6/29 23:48:23

【ArcGISPro/GeoScenePro】检查并处理高程数据

数据 https://arcgis.com/sharing/rest/content/items/535efce0e3a04c8790ed7cc7ea96d02d/data 数字高程模型 (DEM) 是一种栅格，可显示地面或地形的高程。数字表面模型 (DSM) 是另一种高程栅格，可显示表面的高度，例如建筑物或树冠的顶部。您需要准备 DEM 和 DSM 以供分析…...

编程日记 2025/7/3 14:39:05

WebRTC的三大线程

WebRTC中的三个主要线程： signaling_thread，信号线程：用于与应用层交互worker_thread，工作线程（最核心）：负责内部逻辑处理network_thread，网络线程：负责网络数据包的收发…...

编程日记 2025/7/3 9:59:48

HTML-文本标签

历史上，网页的主要功能是文本展示。所以，HTML 提供了大量的文本处理标签。 1.<div> <div>是一个通用标签，表示一个区块（division）。它没有语义，如果网页需要一个块级元素容器，又没…...

编程日记 2025/7/3 18:58:19

C# 在PDF中添加和删除水印注释（Watermark Annotation）

目录使用工具 C# 在PDF文档中添加水印注释 C# 在PDF文档中删除水印注释 PDF中的水印注释是一种独特的注释类型，它通常以透明的文本或图片形式叠加在页面内容之上，为文档添加标识或信息提示。与传统的静态水印不同，水印注释并不会永久嵌入…...

编程日记 2025/7/2 1:29:24

Unity2022接入Google广告与支付SDK、导出工程到Android Studio使用JDK17进行打包完整流程与过程中的相关错误及处理经验总结

注：因为本人也是第一次接入广告与支付SDK相关的操作，网上也查了很多教程，很多也都是只言片语或者缺少一些关键步骤的说明，导致本人也是花了很多时间与精力踩了很多的坑才搞定，发出来也是希望能帮助到其他人在遇到相似问…...

编程日记 2025/7/1 14:47:31

docker部署项目

docker部署项目 （加载tar包：docker image load -i mysql.tar） 一、jdk环境配置 1.jdk下载地址 --Java Archive | Oracle 中国 --选择好版本进入 --下载Linux x64 Compressed Archive的链接 2.解压 --创建文件夹：mkdir /ro…...

编程日记 2025/6/29 20:10:06

C# 设计模式（创建型模式）：工厂模式

C# 设计模式（创建型模式）：工厂模式引言在软件设计中，创建型模式是用来创建对象的设计模式，它们帮助我们将对象的创建过程从业务逻辑中分离出来，减少代码的重复性和耦合度。工厂模式作为创建型设计模式之…...

编程日记 2025/7/3 18:43:02

REMARK-LLM：用于生成大型语言模型的稳健且高效的水印框架

REMARK-LLM：用于生成大型语言模型的稳健且高效的水印框架前言提出这一模型的初衷为了应对大量计算资源和数据集出现伴随的知识产权问题。使用LLM合成类似人类的内容容易受到恶意利用，包括垃圾邮件和抄袭。 ChatGPT等大语言模型LLM的开发取得的进展标志着人机对话交互的范式…...

编程日记 2025/6/29 19:29:19

Lumos学习王佩丰Excel第二十三讲：Excel图表与PPT

一、双坐标柱形图的补充知识 1、主次坐标设置 2、主次坐标柱形避让（通过增加两个系列，挤压使得两个柱形挨在一起） 增加两个系列将一个系列设置成主坐标轴，另一个设成次坐标轴调整系列位置二、饼图美化 1、饼图美化常见设置 …...

编程日记 2025/6/30 5:47:30

【Vue】v-if 和 :is 都是 Vue 中的指令，但它们用于不同的目的和场景

v-if v-if 是一个条件渲染指令，用于根据表达式的真假值来决定是否渲染一块内容。当 v-if 的表达式为真（truthy）时，Vue 会确保元素被渲染到 DOM 中；当表达式为假（falsy）时，元素不会被…...

编程日记 2025/7/2 20:44:41

private static final Logger log = LoggerFactory.getLogger()和@Slf4j的区别

一、代码方面 - private static final Logger log LoggerFactory.getLogger()方式详细解释这是一种传统的获取日志记录器（Logger）的方式。LoggerFactory是日志框架（如 Log4j、Logback 等）提供的工厂类，用于创建Lo…...

编程日记 2025/7/5 7:12:31

【项目】基于趋动云平台的Stable Diffusion开发

【项目】基于趋动云平台的Stable Diffusion开发 （一）登录趋动云（二）创建项目：（三）初始化开发环境：（四）运行代码（五）运行模型 &#xf…...

编程日记 2025/7/5 7:14:20

Git的.gitignore文件详解与常见用法

诸神缄默不语-个人CSDN博文目录在日常使用 Git 进行版本控制时，我们经常会遇到一些不需要被提交到远程仓库的文件（例如日志文件、临时配置文件、环境变量文件等）。为了忽略这些文件的提交，Git 提供了一个非常有用的功能&#xf…...

编程日记 2025/7/3 12:20:22

Linux 安装运行gatk的教程

1.下载安装 wget https://github.com/broadinstitute/gatk/releases/download/4.1.8.1/gatk-4.1.8.1.zip2.解压 unzip *.zip3.查看 gatk --help 如下显示表示安装成功： 注意：仅限在该包所在位置的路径下能使用...

编程日记 2025/7/2 17:40:22

C++string类

1.为什么学习string类？ 1.1C语言中的字符串 C语言中，字符串是以‘＼0’结尾的一些字符的集合，为了操作方便，C标准库中提供了一些str系列的库函数，但是这些库函数与字符串是分离开的，不太符合OO…...

编程日记 2025/6/30 1:27:49

下载linux aarch64版本的htop

htop代码网站似乎没有编译好的各平台的包，而自己编译需要下载一些工具，比较麻烦。这里找到了快速下载和使用的方法，记录一下。先在linux电脑上执行： mkdir htop_exe cd htop_exe apt download htop:arm64 # 会直接下载到当前目…...

编程日记 2025/7/4 18:27:01

MYSQL---------支持数据类型

数值类型整数类型 TINYINT：通常用于存储小范围的整数，范围是-128到127或0到255（无符号）。例如，存储年龄可以使用TINYINT类型。示例：CREATE TABLE users (age TINYINT);SMALLINT：范围比TINYINT…...

编程日记 2025/7/1 22:21:10

黑马JavaWeb开发跟学(十四).SpringBootWeb原理

黑马JavaWeb开发跟学十四.SpringBootWeb原理 SpingBoot原理1. 配置优先级2. Bean管理2.1 获取Bean2.2 Bean作用域2.3 第三方Bean 3. SpringBoot原理3.1 起步依赖3.2 自动配置3.2.1 概述3.2.2 常见方案3.2.2.1 概述3.2.2.2 方案一3.2.2.3 方案二 3.2.3 原理分析3.2.3.1 源码跟踪…...

编程日记 2025/7/2 20:38:44

迅为RK3568开发板编译Android12源码包-设置屏幕配置

在源码编译之前首先要确定自己想要使用的屏幕并修改源码，在编译镜像，烧写镜像。如下图所示： 第一步：确定要使用的屏幕种类，屏幕种类选择如下所示： iTOP-3568 开发板支持以下种类屏幕： 迅为 LV…...

编程日记 2025/7/3 11:31:58

Spring Boot 中 TypeExcludeFilter 的作用及使用示例

在Spring Boot应用程序中，TypeExcludeFilter 是一个用于过滤特定类型的组件，使之不被Spring容器自动扫描和注册为bean的工具。这在你想要排除某些类或类型（如配置类、组件等）而不希望它们参与Spring的自动装配时非常有用。作用 …...

编程日记 2025/7/5 7:14:20

Prometheus 采集 JVM 数据

Prometheus 采集 JVM 数据通常通过集成 JMX Exporter（Java Management Extensions Exporter）实现。以下是完整的介绍和操作步骤： 1. 原理概述 JVM 数据采集依赖于 JMX（Java Management Extensions），JVM 提…...

编程日记 2025/7/2 12:30:01

OpenNJet v3.2.0正式发布！

在这个版本中，NJet实现重大突破，提供了动态Upstream的能力。这是一个关键的特性，使得NJet可以按需动态管理上游服务器池，从而使得业务方可以按需配置资源池，实现业务分区、算法切换；结合动态路由技术&#…...

编程日记 2025/7/4 11:42:05

TinaCMS: 革命性的开源内容管理框架

在如今的数字时代，高效的内容管理系统（CMS）已成为构建内容丰富网站和应用程序的必需品。传统 CMS，如 WordPress 和 Drupal，功能丰富但复杂度高。而新一代 CMS，例如 TinaCMS，以其灵活性和开发者友…...

编程日记 2025/6/30 15:55:54

VuePress2配置unocss的闭坑指南

文章目录 1. 安装依赖：准备魔法材料2. 检查依赖版本一定要一致：确保魔法配方准确无误3. 新建uno.config.js：编写咒语书4. 配置config.js和client.js：完成仪式 1. 安装依赖：准备魔法材料在开始我们的前端魔法之前&…...

编程日记 2025/7/1 15:27:32

SpringCloud(二)--SpringCloud服务注册与发现

一. 引言前文简单介绍了SpringCloud的基本简介与特征，接下来介绍每个组成部分的功能以及经常使用的中间件。本文仅为学习所用，联系侵删。二. SpringCloud概述 2.1 定义 Spring Cloud是一系列框架的有序集合，它巧妙地利用了Spring…...

编程日记 2025/6/29 16:50:45

JavaVue-Get请求数组参数(qs格式化前端数据)

前言现在管理系统，像若依，表格查询一般会用Get请求，把页面的查询条件传递给后台。其中大部分页面会有日期时间范围查询这时候，为了解决请求参数中的数组文件，前台就会在请求前拦截参数中的日期数组数据，然…...

编程日记 2025/7/3 21:53:07

Java-多种方法实现多线程卖票

Java多线程卖票是一个经典的并发编程问题，它展示了如何在多个线程之间安全地共享和修改资源。以下是几种实现方式：使用synchronized关键字：使用synchronized修饰符来同步方法或代码块，确保同一时刻只有一个线程可以访问临界区（即操作共享资源的代码）。使用Reen…...

编程日记 2025/7/5 7:07:54

LLVM防忘录

目录 Windows中源码编译LLVMWindows下编译LLVM Pass DLL Windows中源码编译LLVM 直接从llvm-project下载源码, 然后解压后用VS2022打开该目录, 然后利用VS的开发终端执行: cmake -S llvm -B build -G "Visual Studio 17 2022" -DLLVM_ENABLE_PROJECTSclang -DLLVM_…...

编程日记 2025/7/3 1:11:48

Elasticsearch：基础概念

一、什么是Elasticsearch Elasticsearch是基于 Apache Lucene 构建的分布式搜索和分析引擎、可扩展数据存储和矢量数据库。它针对生产规模工作负载的速度和相关性进行了优化。使用 Elasticsearch 可以近乎实时地搜索、索引、存储和分析各种形状和大小的数据。Elasticsearch 是…...

编程日记 2025/7/5 7:29:26

【快速实践】类激活图（CAM，class activation map）可视化

类激活图可视化：有助于了解一张图像的哪一部分让卷积神经网络做出了最终的分类决策对输入图像生成类激活热力图类激活热力图是与特定输出类别相关的二维分数网格：对任何输入图像的每个位置都要进行计算，它表示每个位置对该类别的重要程度我…...

编程日记 2025/7/2 4:32:55

从零开始自搭SpringBoot项目 -- Qingluopay项目工程介绍

从零开始自搭项目 – QingLuoPay 一，为什么要从零开始自搭项目首先在介绍这个项目之前先介绍一下我为什么要选择从零自搭项目，而不是跟着网上哪些视频等做项目。之前的很长一段时间我也都是在网上找一些做项目的视频就包含黑马的（神领物…...

编程日记 2025/7/2 5:13:38

使用 Jupyter Notebook：安装与应用指南

文章目录安装 Jupyter Notebook1. 准备环境2. 安装 Jupyter Notebook3. 启动 Jupyter Notebook4. 选择安装方式（可选） 二、Jupyter Notebook 的基本功能1. 单元格的类型与运行2. 可视化支持3. 内置魔法命令三、Jupyter Notebook 的实际应用场景1. 数据…...

编程日记 2025/6/30 4:08:51

.NET框架用C#实现PDF转HTML

HTML作为一种开放标准的网页标记语言，具有跨平台、易于浏览和搜索引擎友好的特性，使得内容能够在多种设备上轻松访问并优化了在线分享与互动。通过将PDF文件转换为HTML格式，我们可以更方便地在浏览器中展示PDF文档内容，同时也更容…...

编程日记 2025/7/5 7:32:03

使用 httputils + chronicle-bytes 实现金融级 java rpc

1、认识 chronicle-bytes Chronicle-Bytes 是一个类似于 Java NIO 的 ByteBuffer 的高效字节操作库，但它提供了许多扩展功能。这个项目由 OpenHFT 开发并维护，旨在提供高性能、低延迟的数据处理解决方案。Chronicle-Bytes 设计用于高频率交易和其他对性…...

编程日记 2025/7/1 19:02:29

开源模型应用落地-Qwen2.5-7B-Instruct与vllm实现推理加速的正确姿势-利用KOR框架实现结构化输出（七）

一、前言目前，大语言模型已升级至Qwen2.5版本。无论是语言模型还是多模态模型，均在大规模多语言和多模态数据上进行预训练，并通过高质量数据进行后期微调以贴近人类偏好。在本篇学习中，将集成vllm实现模型推理加速，现在，我们赶紧跟上技术发展的脚步，去体验一下新版本模…...

编程日记 2025/7/1 18:53:20

利用大语言模型解决推理任务

利用大语言模型（Large Language Models, LLMs）来解决推理任务是目前人工智能领域中的一个重要研究方向。大语言模型，如GPT系列（包括ChatGPT）和BERT等，具有强大的自然语言理解和生成能力，已经能够…...

编程日记 2025/7/3 4:19:46

修复OpenLinkSaas客户端在使用AtomGit账号时页面崩溃

问题描述：当一个新的AtomGit用户登录OpenLinkSaas客户端后出现了页面崩溃。从浏览器控制台来看，是gitNoticeList出现了null。查看代码后发现是请求atomGit api是返回的一个null的列表接下来我们加下保护性的代码，来兼容null或undefine的情…...

编程日记 2025/7/5 7:36:55

如何使用大语言模型进行事件抽取与关系抽取

诸神缄默不语-个人CSDN博文目录文章目录 1. 什么是事件抽取与关系抽取？2. 示例：使用大语言模型进行事件抽取与关系抽取 1. 什么是事件抽取与关系抽取？ 事件抽取是指从文本中识别出与某些“事件”相关的信息。这些事件通常包括动作、参与者、…...

编程日记 2025/7/1 16:28:37

WebRTC线程的启动与运行

WebRTC线程运行的基本逻辑： while(true) {…Get(&msg, …);…Dispatch(&msg);… }Dispatch(Message *pmsg) {…pmsg->handler->OnMessage(pmsg);… }在执行函数内部，就是一个while死循环，只做两件事，从队列里Get取…...

编程日记 2025/7/1 15:58:29

Unity3D ILRuntime开发原则与接口绑定详解

引言 ILRuntime是一款基于C#的热更新框架，使用IL2CPP技术将C#代码转换成C代码，支持动态编译和执行代码，适用于Unity3D的所有平台，包括Android、iOS、Windows、Mac等。本文将详细介绍ILRuntime在Unity3D中的开发原则及接口绑定技术…...

编程日记 2025/6/29 19:09:44

grouped = df.drop(‘name‘, axis=1).groupby(‘team‘)

这行代码： grouped df.drop(name, axis1).groupby(team)的作用是首先删除 DataFrame 中的 name 列，然后按 team 列进行分组。以下是对每个部分的详细解释： 1. df.drop(name, axis1) df.drop(name, axis1) 这部分代码会从 DataFrame df 中…...

编程日记 2025/7/1 6:15:22

mysqll连接用时太长解决方法

1、连接用时太长分析从客户端连接mysql服务器，时间长达10几秒，此为mysql的dns的反向解析造成，在局域网内如果都是用ip连接，可以通过在配置文件中添加skip-name-resolve，取消此功能，取消后，就不…...

编程日记 2025/7/1 4:19:45