【git commit】VSCode中使用Husky & commitlint规范commit messages

最新推荐文章于 2024-08-29 09:46:01 发布
最新推荐文章于 2024-08-29 09:46:01 发布
阅读量3.1k 收藏 3
点赞数
分类专栏： git
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_33539213/article/details/106215608
版权

用于规范git commit信息，提高团队协作效率。

Conventional Commits（约定式提交规范）

它的 message 格式如下:

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

分别对应 Commit message 的三个部分：Header，Body 和 Footer。

Header

Header 部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。

  • type: 用于说明 commit 的类型。一般有以下几种:
feat: 新增feature
fix: 修复bug
docs: 仅仅修改了文档，如readme.md
style: 仅仅是对格式进行修改，如逗号、缩进、空格等。不改变代码逻辑。
refactor: 代码重构，没有新增功能或修复bug
perf: 优化相关，如提升性能、用户体验等。
test: 测试用例，包括单元测试、集成测试。
chore: 改变构建流程、或者增加依赖库、工具等。
revert: 版本回滚
  • scope: 用于说明 commit 影响的范围，比如: views, component, utils, test…
  • subject: commit 目的的简短描述

Body

对本次 commit 修改内容的具体描述, 可以分为多行。如下图:

# body: 72-character wrapped. This should answer:
# * Why was this change necessary?
# * How does it address the problem?
# * Are there any side effects?
# initial commit

Footer

一些备注, 通常是 BREAKING CHANGE(当前代码与上一个版本不兼容) 或修复的 bug(关闭 Issue) 的链接。

方法一：使用VSCode插件

在插件库搜索Visual Studio Code Commitizen Support 安装，使用快捷键command+shift+P即可按规范提交。

方法二：安装Husky & commitlint

全局安装

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

husky继承了Git下所有的钩子，在触发钩子的时候，husky可以阻止不合法的commit,push等等

npm install husky --save-dev

在 package.json 中配置脚本:

"commitlint": {
    "extends": [
      "@commitlint/config-conventional"
    ]
  },

"husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
 },

完成。
参考：

