@@ -40,13 +40,40 @@ A VSCode extension for generating standardized Git/SVN commit messages using AI.
40
40
41
41
### 🤖 Multi-Platform AI Support
42
42
43
- - OpenAI API support (GPT-3.5/GPT-4/Other)
44
- - Ollama local model support
45
- - VSCode built-in AI support
46
- - Zhipu AI support
47
- - DashScope support
48
- - Doubao AI support
49
- - Gemini AI support
43
+ - OpenAI API
44
+
45
+ - Suitable for scenarios requiring high-quality generation results
46
+ - Supports multiple models including GPT-3.5/GPT-4
47
+ - Requires API Key, charged based on usage
48
+
49
+ - Ollama
50
+
51
+ - Local deployment, no internet required
52
+ - Supports multiple open-source models
53
+ - Ideal for scenarios with data privacy requirements
54
+
55
+ - VSCode Built-in AI
56
+
57
+ - Uses VSCode's built-in GitHub Copilot
58
+ - Requires valid GitHub Copilot subscription
59
+ - Configuration: Set provider to "vscode"
60
+
61
+ - Zhipu AI (GLM-4)
62
+
63
+ - Excellent Chinese language performance
64
+ - Fixed monthly free quota
65
+ - Suitable for users in China
66
+
67
+ - DashScope
68
+
69
+ - AI service provided by Alibaba Cloud
70
+ - Supports Tongyi Qianwen series models
71
+ - Suitable for enterprise applications
72
+
73
+ - Gemini AI
74
+ - AI service provided by Google
75
+ - Daily free quota: 1500 requests
76
+ - Suitable for individual developers
50
77
51
78
### 📝 Version Control System Support
52
79
@@ -60,22 +87,118 @@ A VSCode extension for generating standardized Git/SVN commit messages using AI.
60
87
- Customizable report templates
61
88
- Support multiple AI providers for report generation
62
89
63
- ### 🌍 Multi-language Commit Message Generation:
64
-
65
- Supports 19 languages including:
66
-
67
- - Simplified Chinese
68
- - Traditional Chinese
90
+ ### 🌍 Multi-language Commit Message Generation
91
+
92
+ Supports the following 19 languages:
93
+
94
+ - Simplified Chinese (简体中文)
95
+ - Traditional Chinese (繁體中文)
96
+ - Japanese (日本語)
97
+ - Korean (한국어)
98
+ - Czech (Čeština)
99
+ - German (Deutsch)
100
+ - French (Français)
101
+ - Italian (Italiano)
102
+ - Dutch (Nederlands)
103
+ - Portuguese (Português)
104
+ - Vietnamese (Tiếng Việt)
69
105
- English
70
- - Japanese
71
- - Korean
72
- Others
106
+ - Spanish (Español)
107
+ - Swedish (Svenska)
108
+ - Russian (Русский)
109
+ - Bahasa Indonesia
110
+ - Polish (Polski)
111
+ - Turkish (Türkçe)
112
+ - Thai (ไทย)
73
113
74
114
### 🎨 Conventional Commits Compliant
75
115
116
+ Generates commit messages following the [ Conventional Commits] ( https://www.conventionalcommits.org/ ) specification:
117
+
118
+ - Commit Message Format:
119
+
120
+ ```
121
+ <type>[optional scope]: <description>
122
+
123
+ [optional body]
124
+
125
+ [optional footer(s)]
126
+ ```
127
+
128
+ - Supported Commit Types:
129
+
130
+ - ` feat ` : New feature
131
+ - ` fix ` : Bug fix
132
+ - ` docs ` : Documentation changes
133
+ - ` style ` : Code style adjustments
134
+ - ` refactor ` : Code refactoring
135
+ - ` perf ` : Performance improvements
136
+ - ` test ` : Test-related changes
137
+ - ` build ` : Build-related changes
138
+ - ` ci ` : CI/CD-related changes
139
+ - ` chore ` : Other changes
140
+ - ` revert ` : Revert commits
141
+
142
+ - Automatic Scope Detection:
143
+
144
+ - Automatically inferred from modified file paths
145
+ - Smart categorization for multi-file changes
146
+ - Customizable scope rules via configuration
147
+
148
+ - Breaking Changes Support:
149
+
150
+ - Mark breaking changes with ` ! `
151
+ - Detailed impact description in body
152
+ - Example: ` feat!: Restructure authentication system `
153
+
154
+ - Intelligent Description Generation:
155
+ - Automatic code change analysis
156
+ - Key modification point extraction
157
+ - Clear and concise description generation
158
+
76
159
### 😄 Automatic Emoji Addition
77
160
78
- ### 📊 Weekly Report Generation
161
+ - Automatically adds emojis to commit messages
162
+ - Can be enabled/disabled through configuration:
163
+
164
+ ``` json
165
+ {
166
+ "dish-ai-commit.features.commitFormat.enableEmoji" : true // Enable emoji
167
+ }
168
+ ```
169
+
170
+ - Emojis automatically match commit types:
171
+ - ✨ feat: New features
172
+ - 🐛 fix: Bug fixes
173
+ - 📝 docs: Documentation
174
+ - 💄 style: Styling
175
+ - ♻️ refactor: Refactoring
176
+ - ⚡️ perf: Performance
177
+ - ✅ test: Testing
178
+ - 🔧 chore: Other changes
179
+
180
+ ### 📊 Code Analysis Features
181
+
182
+ - Intelligent code difference analysis
183
+ - Automatically simplify complex code changes
184
+ - Preserve key context information
185
+ - Customizable analysis behavior via maxLineLength and contextLines
186
+
187
+ ### 🔄 Merge Commit Support
188
+
189
+ By enabling the enableMergeCommit option, you can:
190
+
191
+ - Merge changes from multiple related files into a single commit message
192
+ - Automatically analyze file associations
193
+ - Generate more concise commit records
194
+
195
+ ### 📝 Weekly Report Templates
196
+
197
+ Weekly report generation supports custom templates:
198
+
199
+ - Customize prompts via systemPrompt configuration
200
+ - Summarize by project/task
201
+ - Customize report format and key content
79
202
80
203
## 📋 Requirements
81
204
@@ -108,37 +231,37 @@ Supports 19 languages including:
108
231
109
232
### Commands
110
233
111
- | Command ID | Category | Title | Description |
112
- | ------------| ----------| --------| -------------|
113
- | dish-ai-commit.selectModel | [ Dish AI Commit] | Select AI Model for Commit Generation | Choose the AI model for generating commit messages |
114
- | dish-ai-commit.generateWeeklyReport | [ Dish AI Commit] | Generate Weekly Report | Generate AI-powered weekly work report |
234
+ | Command ID | Category | Title | Description |
235
+ | ----------------------------------- | ---------------- | ------------------------------------- | -------------------------------------------------- |
236
+ | dish-ai-commit.selectModel | [ Dish AI Commit] | Select AI Model for Commit Generation | Choose the AI model for generating commit messages |
237
+ | dish-ai-commit.generateWeeklyReport | [ Dish AI Commit] | Generate Weekly Report | Generate AI-powered weekly work report |
115
238
116
239
## Configuration Instructions
117
240
118
241
1 . OpenAI Configuration
119
242
120
243
``` json
121
244
{
122
- "dish-ai-commit.PROVIDER " : " openai" ,
123
- "dish-ai-commit.OPENAI_API_KEY " : " your-api-key" ,
124
- "dish-ai-commit.OPENAI_BASE_URL " : " https://api.openai.com/v1"
245
+ "dish-ai-commit.base.provider " : " openai" ,
246
+ "dish-ai-commit.providers.openai.apiKey " : " your-api-key" ,
247
+ "dish-ai-commit.providers.openai.baseUrl " : " https://api.openai.com/v1"
125
248
}
126
249
```
127
250
128
- 2 . Ollama onfiguration
251
+ 2 . Ollama Configuration
129
252
130
253
``` json
131
254
{
132
- "dish-ai-commit.PROVIDER " : " ollama" ,
133
- "dish-ai-commit.OLLAMA_BASE_URL " : " http://localhost:11434"
255
+ "dish-ai-commit.base.provider " : " ollama" ,
256
+ "dish-ai-commit.providers.ollama.baseUrl " : " http://localhost:11434"
134
257
}
135
258
```
136
259
137
- 3 . VSCode onfiguration
260
+ 3 . VSCode Configuration
138
261
139
262
``` json
140
263
{
141
- "dish-ai-commit.PROVIDER " : " vscode"
264
+ "dish-ai-commit.base.provider " : " vscode"
142
265
}
143
266
```
144
267
@@ -250,4 +373,3 @@ This project is [MIT](./LICENSE) licensed.
250
373
[ total-installs-shield ] : https://img.shields.io/vscode-marketplace/d/littleCareless.dish-ai-commit.svg?&color=greeen&labelColor=black&style=flat-square
251
374
[ avarage-rating-link ] : https://marketplace.visualstudio.com/items?itemName=littleCareless.dish-ai-commit
252
375
[ avarage-rating-shield ] : https://img.shields.io/vscode-marketplace/r/littleCareless.dish-ai-commit.svg?&color=green&labelColor=black&style=flat-square
253
- ````
0 commit comments