一款vscode git规范化提交的插件

vscode git规范化提交插件,欢迎star!

git-commit-lint-vscode

在日常的开发中,目前主流的代码管理工具就是 git 了,当我们对代码进行改动了,首先得git commit提交到本地仓库,git 规定了提交时必须填写提交信息作为改动说明,保存 commit 历史中,可以找到历史代码,也方便他人 review,还可以输出 CHANGELOG,对项目的研发质量都有很大的提升。

但是在平时的工作中,大部分对于commit 都是简单的填写,没有好好的重视,这对于项目管理和维护来说,无疑是不友好的。这个插件就是规范化git提交规范,让你的提交不仅"好看"还"实用"

git 规范提交从何说起?

git 规范提交从哪里开始的呢?起源在哪呢?emmmmmm,这就追溯到了Angular了!
让我们看下Angular社区的提交规范

这个提交记录是不是一目了然?所以git commit规范下还是很有必要的!

说明

类型emji描述
feat引入新功能
fix🐛修复 bug
style💄更新 UI 样式文按键
format🥚格式化代码
docs📝添加/更新文档
perf👌提高性能/优化
init🎉初次提交/初始化项目
test增加测试代码
refactor🎨改进代码结构/代码格式
patch🚑添加重要补丁
file📦添加新文件
publish🚀发布新版本
tag📌发布新版本
config🔧修改配置文件
git🙈添加或修改.gitignore 文件

使用效果

使用说明

  • 1
  • 2

下载

在 vscode 扩展中搜索 git-commit-lint-vscode 即可找到该插件。

插件配置

你可以在 vscode 的 文件 -> 首选项 -> 设置 -> 扩展 -> git-commit-lint-vscode 中对该插件进行配置,目前可选的配置项为:

  1. Accurate Locating: 当存在多个存储库时,是否精确定位到选定存储库的输入框,默认为。注:该功能在多数情况下可以正常运行,只有当你的源代码管理存储库存在多个存储库,如只选择部分存储库或顺序错误时,就会选中错误的输入框。
  2. Cover Input Value: 是否覆盖提交信息, 默认为。如果取消勾选,则会在之前的提交信息前插入 emoji 或者 code。
  3. Custom Format: 自定义 git 提交格式, 默认为${emoji}${code}: 。可以完全自定义 参数取Custom Type里面的key
  4. Custom Type: 自定义 git 提交类型, 默认为
[
  {
    "emoji": "✨",
    "type": "feat",
    "name": "引入新功能",
    "description": "新功能"
  },
  {
    "emoji": "🐛",
    "type": "fix",
    "name": "修复bug",
    "description": "bug"
  },
  {
    "emoji": "💄",
    "type": "style",
    "name": "更新UI样式文件",
    "description": "样式"
  },
  {
    "emoji": "🥚",
    "type": "format",
    "name": "格式化代码",
    "description": "格式化"
  },
  {
    "emoji": "📝",
    "type": "docs",
    "name": "添加/更新文档",
    "description": "文档"
  },
  {
    "emoji": "👌",
    "type": "perf",
    "name": "提高性能/优化",
    "description": "优化"
  },
  {
    "emoji": "🎉",
    "type": "init",
    "name": "初次提交/初始化项目",
    "description": "初始化"
  },
  {
    "emoji": "✅",
    "type": "test",
    "name": "增加测试代码",
    "description": "测试"
  },
  {
    "emoji": "🎨",
    "type": "refactor",
    "name": "改进代码结构/代码格式",
    "description": "优化"
  },
  {
    "emoji": "🚑",
    "type": "patch",
    "name": "添加重要补丁",
    "description": "补丁"
  },
  {
    "emoji": "📦",
    "type": "file",
    "name": "添加新文件",
    "description": "新文件"
  },
  {
    "emoji": "🚀",
    "type": "publish",
    "name": "发布新版本",
    "description": "新版本"
  },
  {
    "emoji": "📌",
    "type": "tag",
    "name": "发布版本/添加标签",
    "description": "书签"
  },
  {
    "emoji": "🔧",
    "type": "config",
    "name": "修改配置文件",
    "description": "配置"
  },
  {
    "emoji": "🙈",
    "type": "git",
    "name": "添加或修改.gitignore文件",
    "description": "不可见"
  }
]

issues

使用中可以在这提问,有什么需求同样可以在这提出来

https://github.com/UvDream/git-commit-lint-vscode/issues


U世界的V梦想
学习最新前沿技术

不专情前端的前端工程师

371 声望
23 粉丝
0 条评论
推荐阅读
图文讲解,团队开发中的 Git 最佳实践
在 2005 年的某一天,Linux 之父 Linus Torvalds 发布了他的又一个里程碑作品——Git。它的出现改变了软件开发流程,大大地提高了开发流畅度!直到现在仍十分流行,完全没有衰退的迹象。

Corwien11阅读 8.8k评论 1

git 常用命令 记录
有错误和改进的地方望留言,谢谢 : )顺便推荐一下,git入门教程Git 教程图解 GitPro Git 2(中文版)Git 使用Git 使用规范流程Git 工作流程Commit message 和 Change log 编写指南全局设置git config --system //...

Luff阅读 3.2k

VisBug:助力前端开发的浏览器插件
作为前端开发者相信肯定有遇到过以下场景:看到一个网站某个模块不错的样式效果想要看CSS代码开发过程中调整样式,如字符溢出,对齐,字体大小颜色之类更改网站数据或样式截图分享在开发过程中,我们通常会遇到需...

南城FE5阅读 1.7k评论 1

封面图
oh my zsh插件安装详细教程及常用插件
Oh My Zsh官网 [链接]Oh My Zsh简单来讲就是一款能让你更加方便的使用命令行的工具,它可以帮助我们高亮语法,自动联想命令,提升工作效率,可以说是程序员必备工具。

晚起的虫儿3阅读 35.7k

Chrome高效插件推荐
Chrome浏览器是目前世界上最受欢迎的浏览器之一,而Chrome的高效插件也是许多人的关注焦点。这篇文章将介绍一些可以帮助您在办公和学习中提高效率的Chrome插件。

指尖爱2阅读 780

封面图
git/pip/easy_install/apt代理/源设置
在公司内网环境中,访问公网往往需要经过公司的代理,对于浏览器、IDE等开发工具,都提供了设置代理的配置,而git、pip、easy_install等CLI工具,则需要通过命令或配置文件进行代理设置;对于Python、Ubuntu、Mav...

乘着风1阅读 5.5k

低代码开发重要工具:jvs-logic(逻辑引擎)2.1.6版本功能清单
逻辑引擎是一种能够处理逻辑表达式的程序,它能够根据用户输入的表达式计算出表达式的值。在实际应用中,逻辑引擎通常被用于处理规则引擎、决策系统、业务规则配置等领域,具有广泛的应用前景。前面几期我们了解...

软件部长2阅读 432

不专情前端的前端工程师

371 声望
23 粉丝
宣传栏