sakoooo
关注
专栏目录
git Husky 搭配 commitizen ，规范代码提交
贤蛋大眼萌
10-23 6016
husky可以帮助我们在 执行 git commit 提交的时候，按照eslint 规范进行修复代码。husky是一个git hook工具，可以帮助我们触发git提交的各个阶段：pre-commit、commit-msg、pre-push 支持所有的Git 钩子简单说就是在 Git 执行一些操作时，在钩子处执行一些自己需要的命令。
vue3+vite+ts 配置commit强制码提交规范配置 commitlint
周家大小姐
02-08 1389
文件配置根路径创建文件.husky文件创建 commit-msgpackage.json添加代码。
vscode-commitlint：VS Code的commitlint集成
02-13
vscode-commitlint VS Code扩展，可将集成到。 特征 在编写时针对提交消息运行commitlint 报告皮棉 根据特定问题突出显示提交的相关部分 自动检测提交配置 支持所有提交规则 要求 为了充分利用此扩展，您可能需要在项目中配置commitlint并将VS Code用作git commit编辑器：
推荐：提升Git提交规范的神器 —— vscode-commitizen
最新发布
gitblog_01145的博客
08-29 535
推荐：提升Git提交规范的神器 —— vscode-commitizen vscode-commitizenVisual Studio Code Commitizen Support项目地址:https://gitcode.com/gh_mirrors/vs/vscode-commitizen 在软件开发的日常工作中，良好的代码提交习惯对于版本控制管理至关重要。今天，我们要向大家隆重推荐一款专为...
vscode commitlint（debug npm scripts）
weixin_34228662的博客
11-18 721
最近在使用commitlint校验提交git提交日志的时候遇到点奇怪的问题，在这里记录下解决方案。 windows下使用默认命令“commitlint -e $GIT_PARAMS”校验会报“GIT_PARAMS is not available globally” 这个问题的原因是windows的环境变量中没有“GIT_PARAMS”，我换成windows下的环境变量形式“%GIT_PARA...
git-commit-lint-vscode:vscode一款git 规范化提交插件
05-17
git-commit-lint-vscode 在日常的开发中,目前主流的代码管理工具就是 git 了,当我们对代码进行改动了,首先得git commit提交到本地仓库,git 规定了提交时必须填写提交信息作为改动说明,保存 commit 历史中,可以找到历史代码,也方便他人 review,还可以输出 CHANGELOG,对项目的研发质量都有很大的提升。 但是在平时的工作中,大部分对于commit 都是简单的填写,没有好好的重视,这对于项目管理和维护来说,无疑是不友好的。这个插件就是规范化git提交规范,让你的提交不仅"好看"还"实用" git 规范提交从何说起? git 规范提交从哪里开始的呢?起源在哪呢?emmmmmm,这就追溯到了Angular了! 让我们看下Angular社区的提交规范 这个提交记录是不是一目了然?所以git commit规范下还是很有必要的! 说明 类型 emji
vscode-commit-message-editor:以方便的方式编辑提交消息
03-09
提交消息编辑器 以方便的方式编辑提交消息。 特征 从最近的提交中选择一个较早的提交消息 编辑表单中的提交消息 可定制的常规提交消息模板 可自定义的表单字段 修改最后的提交信息 原生外观（由） 出厂设置遵循规范。 要求 内置Git扩展 扩展设置 此扩展程序提供以下设置： commit-message-editor.confirmAmend ：在修改提交消息之前显示确认对话框 commit-message-editor.staticTemplate ：文本视图的模板 commit-message-editor.dynamicTemplate ：表单视图的模板 commit-message-editor.tokens ：表单视图中的可编辑输入 commit-message-editor.view.defaultView ：编辑器的默认视图（文本区域或表单） commit-message-e
推荐使用：VSCode Conventional Commits — 精准的Git提交管理插件
gitblog_00049的博客
06-23 973
推荐使用：VSCode Conventional Commits — 精准的Git提交管理插件 vscode-conventional-commits????Conventional Commits for VSCode.项目地址:https://gitcode.com/gh_mirrors/vs/vscode-conventional-commits 在日常开发中，规范化的Git提交信息不仅可以提高...
git commit规范化
xm2by的博客
07-27 769
git commit规范化 项目中，每次使用git提交代码时都需要填写提交信息，每个人填写提交信息的风格都不一样，为了保持项目中git commit一致性，就需要对git commit进行规范化处理，规范的git commit 可以让项目的提交信息整洁明了，也可以让我们通过提交信息可以清晰的知道本次提交的内容，出现问题时也可以更快速的查询问题，如果项目需要生成changelog日志，规范的git ...
git commit规范与配置
weixin_54882114的博客
03-12 3727
一、需求场景 在一个开发团队中，前端开发的代码管理越来越规范化、工程化，而代码commit更是需要一个统一的规范去约束，保证代码commit时的规范性。尤其多人参与一个项目开发时，大家的代码commit风格不相同，不便于后续的代码统一管理和可读性；所以良好的git commit风格是很重要的。 二、使用工具 1、commitlint 很多时候我们提交代码时，运行git commmit -m 'xxx'即可，而commitlint可以对message进行约束，是判...
Commitizen + Husky + Commitlint实现commit message校验
小陈的博客
05-23 1479
Commitizen, Husky, Commitlint 先简要地介绍这三个工具的作用，让大家对整个校验过程如何实现有一个大体的了解。 Commitizen：是一个命令行提示工具，它主要用于帮助我们更快地写出规范的commit message Commitlint：用于校验填写的commit message是否符合设定的规范 Husky：是一个git hook工具，用于在提交过程中的某个特定时刻触发commitlint 第一步：Commitizen 安装Commitizen有全局安装和单个项目安装两种
vscode-conventional-commits：forVSCode的常规提交
02-25
VSCode常规承诺 VSCode的承诺。 特征 此扩展名可以帮助您根据来填写提交消息。 支持。 有关详细信息，请参见。 支持在键入消息后自动提交和推送。 有关详细信息，请参见。 支持项目级范围管理。 支持 。 支持VSCode工作区。 用法 您可以通过两种方式访问​​VSCode常规提交： Command + Shift + P或Ctrl + Shift + P ，输入Conventional Commits ，然后按Enter 。 单击源控制菜单上的图标。 参见下图。 提交工作流程 建议的工作流程默认情况下会自动添加，提交和推送文件。 如果要扩展名仅填写消息，请禁用autoCommit配置。 推荐工作流程 激活扩展。 输入消息。 该扩展名将自动添加更改的文件，执行提交并将提交推送到远程。 如何配置 启用扩展的Settings > conventionalComm
git commit 提交信息规范入门(配合vscode)
热门推荐
川端小树的博客
10-02 1万+
1.前言 在git commit中提交信息中，如果能找按照规范写好，能提高可读性以及项目维护效率。本文针对message的规范和提交检测工具进行介绍。 2.参考的规范：Angular Team Commit Specification 详细的提交信息可以让人知道本次提交对原项目进行哪方面的修改。是修复bug、添加组件或模块、修改代码风格还是重构。从message中也可以知道针对哪部分的文档或模块进行修改。 但这个message到底要怎么去写比较好？这里可以参考Angular团队的git-commit
写出好的 commit message
weixin_33906657的博客
06-26 119
  为何要关注提交信息 加快Reviewing Code的过程 帮助我们写好release note 5年后帮你快速想起来某个分支，tag或者 commit增加了什么功能，改变了哪些代码 让其他的开发者在运行 git blame 的时候想跪谢 总之一个好的提交信息，会帮助你提高项目的整体质量 基本要求 第一行应该少于50个字。 随后是一个空行 第一行题目也可以写成：Fi...
