# vse_gitCommit **Repository Path**: odinsam/vse_git-commit ## Basic Information - **Project Name**: vse_gitCommit - **Description**: vscode插件: git commit 规范化提交插件 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2025-11-29 - **Last Updated**: 2025-12-08 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 规范化 Git 提交 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-2.0.0-blue.svg)](https://gitee.com/odinsam/vse_git-commit) [![VSCode](https://img.shields.io/badge/VSCode-%3E%3D1.74.0-blue.svg)](https://code.visualstudio.com/) [![Author](https://img.shields.io/badge/author-odinsam-green.svg)](https://www.odinsam.com) VSCode 扩展：规范化 Git 提交信息，支持 Angular 格式和自定义模板，自动获取版本号，完整的 Git Flow 工作流程支持。 **作者**: [odinsam](https://www.odinsam.com) ## 功能特性 - ✅ 支持 Angular 格式提交模板：` (): ` - ✅ 支持自定义提交模板 - ✅ 支持自定义提交类型 - ✅ 自动获取版本号（可选） - ✅ 支持 Emoji 图标（可配置） - ✅ 交互式提交信息填写 - ✅ 支持多仓库工作区 - ✅ 支持多项目配置（Monorepo） - ✅ 自动从配置文件读取版本号 - ✅ 完整的 Git Flow 工作流程支持 - ✅ 智能分支检测和操作推荐 ## 安装 ### 从源码安装 1. 克隆或下载本项目 2. 在项目目录下运行 `npm install` 安装依赖 3. 运行 `npm run compile` 编译项目 4. 按 `F5` 在扩展开发宿主中运行，或使用 `vsce package` 打包为 .vsix 文件 ## 使用说明 ### 基本使用 1. 在 VSCode 中打开包含 Git 仓库的项目 2. 在源代码管理（SCM）面板中，点击提交按钮旁的图标进行提交 3. 点击 Git Flow 按钮（分支图标）进行 Git Flow 操作 4. 或者使用命令面板（`Ctrl+Shift+P` / `Cmd+Shift+P`），输入相关命令 > **注意**：在使用前，扩展会自动检查是否存在 `.gitcommit` 配置文件。如果不存在，会询问是否创建配置文件。 ### Commit 流程 1. **选择模板**：选择提交使用的模板（默认 Angular 格式） 2. **选择类型**：选择提交类型（feat、fix、docs 等） 3. **填写信息**： - Scope（可选）：修改范围 - Subject（必填）：提交概述 - Body（可选）：详细说明 - Footer（可选）：备注信息 4. **完成**：提交信息会自动填充到 Git 提交输入框，如果启用了 `autoVersion`，会自动添加版本信息 ### Git Flow 工作流程 Git Flow 是一个 Git 分支管理模型，帮助团队更好地管理代码发布流程。 #### 快速开始 1. **初始化 Git Flow**： - 点击 SCM 面板的 Git Flow 按钮 - 选择"初始化 Git Flow" - 设置主分支名称（master/main）和开发分支名称（develop） 2. **使用 Git Flow**： - 点击 SCM 面板的 Git Flow 按钮 - 根据当前分支类型，扩展会智能显示相关操作 - 选择要执行的操作 #### 分支类型说明 **主分支（Master/Main）**： - 生产环境的稳定代码 - 每次发布都会在此分支上打标签 **开发分支（Develop）**： - 日常开发的主分支 - 包含即将发布的功能和改进 **Feature 分支**： - 从 `develop` 分支创建 - 用于开发新功能 - 完成后合并回 `develop` **Release 分支**： - 从 `develop` 分支创建 - 用于准备新版本发布 - 完成后合并到 `master` 和 `develop`，并在 `master` 上创建标签 **Hotfix 分支**： - 从 `master` 分支创建 - 用于紧急修复生产环境问题 - 完成后合并到 `master` 和 `develop`，并在 `master` 上创建标签 #### 智能操作推荐扩展会根据当前所在的分支类型，智能推荐相关操作： - **在 Feature 分支上**：优先显示"完成当前 Feature 分支" - **在 Release 分支上**：优先显示"完成当前 Release 分支" - **在 Hotfix 分支上**：优先显示"完成当前 Hotfix 分支" - **在其他分支上**：显示所有可用操作 #### 操作示例 **场景：你在 `feature/user-login` 分支上开发完成** 1. 点击 SCM 面板的 Git Flow 按钮 2. 选择"完成当前 Feature 分支" 3. 选择是否保留分支 4. 自动合并到 `develop` 分支 **场景：准备发布新版本** 1. 点击 SCM 面板的 Git Flow 按钮 2. 选择"Release: 开始" 3. 输入版本号（如：1.0.0） 4. 在 Release 分支上进行测试和修复 5. 完成后选择"完成当前 Release 分支" 6. 输入 Tag 消息（可选） 7. 自动合并到 `master` 和 `develop`，并创建标签 ### 配置选项在 VSCode 设置中搜索 "odinsamGitCommit" 进行配置： - **showEmoji**: 是否显示 Emoji 图标（默认：true） - **maxSubjectWords**: Subject 的最大长度（默认：50） - **customCommitType**: 自定义提交类型 - **templates**: 自定义提交模板 - **autoVersion**: 是否在提交信息中自动添加版本号（默认：false） ### 自定义模板在设置中配置自定义模板： ```json { "odinsamGitCommit.templates": [ { "templateName": "Angular", "templateContent": "():