Skip to content

Commit

Permalink
✨ feat(rebranding): 重新命名并增强 AI 提交信息扩展
Browse files Browse the repository at this point in the history
项目重命名

将项目名称从 SVN AI Commit 更改为 Dish AI Commit Gen。
AI 提供商支持增强

提升了多提供商的 AI 集成,支持 OpenAI、Ollama 和 VSCode AI。
多语言支持

新增 23 种以上语言的支持,增强了国际化功能。
视觉设计更新

更新了视觉标识,采用现代化的 AI 主题设计。
功能改进

重构了 AI 提供商和 SCM 集成方式,优化了架构结构。
增强了错误处理机制与提示管理,提高稳定性和用户体验。
统一了 API 配置,确保跨平台的一致性。
更新了文档,扩展了对新功能的支持与说明。
  • Loading branch information
littleCareless committed Dec 6, 2024
1 parent 968e9aa commit 9f41dc1
Show file tree
Hide file tree
Showing 5 changed files with 239 additions and 68 deletions.
32 changes: 28 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,33 @@
# Change Log
# Changelog

All notable changes to the "svn-commit-gen" extension will be documented in this file.
All notable changes to this project will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## [Unreleased]

- Initial release
### ⚡ Changed

- 重命名项目从 SVN AI Commit 到 Dish AI Commit
- 重组 AI provider 和 SCM 集成
- 优化 AI provider 配置界面
- 改进模型选择和配置处理
- 增强错误处理和提示管理

### 🎨 Style

- 更新图标和 logo 为现代 AI 设计风格
- 采用蓝紫渐变背景和 AI 主题元素
- 优化各种尺寸下的视觉效果

### 🐛 Fixed

- 标准化 OpenAI 枚举值为小写以保持一致性
- 改进 API 配置的日志记录
- 优化命令管理器的错误处理
- 重组 commands.ts 代码结构

### 🌐 Localization

- 增强系统提示以支持多语言配置
- 添加中文文档支持
33 changes: 33 additions & 0 deletions CHANGELOG.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# 更新日志

本项目所有值得注意的更改都将记录在此文件中。

