README.zh-CN.md

Dish AI Commit Gen

使用 AI 生成标准化 Git/SVN 提交消息的 VSCode 扩展

报告 Bug · 请求新功能

English | 简体中文

一个使用 AI 生成标准化 Git/SVN 提交消息的 VSCode 扩展。支持 OpenAI、Ollama、VSCode 内置 AI 服务、智谱 AI、DashScope、Gemini AI 和豆包 AI。

🆓 免费 AI 模型支持

• 智谱 AI (GLM-4-Flash)

  • 免费额度：每个账号固定月度免费额度（速率限制指南）
  • 在此获取智谱 API Key

• Gemini AI (gemini-2.0-flash-exp)

  • 免费额度：10 RPM 每天 1500 次请求
  • 在此获取 Gemini API Key

特性

🤖 多平台 AI 支持

• OpenAI API

  • 适用于需要高质量生成结果的场景
  • 支持多个模型包括 GPT-3.5/GPT-4
  • 需要 API Key，按使用量收费

• Ollama

  • 本地部署，无需联网
  • 支持多个开源模型
  • 适用于对数据隐私有要求的场景

• VSCode 内置 AI

  • 使用 VSCode 内置的 GitHub Copilot
  • 需要有效的 GitHub Copilot 订阅
  • 配置：将 provider 设置为 "vscode"

• 智谱 AI (GLM-4)

  • 优秀的中文处理能力
  • 固定月度免费额度
  • 适合中国用户使用

• DashScope

  • 阿里云提供的 AI 服务
  • 支持通义千问系列模型
  • 适合企业级应用

• Gemini AI

  • Google 提供的 AI 服务
  • 每日免费额度：1500 次请求
  • 适合个人开发者

📝 版本控制系统支持

• SVN
• Git

📊 周报生成

• AI 驱动的周报生成
• 自动总结你的工作进展
• 可自定义报告模板
• 支持多个 AI 提供商进行报告生成

🌍 多语言提交消息生成

支持以下 19 种语言：

• 简体中文 (简体中文)
• 繁體中文 (繁體中文)
• 日语 (日本語)
• 韩语 (한국어)
• 捷克语 (Čeština)
• 德语 (Deutsch)
• 法语 (Français)
• 意大利语 (Italiano)
• 荷兰语 (Nederlands)
• 葡萄牙语 (Português)
• 越南语 (Tiếng Việt)
• 英语
• 西班牙语 (Español)
• 瑞典语 (Svenska)
• 俄语 (Русский)
• 印度尼西亚语 (Bahasa Indonesia)
• 波兰语 (Polski)
• 土耳其语 (Türkçe)
• 泰语 (ไทย)

🎨 符合 Conventional Commits 规范

生成的提交消息遵循 Conventional Commits 规范：

• 提交消息格式：

  <类型>[可选作用域]: <描述>
  
  [可选正文]
  
  [可选脚注]
  

• 支持的提交类型：

  • feat：新功能
  • fix：修复 bug
  • docs：文档更改
  • style：代码样式调整
  • refactor：代码重构
  • perf：性能改进
  • test：测试相关改动
  • build：构建相关改动
  • ci：CI/CD 相关改动
  • chore：其他改动
  • revert：回滚提交

• 自动作用域检测：

  • 从修改的文件路径自动推断
  • 智能分类多文件更改
  • 通过配置自定义作用域规则

• 支持重大更改：

  • 使用 ! 标记重大更改
  • 在正文中详细描述影响
  • 示例：feat!: 重构认证系统

• 智能描述生成：

  • 自动代码更改分析
  • 关键修改点提取
  • 生成清晰简洁的描述

😄 自动添加表情符号

• 自动为提交消息添加表情符号
• 可以通过配置启用/禁用：

{
  "dish-ai-commit.features.commitFormat.enableEmoji": true // 启用表情符号
}

• 表情符号自动匹配提交类型：
  • ✨ feat: 新功能
  • 🐛 fix: 修复 bug
  • 📝 docs: 文档
  • 💄 style: 样式
  • ♻️ refactor: 重构
  • ⚡️ perf: 性能
  • ✅ test: 测试
  • 🔧 chore: 其他改动

📊 代码分析功能

• 智能代码差异分析
• 自动简化复杂代码更改
• 保留关键上下文信息
• 通过 maxLineLength 和 contextLines 自定义分析行为

🔄 合并提交支持

通过启用 enableMergeCommit 选项，您可以：

• 将多个相关文件的更改合并到一个提交消息中
• 自动分析文件关联
• 生成更简洁的提交记录

📝 周报模板

周报生成支持自定义模板：

• 通过 systemPrompt 配置自定义提示
• 按项目/任务总结
• 自定义报告格式和关键内容

📋 要求

