Skip to content

Commit

Permalink
📝 docs(config): 更新配置项结构和描述
Browse files Browse the repository at this point in the history 
- 重组配置项为更有层次的分类结构（base/providers/features）
- 统一配置项的默认值和描述格式
- 添加新的配置选项：enableEmoji 和周报相关配置
- 修改仓库名称引用从 dish-ai-commit 到 ai-commit
- 优化中英文文档的配置表格格式和对齐方式
  • Loading branch information
@littleCareless
littleCareless committed Dec 19, 2024
1 parent 9d8ed6d commit 0eacdaf
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 35 deletions.
38 changes: 20 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,23 +86,25 @@ Supports 19 languages including:

### Configuration

| Configuration | Type | Default | Description |
| ----------------------------------------------- | ------- | ------------------------- | --------------------------------------------------- |
| dish-ai-commit.commitLanguage | string | Simplified Chinese | Commit message language |
| dish-ai-commit.systemPrompt | string | "" | Custom system prompt for generating commit messages |
| dish-ai-commit.provider | string | OpenAI | Default AI provider |
| dish-ai-commit.model | string | gpt-3.5-turbo | AI model selection |
| dish-ai-commit.openai.apiKey | string | - | OpenAI API key |
| dish-ai-commit.openai.baseUrl | string | https://api.openai.com/v1 | OpenAI API base URL |
| dish-ai-commit.zhipuai.apiKey | string | - | Zhipu AI API key |
| dish-ai-commit.dashscope.apiKey | string | - | DashScope API key |
| dish-ai-commit.doubao.apiKey | string | - | Doubao API key |
| dish-ai-commit.gemini.apiKey | string | - | Gemini API key |
| dish-ai-commit.ollama.baseUrl | string | http://localhost:11434 | Ollama API base URL |
| dish-ai-commit.enableDiffSimplification | boolean | false | Enable diff content simplification |
| dish-ai-commit.diffSimplification.maxLineLength | number | 120 | Maximum line length after simplification |
| dish-ai-commit.diffSimplification.contextLines | number | 3 | Number of context lines to preserve |
| dish-ai-commit.allowMergeCommits | boolean | false | Allow merging multiple file changes into one commit |
| Configuration | Type | Default | Description |
| ------------------------------------------------------ | ------- | ------------------------- | --------------------------------------------------- |
| dish-ai-commit.base.language | string | Simplified Chinese | Commit message language |
| dish-ai-commit.base.systemPrompt | string | "" | Custom system prompt |
| dish-ai-commit.base.provider | string | OpenAI | AI provider |
| dish-ai-commit.base.model | string | gpt-3.5-turbo | AI model |
| dish-ai-commit.providers.openai.apiKey | string | "" | OpenAI API key |
| dish-ai-commit.providers.openai.baseUrl | string | https://api.openai.com/v1 | OpenAI API base URL |
| dish-ai-commit.providers.zhipu.apiKey | string | "" | Zhipu AI API key |
| dish-ai-commit.providers.dashscope.apiKey | string | "" | DashScope API key |
| dish-ai-commit.providers.doubao.apiKey | string | "" | Doubao API key |
| dish-ai-commit.providers.ollama.baseUrl | string | http://localhost:11434 | Ollama API base URL |
| dish-ai-commit.providers.gemini.apiKey | string | "" | Gemini AI API key |
| dish-ai-commit.features.codeAnalysis.simplifyDiff | boolean | false | Enable diff content simplification |
| dish-ai-commit.features.codeAnalysis.maxLineLength | number | 120 | Maximum line length after simplification |
| dish-ai-commit.features.codeAnalysis.contextLines | number | 3 | Number of context lines to preserve |
| dish-ai-commit.features.commitFormat.enableMergeCommit | boolean | false | Allow merging multiple file changes into one commit |
| dish-ai-commit.features.commitFormat.enableEmoji | boolean | true | Use emoji in commit messages |
| dish-ai-commit.features.weeklyReport.systemPrompt | string | "" | Custom system prompt for weekly reports |

