0

0

Sublime优化Git提交信息规范_集成Commitizen与Commitlint

冰火之心

冰火之心

发布时间:2025-12-06 22:22:57

|

200人浏览过

|

来源于php中文网

原创

在 Sublime Text 中集成 Commitizen 和 Commitlint 可规范 Git 提交格式:先全局安装 Commitizen 并配置 cz-conventional-changelog,再通过 SublimeGit/GitSavvy 或自定义构建系统调用 git cz;接着安装 Commitlint 与 Husky,在 commit-msg 钩子中校验消息格式;最后可选安装 Conventional Commits 插件实现语法高亮与模板提示。

sublime优化git提交信息规范_集成commitizen与commitlint

在 Sublime Text 中集成 Commitizen 和 Commitlint,能有效规范 Git 提交信息格式,提升团队协作效率和代码可追溯性。核心思路是:用 Commitizen 替代手动输入 commit message,再通过 Commitlint 在本地校验格式是否符合约定式提交(Conventional Commits)标准。

安装并配置 Commitizen CLI

Commitizen 是一个交互式提交工具,帮你按规则生成标准化的提交信息。

  • 全局安装:npm install -g commitizen cz-conventional-changelog
  • 配置项目级适配器:在项目根目录创建 package.json(若无),添加字段:
    "config": { "commitizen": { "path": "cz-conventional-changelog" } }
  • 验证是否生效:终端执行 git cz,应出现交互式菜单(如 feat、fix、docs 等类型选项)

在 Sublime Text 中调用 git cz

Sublime 默认不支持直接运行交互式 CLI 命令,需借助插件或自定义构建系统实现无缝调用。

  • 推荐使用 SublimeGit 插件(付费但稳定)或 GitSavvy(免费开源)——二者均支持绑定 git cz 命令到快捷键
  • 若偏好轻量方案,可手动配置构建系统:
    新建 Tools → Build System → New Build System,填入以下内容并保存为 GitCZ.sublime-build
    {
      "shell_cmd": "git cz",
      "working_dir": "${project_path:${folder}}",
      "variants": [
        {
          "name": "With --no-verify",
          "shell_cmd": "git cz --no-verify"
        }
      ]
    }
    
  • 之后按 Ctrl+Shift+B(Win/Linux)或 Cmd+Shift+B(Mac),选择 GitCZ 即可启动交互式提交

接入 Commitlint 实现本地校验

Commitlint 负责检查 commit message 是否符合约定式提交规范,防止不合规提交进入仓库。

LongCat AI
LongCat AI

美团推出的AI对话问答工具

下载
  • 安装依赖:npm install --save-dev @commitlint/config-conventional @commitlint/cli
  • 创建配置文件 commitlint.config.js(项目根目录):
    module.exports = {
      extends: ['@commitlint/config-conventional']
    };
    
  • 配置 Husky(推荐 v8+)实现 pre-commit 钩子自动校验:
    npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'
  • 注意:此钩子在 Sublime 中通过 git cz 提交时同样生效,不合规范会中止提交并提示错误

可选增强:Sublime 内置语法高亮与模板提示

提升编写体验,降低学习成本。

  • 安装插件 Conventional Commits(Package Control 可搜),提供 commit message 的语法高亮和自动补全
  • 在 Sublime 的 Preferences → Settings – Syntax Specific 中为 Plain TextGit Commit 类型设置默认占位符,例如:
    {
      "placeholder": "type(scope): subject\n\nbody\n\nfooter"
    }
    
  • 配合 GitSavvy,还能在提交面板中预览解析后的 type、scope、subject 结构,便于自查

基本上就这些。Commitizen + Commitlint 的组合在 Sublime 中虽不如 VS Code 生态开箱即用,但配置一次后即可长期受益——提交更规范、PR 更清晰、Changelog 生成也更可靠。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

414

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

310

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

75

2025.09.10

js正则表达式
js正则表达式

php中文网为大家提供各种js正则表达式语法大全以及各种js正则表达式使用的方法,还有更多js正则表达式的相关文章、相关下载、相关课程,供大家免费下载体验。

510

2023.06.20

js获取当前时间
js获取当前时间

JS全称JavaScript,是一种具有函数优先的轻量级,解释型或即时编译型的编程语言;它是一种属于网络的高级脚本语言,主要用于Web,常用来为网页添加各式各样的动态功能。js怎么获取当前时间呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

244

2023.07.28

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

258

2023.08.03

js是什么意思
js是什么意思

JS是JavaScript的缩写,它是一种广泛应用于网页开发的脚本语言。JavaScript是一种解释性的、基于对象和事件驱动的编程语言,通常用于为网页增加交互性和动态性。它可以在网页上实现复杂的功能和效果,如表单验证、页面元素操作、动画效果、数据交互等。

5286

2023.08.17

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

19

2026.01.20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 7.5万人学习

Git 教程
Git 教程

共21课时 | 2.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号