English | 简体中文

A VSCode extension for generating standardized Git/SVN commit messages using AI. Supports OpenAI, Ollama, VSCode built-in AI services, Zhipu AI, DashScope, Gemini AI, and Doubao AI.

🆓 Free AI Model Support

• Zhipu AI (GLM-4-Flash)

  • Free Quota: Fixed monthly free quota per account (Rate limiting guidelines)
  • Get Zhipu API Key here

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

  • Free Quota: 10 RPM 1500 req/day
  • Get Gemini API Key here

Features

🤖 Multi-Platform AI Support

• OpenAI API

  • Suitable for scenarios requiring high-quality generation results
  • Supports multiple models including GPT-3.5/GPT-4
  • Requires API Key, charged based on usage

• Ollama

  • Local deployment, no internet required
  • Supports multiple open-source models
  • Ideal for scenarios with data privacy requirements

• VSCode Built-in AI

  • Uses VSCode's built-in GitHub Copilot
  • Requires valid GitHub Copilot subscription
  • Configuration: Set provider to "vscode"

• Zhipu AI (GLM-4)

  • Excellent Chinese language performance
  • Fixed monthly free quota
  • Suitable for users in China

• DashScope

  • AI service provided by Alibaba Cloud
  • Supports Tongyi Qianwen series models
  • Suitable for enterprise applications

• Gemini AI

  • AI service provided by Google
  • Daily free quota: 1500 requests
  • Suitable for individual developers

📝 Version Control System Support

• SVN
• Git

📊 Weekly Report Generation

• AI-powered weekly report generation
• Automatically summarize your work progress
• Customizable report templates
• Support multiple AI providers for report generation

🌍 Multi-language Commit Message Generation

Supports the following 19 languages:

• Simplified Chinese (简体中文)
• Traditional Chinese (繁體中文)
• Japanese (日本語)
• Korean (한국어)
• Czech (Čeština)
• German (Deutsch)
• French (Français)
• Italian (Italiano)
• Dutch (Nederlands)
• Portuguese (Português)
• Vietnamese (Tiếng Việt)
• English
• Spanish (Español)
• Swedish (Svenska)
• Russian (Русский)
• Bahasa Indonesia
• Polish (Polski)
• Turkish (Türkçe)
• Thai (ไทย)

🎨 Conventional Commits Compliant

Generates commit messages following the Conventional Commits specification:

• Commit Message Format:

  <type>[optional scope]: <description>
  
  [optional body]
  
  [optional footer(s)]
  

• Supported Commit Types:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code style adjustments
  • refactor: Code refactoring
  • perf: Performance improvements
  • test: Test-related changes
  • build: Build-related changes
  • ci: CI/CD-related changes
  • chore: Other changes
  • revert: Revert commits

• Automatic Scope Detection:

  • Automatically inferred from modified file paths
  • Smart categorization for multi-file changes
  • Customizable scope rules via configuration

• Breaking Changes Support:

  • Mark breaking changes with !
  • Detailed impact description in body
  • Example: feat!: Restructure authentication system

• Intelligent Description Generation:

  • Automatic code change analysis
  • Key modification point extraction
  • Clear and concise description generation

😄 Automatic Emoji Addition

• Automatically adds emojis to commit messages
• Can be enabled/disabled through configuration:

{
  "dish-ai-commit.features.commitFormat.enableEmoji": true // Enable emoji
}

• Emojis automatically match commit types:
  • ✨ feat: New features
  • 🐛 fix: Bug fixes
  • 📝 docs: Documentation
  • 💄 style: Styling
  • ♻️ refactor: Refactoring
  • ⚡️ perf: Performance
  • ✅ test: Testing
  • 🔧 chore: Other changes

📊 Code Analysis Features

• Intelligent code difference analysis
• Automatically simplify complex code changes
• Preserve key context information
• Customizable analysis behavior via maxLineLength and contextLines

🔄 Merge Commit Support

By enabling the enableMergeCommit option, you can:

• Merge changes from multiple related files into a single commit message
• Automatically analyze file associations
• Generate more concise commit records

📝 Weekly Report Templates

Weekly report generation supports custom templates:

• Customize prompts via systemPrompt configuration
• Summarize by project/task
• Customize report format and key content

📋 Requirements

• VS Code 1.80.0+
• SVN Command Line Tool
• SVN SCM (Optional) - Install SVN SCM v2.18.1+ if you need to enter commit messages in VSCode's SCM input box
  • Download the latest version of the SVN SCM extension from the release page
• Git SCM (Optional) - Install Git SCM if you need to enter commit messages in VSCode's SCM input box
• Valid AI service configuration (OpenAI API Key or Ollama service)

Configuration

Commands

Configuration Instructions

1. OpenAI Configuration

{
  "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 Configuration

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

3. VSCode Configuration

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

📋 How to use

• Select the file to be submitted from the source code manager
• Click the "Dish AI Commit" icon in the source code manager title bar
• Or execute the "Dish AI Commit" command in the command panel
• AI will automatically generate a submission message that meets the specifications

📥 Install

1. Search "Dish AI Commit" from the VS Code extension market
2. Click to install
3. Restart VS Code
4. Configure AI service parameters according to actual needs

📝 Changelog

See CHANGELOG.md for a detailed version history.

📋 Dependency Requirements

• VS Code 1.80.0+
• SVN command line tool
• SVN SCM (optional) - To enter commit information in the SCM input box of VSCode, please install SVN SCM v2.18.1+
• Valid AI service configuration (OpenAI API Key or Ollama service)

💡 Frequently asked questions

• Ensure that the SVN command line tool is correctly installed and accessible
• Ensure that the SVN SCM extension is correctly installed and enabled
• Configure the correct AI service parameters
• Ensure that the network can access the selected AI service

🛠️ Development Guide

You can use Github Codespaces for online development:

Alternatively, you can clone the repository and run the following command for local development:

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

Open the project folder in VSCode. Press F5 to run the project. A new Extension Development Host window will pop up and start the extension.

🤝 Contribution Guidelines

We welcome all forms of contributions, including but not limited to:

• Submit Issues to report bugs
• Propose new features
• Submit Pull Request to improve the code
• Improve the documentation

Please make sure before submitting a PR:

1. The code has been tested

2. Update the relevant documents

3. Follow the project code specifications

💗 Thanks to our contributors

🙏 Acknowledgments

This project is inspired by and references these excellent open source projects:

• svn-scm - SVN source control management for VSCode
• vscode - Visual Studio Code editor
• vscode-gitlens - Git supercharged for VSCode
• ai-commit - AI assisted Git commit message generation

📄 License

This project is MIT licensed.