• VS Code 1.80.0+
• SVN 命令行工具
• SVN SCM（可选） - 如果需要在 VSCode 的 SCM 输入框中输入提交消息，请安装 SVN SCM v2.18.1+
• 有效的 AI 服务配置（OpenAI API Key 或 Ollama 服务）

配置

配置项	类型	默认值	描述
dish-ai-commit.base.language	string	简体中文	提交消息语言
dish-ai-commit.base.systemPrompt	string	""	自定义系统提示
dish-ai-commit.base.provider	string	OpenAI	AI 提供商
dish-ai-commit.base.model	string	gpt-3.5-turbo	AI 模型
dish-ai-commit.providers.openai.apiKey	string	""	OpenAI API key
dish-ai-commit.providers.openai.baseUrl	string	https://api.openai.com/v1	OpenAI API 基础 URL
dish-ai-commit.providers.zhipu.apiKey	string	""	智谱 AI API key
dish-ai-commit.providers.dashscope.apiKey	string	""	DashScope API key
dish-ai-commit.providers.doubao.apiKey	string	""	豆包 AI API key
dish-ai-commit.providers.ollama.baseUrl	string	http://localhost:11434	Ollama API 基础 URL
dish-ai-commit.providers.gemini.apiKey	string	""	Gemini AI API key
dish-ai-commit.features.codeAnalysis.simplifyDiff	boolean	false	启用差异内容简化
dish-ai-commit.features.codeAnalysis.maxLineLength	number	120	简化后最大行长度
dish-ai-commit.features.codeAnalysis.contextLines	number	3	保留的上下文行数
dish-ai-commit.features.commitFormat.enableMergeCommit	boolean	false	允许将多个文件更改合并为一个提交
dish-ai-commit.features.commitFormat.enableEmoji	boolean	true	在提交消息中使用表情符号
dish-ai-commit.features.weeklyReport.systemPrompt	string	""	周报的自定义系统提示

命令

命令 ID	类别	标题	描述
dish-ai-commit.selectModel	[Dish AI Commit]	选择提交生成的 AI 模型	选择用于生成提交消息的 AI 模型
dish-ai-commit.generateWeeklyReport	[Dish AI Commit]	生成周报	生成 AI 驱动的每周工作报告

配置说明

1. OpenAI 配置

{
  "dish-ai-commit.base.provider": "openai",
  "dish-ai-commit.providers.openai.apiKey": "your-api-key",
  "dish-ai-commit.providers.openai.baseUrl": "https://api.openai.com/v1"
}

2. Ollama 配置

{
  "dish-ai-commit.base.provider": "ollama",
  "dish-ai-commit.providers.ollama.baseUrl": "http://localhost:11434"
}

3. VSCode 配置

{
  "dish-ai-commit.base.provider": "vscode"
}

📋 如何使用

• 从源代码管理器中选择要提交的文件
• 点击源代码管理器标题栏中的 "Dish AI Commit" 图标
• 或在命令面板中执行 "Dish AI Commit" 命令
• AI 将自动生成符合规范的提交消息

📥 安装

1. 从 VS Code 扩展市场搜索 "Dish AI Commit"
2. 点击安装
3. 重启 VS Code
4. 根据实际需要配置 AI 服务参数

📝 更新日志

请参阅 CHANGELOG.md 了解详细的版本历史。

📋 依赖要求

• VS Code 1.80.0+
• SVN 命令行工具
• SVN SCM（可选） - 如果需要在 VSCode 的 SCM 输入框中输入提交信息，请安装 SVN SCM v2.18.1+
• 有效的 AI 服务配置（OpenAI API Key 或 Ollama 服务）

💡 常见问题

• 确保正确安装并可访问 SVN 命令行工具
• 确保正确安装并启用 SVN SCM 扩展
• 配置正确的 AI 服务参数
• 确保网络可以访问所选的 AI 服务

🛠️ 开发指南

您可以使用 Github Codespaces 进行在线开发：

或者，您可以克隆仓库并运行以下命令进行本地开发：

$ git clone https://github.com/littleCareless/dish-ai-commit
$ cd ai-commit
$ npm install

在 VSCode 中打开项目文件夹。按 F5 运行项目。将弹出一个新的扩展开发主机窗口并启动扩展。

🤝 贡献指南

我们欢迎所有形式的贡献，包括但不限于：

• 提交 Issues 报告 bug
• 提出新功能
• 提交 Pull Request 改进代码
• 改进文档

请确保在提交 PR 之前：

1. 代码已测试

2. 更新相关文档

3. 遵循项目代码规范

💗 感谢我们的贡献者

🙏 鸣谢

本项目受以下优秀开源项目启发并参考：

• svn-scm - VSCode 的 SVN 源代码管理
• vscode - Visual Studio Code 编辑器
• vscode-gitlens - VSCode 的 Git 超级助手
• ai-commit - AI 辅助的 Git 提交消息生成

📄 许可证

本项目采用 MIT 许可证。