git-commit 规范
まどか
05-06 138
commit 标识 标识 描述 feat 新增一个功能 fix 修复一个 Bug docs 文档变更（更新文档、Demo） ci 发布控件版本 style 代码风格变更（不影响功能，解决代码冲突、eslint 校验修改等） refactor 重构（即不是新增功能，也不是修改 bug 的代码变动） chore 开发工具变动（框架改动、eslint 规则变动等）...
git commit提交规范
qq_39598271的博客
11-24 303
Git提交规范可以参考Angular的提交规范说明 每个提交都包含header、body和footer三个部分，格式如下： <type>(<scope>): <subject> <BLANK LINE> <body> <BLANK LINE> <footer> header有三个部分：type、scope和subject，其中scope是可选的 type有以下几种： feat: A new feature fix: A
vue、vscode格式规范prettier、eslint、git commit
~
08-31 1441
6、为了避免有人将没有格式化的代码提交上去，我们可以在这时候就需要在 git commit 的阶段自动将提交的代码进行格式化。一般这样配置后，点击保存会按照prettier的规范来格式化我们的文件。假如我们的settting.json中配置过使用其他插件进行格式化的话可能会导致我们上面的操作未生效。执行命令对所有文件进行格式化【格式化后注意查看代码，避免格式代码带来问题】我的编辑器就是配置过下图中的注释掉的插件，就导致我的prettier未生效。5、假如我们的校验是在项目进行中途添加的。..........
vscode git使用，提交规范
zhangyubababa的博客
07-29 403
git
commit提交规范
weixin_40542544的博客
09-29 976
类型（type） feat:: 类型为 feat 的提交表示在代码库中新增了一个功能（这和语义化版本中的 MINOR 相对应）。 fix:：类型为 fix 的 提交表示在代码库中修复了一个 bug （这和语义化版本中的 PATCH 相对应）。 docs:: 只是更改文档。 style:: 不影响代码含义的变化（空白、格式化、缺少分号等）。 refactor:: 代码重构，既不修复错误也不添加功能。 perf:: 改进性能的代码更改。 test:: 添加确实测试或更正现有的测试。 build:: 影响构建系
git:husky>pre-commit
06-28
### 回答1： git:husky>pre-commit是一个Git钩子，它在提交代码前执行一些操作。通常用于代码风格检查、单元测试等操作，以确保代码质量和稳定性。Husky是一个Git钩子管理工具，可以方便地配置和管理Git钩子。 ### 回答2： Git是目前最流行的版本控制系统。在大多数项目中，代码的质量和一致性非常重要。在Git中，可以使用钩子(Hooks)来确保代码的质量和一致性。其中，pre-commit是常用的钩子之一。而Git: Husky则是Git中常用的钩子管理工具。 Git: Husky是一个钩子管理工具，它允许开发者进行钩子配置，包括在提交代码之前运行何种指令。 具体地说，Git: Husky支持pre-commit钩子，使开发者可以在代码提交之前运行一些脚本，以确保提交的代码的质量和一致性。 pre-commit钩子可以被用于在代码提交之前运行某些指令。例如：静态代码分析工具，或者在代码提交之前运行的测试。因此，pre-commit钩子可以帮助开发者检查代码错误、格式、风格等。其过程是：在代码提交之前，pre-commit钩子运行拖的脚本，检查指定的问题并生成反馈，然后提交成功或失败。 总之，Git: Husky中的pre-commit钩子是非常实用的工具。它可以让开发者在代码提交之前运行各种指令，以检查代码错误、格式、风格等。这有助于确保代码的质量和一致性，提高软件开发的效率和质量。所以，建议开发者在Git中应用Git: Husky这一钩子管理工具，并使用pre-commit钩子确保代码的质量。 ### 回答3： Git是一款非常流行的版本控制工具，而husky>pre-commit是Git中的一个功能。Husky是一款JavaScript库，可以通过它来为Git的hooks添加JavaScript脚本，而pre-commit是Git hook的一种类型，可以在commit前触发，并且可以运行一些脚本来帮助我们检查代码或其它工作。 在Git中，pre-commit可以帮助我们做很多事情。例如，在代码提交之前，我们可以用pre-commit来对代码进行语法检查、格式化、代码审查、代码测试等。如果代码不符合某些规范，pre-commit还可以阻止代码提交，从而让我们更加规范地管理代码。 使用husky>pre-commit也非常简单。首先，我们需要在项目中安装husky，然后在package.json文件中设置pre-commit属性来配置pre-commit hook。在pre-commit属性中，我们可以定义一个或多个需要执行的脚本，这些脚本会在commit之前执行。例如，我们可以在pre-commit中加入代码格式化、代码审查和代码测试三个脚本，来确保我们提交的代码符合团队的代码规范和质量要求。 总之，使用husky>pre-commit可以很好地帮助我们管理代码，确保代码的质量和一致性。这对于团队协作和代码维护都非常重要。同时，husky>pre-commit也可以提高我们的编码效率，让我们集中精力在代码逻辑的编写上，而不是在代码格式、代码规范等上浪费时间。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值