### Commands

Expand Down Expand Up @@ -217,7 +219,7 @@ This project is inspired by and references these excellent open source projects:
- [svn-scm](https://github.com/JohnstonCode/svn-scm) - SVN source control management for VSCode
- [vscode](https://github.com/microsoft/vscode) - Visual Studio Code editor
- [vscode-gitlens](https://github.com/gitkraken/vscode-gitlens) - Git supercharged for VSCode
- [dish-ai-commit](https://github.com/Sitoi/dish-ai-commit) - AI assisted Git commit message generation
- [ai-commit](https://github.com/Sitoi/ai-commit) - AI assisted Git commit message generation

## 📄 License

Expand Down
36 changes: 19 additions & 17 deletions README.zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,23 +74,25 @@

### 配置项

| 配置项 | 类型 | 默认值 | 说明 |
| ----------------------------------------------- | ------- | ------------------------- | ------------------------------------------ |
| dish-ai-commit.commitLanguage | string | Simplified Chinese | 提交信息语言 |
| dish-ai-commit.systemPrompt | string | "" | 自定义生成提交信息的系统提示 |
| dish-ai-commit.provider | string | OpenAI | 默认的 AI 提供商 |
| dish-ai-commit.model | string | gpt-3.5-turbo | AI 模型选择 |
| dish-ai-commit.openai.apiKey | string | - | OpenAI API 密钥 |
| dish-ai-commit.openai.baseUrl | string | https://api.openai.com/v1 | OpenAI API 基础 URL |
| dish-ai-commit.zhipuai.apiKey | string | - | 智谱 AI API 密钥 |
| dish-ai-commit.dashscope.apiKey | string | - | DashScope API 密钥 |
| dish-ai-commit.doubao.apiKey | string | - | 豆包 API 密钥 |
| dish-ai-commit.ollama.baseUrl | string | http://localhost:11434 | Ollama API 基础 URL |
| dish-ai-commit.gemini.apiKey | string | - | Gemini AI API 密钥 |
| dish-ai-commit.enableDiffSimplification | boolean | false | 启用 diff 内容简化功能 |
| dish-ai-commit.diffSimplification.maxLineLength | number | 120 | 简化后每行的最大长度 |
| dish-ai-commit.diffSimplification.contextLines | number | 3 | 保留上下文行数 |
| dish-ai-commit.allowMergeCommits | boolean | false | 是否允许将多个文件的变更合并为一条提交信息 |
| 配置项 | 类型 | 默认值 | 说明 |
|---------------------------------------------------|----------|---------------------------|--------------------------------------------------------------|
| dish-ai-commit.base.language | string | Simplified Chinese | 提交信息语言 |
| 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 密钥 |
| dish-ai-commit.providers.openai.baseUrl | string | https://api.openai.com/v1 | OpenAI API 基础 URL |
| dish-ai-commit.providers.zhipu.apiKey | string | "" | 智谱 AI API 密钥 |
| dish-ai-commit.providers.dashscope.apiKey | string | "" | DashScope API 密钥 |
| dish-ai-commit.providers.doubao.apiKey | string | "" | 豆包 API 密钥 |
| dish-ai-commit.providers.ollama.baseUrl | string | http://localhost:11434 | Ollama API 基础 URL |
| dish-ai-commit.providers.gemini.apiKey | string | "" | Gemini AI API 密钥 |
| dish-ai-commit.features.codeAnalysis.simplifyDiff | boolean | false | 启用 diff 内容简化功能 |
| 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 | 在提交信息中使用 emoji |
| dish-ai-commit.features.weeklyReport.systemPrompt | string | "" | 周报生成的自定义系统提示 |

### 命令

Expand Down

0 comments on commit 0eacdaf

Please sign in to comment.