AI Git Commit

AI Git Commit 是一个 VS Code 扩展，利用大语言模型（LLM）自动生成符合 Conventional Commits 规范的 Git 提交信息。

功能特性

✨ 智能生成: 分析暂存区代码变更，自动生成精准的提交信息
📏 规范遵循: 严格遵循 Conventional Commits 格式 (<type>(<scope>): <description>)
🌐 多语言支持: 支持英文和中文提交信息，技术术语始终保持英文
🤖 多 Provider 支持: OpenAI、Claude、Gemini 以及自定义 API
⚡ 智能截断: 自动处理大型 diff，避免 Token 溢出
🔐 安全存储: 使用 VS Code SecretStorage 加密存储 API Key

使用方式

1. 安装扩展

从 VS Code Marketplace 搜索并安装 AI Git Commit。

2. 配置

在 VS Code 设置中配置以下选项：

{
  "aiCommit.provider": "openai", // 选择 Provider: openai | claude | gemini | custom
  "aiCommit.model": "gpt-4", // 模型名称（可选，默认使用推荐模型）
  "aiCommit.baseUrl": "", // 自定义 API 地址（可选）
  "aiCommit.language": "English" // 语言: English | Chinese
}

3. 配置 API Key

首次使用时，扩展会提示输入 API Key。也可以通过命令面板手动配置：

打开命令面板 (Ctrl+Shift+P / Cmd+Shift+P)
执行 AI: 生成 Git 提交信息
按提示输入 API Key

4. 生成提交信息

在 VS Code 中暂存你的代码变更
点击 SCM 视图中的 ✨ 图标按钮
或使用命令面板执行 AI: 生成 Git 提交信息
AI 将自动分析变更并填充提交信息到输入框

支持的 Commit Types

feat: 新增功能
fix: 修复 Bug
docs: 文档修改
style: 代码格式调整（不影响逻辑）
refactor: 代码重构
perf: 性能优化
test: 测试相关
build: 构建系统或外部依赖更改
ci: CI 配置更改
chore: 构建过程或辅助工具变动
revert: 版本回滚
deps: 依赖项更新

Provider 配置示例

OpenAI

{
  "aiCommit.provider": "openai",
  "aiCommit.model": "gpt-4",
  "aiCommit.baseUrl": "" // 或使用代理: "https://your-proxy.com"
}

Claude

{
  "aiCommit.provider": "claude",
  "aiCommit.model": "claude-3-5-sonnet-20241022"
}

Gemini

{
  "aiCommit.provider": "gemini",
  "aiCommit.model": "gemini-1.5-pro"
}

自定义 (OpenAI 兼容 API)

{
  "aiCommit.provider": "custom",
  "aiCommit.baseUrl": "https://your-custom-api.com",
  "aiCommit.model": "your-model-name"
}

智能截断机制

当暂存区 diff 超过 10,000 行时：

扩展会提示用户分批提交以获得更准确的描述
如果用户选择继续，自动截断到前 5,000 行
生成的提交信息会添加 (部分变更) 标记

技术术语处理

无论配置为何种语言，技术术语始终保持英文：

英文: feat(auth): add JWT validation
中文: feat(auth): 添加 JWT 验证（"JWT" 保持英文）

开发

环境要求

Node.js >= 18
pnpm >= 10

安装依赖

pnpm install

编译

pnpm run compile

运行测试

pnpm test
pnpm test:coverage  # 查看覆盖率报告

调试

按 F5 在 VS Code Extension Development Host 中启动调试。

许可证

MIT

反馈与贡献

欢迎提交 Issue 和 Pull Request！

Issue: GitHub Issues
PR: GitHub Pull Requests

ariso-commit