更新日志格式基于 [Keep a Changelog](https://keepachangelog.com/zh-CN/1.0.0/)

## [未发布]

### ⚡ 变更

- 将项目从 SVN AI Commit 重命名为 Dish AI Commit
- 重组 AI provider 和 SCM 集成
- 优化 AI provider 配置界面
- 改进模型选择和配置处理
- 增强错误处理和提示管理

### 🎨 样式

- 更新图标和 logo 为现代 AI 设计风格
- 采用蓝紫渐变背景和 AI 主题元素
- 优化各种尺寸下的视觉效果

### 🐛 修复

- 标准化 OpenAI 枚举值为小写以保持一致性
- 改进 API 配置的日志记录
- 优化命令管理器的错误处理
- 重组 commands.ts 代码结构

### 🌐 本地化

- 增强系统提示以支持多语言配置
- 添加中文文档支持
95 changes: 32 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,48 @@
# SVN AI Commit
# Dish AI Commit Gen

一个 VS Code 扩展,用于使用 AI 自动生成 SVN 提交信息。
A VSCode extension for generating standardized Git/SVN commit messages using AI. Supports OpenAI, Ollama, and VSCode built-in AI services.

## 功能特性
## Features

- 🤖 支持 OpenAI 和 Ollama 两种 AI 服务提供商
- 📝 自动分析 SVN 变更并生成相应的提交信息
- 🔍 支持选择特定文件生成提交信息
- 🔄 提供模型列表实时刷新功能
- ✅ 完整的配置验证和错误提示
### 🤖 Multi-Platform AI Support

## 命令列表
- OpenAI API support (GPT-3.5/GPT-4/Other)
- Ollama local model support
- VSCode built-in AI support

- `SVN AI Commit: Generate Commit Message` - 生成提交信息
- `SVN AI Commit: Show Available Models` - 显示可用的 AI 模型
- `SVN AI Commit: Refresh Models` - 刷新模型列表
### 📝 Version Control System Support

## 配置项
- SVN
- Git

在 VS Code 设置中配置以下参数 1:
### 🌍 Multi-language Commit Message Generation:

```json
{
"dish-ai-commit.OPENAI_API_KEY": "你的 OpenAI API 密钥",
"dish-ai-commit.OLLAMA_BASE_URL": "Ollama 服务地址",
"dish-ai-commit.provider": "选择默认 AI 提供商 (openai/ollama)",
"dish-ai-commit.language": "生成的提交信息语言"
}
```
- English
- Simplified Chinese
- Traditional Chinese
- Japanese
- Korean
and 19 other languages

## 📋 依赖要求
### 🎨 Conventional Commits Compliant

- VS Code
- SVN 命令行工具
- 有效的 AI 服务配置(OpenAI API Key 或 Ollama 服务)
### 😄 Automatic Emoji Addition

## 💡 常见问题
### Configuration

- 确保 SVN 命令行工具已正确安装并可访问
- 配置正确的 AI 服务参数
- 确保网络可以访问选择的 AI 服务
- `dish-ai-commit.PROVIDER`: AI provider selection (openai/ollama/vscode)
- `dish-ai-commit.MODEL`: AI model to use
- `dish-ai-commit.OPENAI_API_KEY`: OpenAI API key
- `dish-ai-commit.OPENAI_BASE_URL`: OpenAI API base URL
- `dish-ai-commit.OLLAMA_BASE_URL`: Ollama API URL
- `dish-ai-commit.AI_COMMIT_LANGUAGE`: Language for generated commit messages
- `dish-ai-commit.AI_COMMIT_SYSTEM_PROMPT`: Custom system prompt

## 🛠️ 开发指南
### Commands

1. 克隆仓库
2. 运行 `npm install` 安装依赖
3. 运行 `npm run compile` 编译代码
4.`F5` 启动调试
- `Generate Commit Message`: Generate commit message based on current changes
- `Select AI Model`: Choose the AI model to use

### 功能特性(补充)
## Configuration Guide

- [ ] **🔄 多语言支持**
支持生成提交信息的多语言版本,用户可以选择使用不同的语言(如中文、英文、法语等)生成提交信息。

- [ ] **🧠 深度分析和建议**
提供更智能的提交信息建议,不仅仅是基于 SVN 变更,还可以根据项目上下文提供改进意见(例如:建议更改某些功能名称,或者指出可能的代码风格改进)。

- [ ] **🔄 自动同步 AI 模型**
当新模型可用时,自动更新模型列表,无需用户手动刷新。

- [ ] **📈 统计与报告**
提供提交统计功能,如提交频率、类型分析、提交信息的质量评分等,帮助开发者更好地了解自己的提交习惯。

- [ ] **🎨 自定义提交模板**
允许用户自定义提交信息的模板格式(如:包括关联的 Jira 票号、功能描述等),AI 会根据模板生成符合要求的提交信息。

- [ ] **⚙️ 深度配置选项**
提供更多的配置项,比如是否启用 AI 生成的建议,生成提交信息的详细程度,是否自动修改现有提交信息等。

- [ ] **🧩 支持 Git-SVN 混合工作流**
对于需要同时使用 Git 和 SVN 的项目,提供混合工作流支持,让用户在 Git 和 SVN 之间无缝切换。

- [ ] **🔒 安全性功能**
加密存储 API 密钥,确保敏感信息不被泄露,并提供额外的身份验证机制来提高安全性。

## 📄 许可证

MIT License
1. OpenAI Configuration
145 changes: 145 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
# Dish AI Commit Gen

用AI辅助生成规范的Git/SVN提交信息的VSCode扩展。支持OpenAI、Ollama和VSCode内置AI服务。

## 功能特性

### 🤖 多平台 AI 支持

- OpenAI API 支持 (GPT-3.5/GPT-4/Other)
- Ollama 本地模型支持
- VSCode 内置 AI 支持

### 📝 版本控制系统支持

- SVN
- Git

### 🌍 支持多语言提交信息生成:

- 简体中文
- 繁體中文
- English
- 日本語
- 한국어
等19种语言

### 🎨 符合Conventional Commits规范

### 😄 自动添加emoji表情

### 配置项

- `dish-ai-commit.PROVIDER`: AI 提供商选择 (openai/ollama/vscode)
- `dish-ai-commit.MODEL`: 使用的 AI 模型
- `dish-ai-commit.OPENAI_API_KEY`: OpenAI API 密钥
- `dish-ai-commit.OPENAI_BASE_URL`: OpenAI API 基础地址
- `dish-ai-commit.OLLAMA_BASE_URL`: Ollama API 地址
- `dish-ai-commit.AI_COMMIT_LANGUAGE`: 生成提交信息的语言
- `dish-ai-commit.AI_COMMIT_SYSTEM_PROMPT`: 自定义系统提示词

### 命令

- `Generate Commit Message`: 根据当前更改生成提交信息
- `Select AI Model`: 选择要使用的 AI 模型

## 配置说明

1. OpenAI 配置

```json
{
"dish-ai-commit.PROVIDER": "openai",
"dish-ai-commit.OPENAI_API_KEY": "your-api-key",
"dish-ai-commit.OPENAI_BASE_URL": "https://api.openai.com/v1"
}
```

2. Ollama 配置

```json
{
"dish-ai-commit.PROVIDER": "ollama",
"dish-ai-commit.OLLAMA_BASE_URL": "http://localhost:11434"
}
```

3. VSCode 配置

```json
{
"dish-ai-commit.PROVIDER": "vscode"
}
```

## 📋 使用方法

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

## 📥 安装

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

## 📝 更新日志

查看 [CHANGELOG.md](CHANGELOG.md) 了解详细的版本更新历史。

## 🤝 贡献指南

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

- 提交 Issue 报告 bug
- 提出新功能建议
- 提交 Pull Request 改进代码
- 完善文档

请确保在提交 PR 之前:
1. 代码经过测试
2. 更新相关文档
3. 遵循项目代码规范

## 📋 依赖要求

- VS Code
- SVN 命令行工具
- 有效的 AI 服务配置(OpenAI API Key 或 Ollama 服务)

## 💡 常见问题

- 确保 SVN 命令行工具已正确安装并可访问
- 配置正确的 AI 服务参数
- 确保网络可以访问选择的 AI 服务

## 🛠️ 开发指南

1. 克隆仓库
2. 运行 `npm install` 安装依赖
3. 运行 `npm run compile` 编译代码
4.`F5` 启动调试

### 功能特性(补充)

- [ ] **🧠 深度分析和建议**
提供更智能的提交信息建议,不仅仅是基于 SVN 变更,还可以根据项目上下文提供改进意见(例如:建议更改某些功能名称,或者指出可能的代码风格改进)。

- [ ] **📈 统计与报告**
提供提交统计功能,如提交频率、类型分析、提交信息的质量评分等,帮助开发者更好地了解自己的提交习惯。

- [ ] **🎨 自定义提交模板**
允许用户自定义提交信息的模板格式(如:包括关联的 Jira 票号、功能描述等),AI 会根据模板生成符合要求的提交信息。

- [ ] **⚙️ 深度配置选项**
提供更多的配置项,比如是否启用 AI 生成的建议,生成提交信息的详细程度,是否自动修改现有提交信息等。

- [ ] **🔒 安全性功能**
加密存储 API 密钥,确保敏感信息不被泄露,并提供额外的身份验证机制来提高安全性。

## 📄 许可证

MIT License
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "dish-ai-commit",
"displayName": "Dish AI Commit Gen",
"description": "",
"version": "0.0.4",
"version": "0.0.6",
"engines": {
"vscode": "^1.95.0"
},
Expand Down

0 comments on commit 9f41dc1

Please sign in to comment.