English | 简体中文

Deutsch | Español | Français | 日本語 | 한국어 | Português | Русский | 中文

💡 Why Dish AI Commit Gen?

Unlike other AI commit tools, we provide the most comprehensive AI provider support (20+ providers), pioneering semantic code analysis (Tree-sitter + Qdrant), and multi-dimensional intelligent generation (commits, branches, PR summaries, weekly reports). Built with enterprise-grade architecture following SOLID principles for maximum maintainability and extensibility.

🚀 Core Features Overview

🤖 AI-Powered Generation

• Commit Message Generation: Intelligent commit messages from code changes with context-aware analysis
• Branch Name Generation: Smart branch naming based on requirements or code changes
• PR Summary Generation: Auto-generate PR titles and descriptions from commit history
• Weekly Report Generation: AI-powered work summaries and progress tracking
• Code Review: AI-assisted code review with detailed feedback

🏗️ Advanced Architecture

• Modular Design: SOLID principles, core classes < 200 lines
• Multi-layer Architecture: Command → Handler → Builder → Service → Utils
• Graceful Degradation: Multi-level fallback for Git and SVN
• Unified AI Interface: 20+ providers with consistent API

🧠 Intelligent Analysis

• Semantic Indexing: Tree-sitter + Qdrant vector database
• Context Collection: Automatic code change analysis and context building
• Framework Detection: Framework-specific commit suggestions
• Smart Caching: LRU cache for performance optimization

🎨 Modern UI

• Interactive Chat: Real-time commit generation through natural language
• Dynamic Settings: Schema-driven auto-generated configuration UI
• Multi-language Support: 18 languages including English and Chinese
• System Notifications: Cross-platform native notifications

✨ What's New (v0.56.1)

🔥 Latest Features

• Xiaomi MiMo Support: Added Xiaomi's MiMo as a new AI service provider
• Enhanced Settings Migration: Improved robustness and traceability for settings migration
• Framework-Specific Suggestions: Intelligent commit suggestions based on project type
• Commit Caching: LRU cache mechanism to improve performance
• New User Onboarding: Enhanced guidance and configuration file robustness
• Performance Optimizations: Optimized commit generation and logging

📊 Recent Major Features

• Cross-Repository Support: Handle multiple repositories in single workspace
• Function Calling Mode: Structured commit messages via AI function calling
• Dynamic Settings UI: Auto-generated configuration interface
• System Notifications: Native notifications (macOS, Windows, Linux)
• Layered Commits: Multi-file commit with detailed descriptions

🤖 Comprehensive AI Provider Support

Provider Categories

🆓 Free AI Models

• Zhipu AI (GLM-4-Flash): Fixed monthly free quota (Get API Key)
• Gemini AI: 1,500 free requests per day (Get API Key)
• Ollama: Completely free local deployment with 100+ models
• LM Studio: Free local model hosting and management
• Xiaomi MiMo: Competitive pricing with excellent Chinese support

📝 Version Control System Support

Git Support

• VS Code Git API: Full integration with VS Code's Git extension
• CLI Fallback: Command-line Git operations when API unavailable
• Multi-repository: Handle multiple Git repositories in workspace
• Smart Detection: Automatic repository detection and switching

SVN Support

• SVN SCM Extension: Integration with VS Code SVN extension
• CLI Implementation: Direct SVN command-line operations
• Graceful Degradation: 3-level fallback (API → CLI → Simple CLI)
• Unified Interface: Same API as Git for seamless switching

🏗️ Architecture Highlights

Modular Design (SOLID Principles)

┌─────────────────────────────────────────┐
│           Command Layer                 │
│  GenerateCommitCommand (222 lines)      │
│  GenerateBranchNameCommand (146 lines)  │
└─────────────────┬───────────────────────┘
                  │
┌─────────────────▼───────────────────────┐
│         Handler Layer                   │
│  • StreamingHandler                     │
│  • FunctionCallingHandler              │
│  • LayeredCommitHandler                │
│  • CrossRepositoryHandler              │
└─────────────────┬───────────────────────┘
                  │
┌─────────────────▼───────────────────────┐
│         Builder Layer                   │
│  • CommitContextBuilder                │
│  • CommitMessageBuilder                │
└─────────────────┬───────────────────────┘
                  │
┌─────────────────▼───────────────────────┐
│         Service Layer                   │
│  • CommitCacheService                  │
│  • NotificationService                 │
│  • SettingsMigration                   │
└─────────────────┬───────────────────────┘
                  │
┌─────────────────▼───────────────────────┐
│         Utils Layer                     │
│  • StreamingGenerationHelper           │
│  • ContextCollector                    │
│  • CommitFormatter                     │
└─────────────────────────────────────────┘

Performance Optimizations

• Smart Caching: LRU cache with MD5-based keys (50 items max)
• Incremental Indexing: Only updates changed files
• Context Management: Intelligent prompt length optimization
• Request Retries: Automatic retry with exponential backoff

⚙️ Configuration

Core Settings

Available Commands

📋 Configuration Examples

1. OpenAI Configuration

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

2. Xiaomi MiMo Configuration

{
  "dish-ai-commit.base.provider": "mimo",
  "dish-ai-commit.providers.mimo.apiKey": "your-mimo-key"
}

3. Ollama Local Configuration

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

4. GitHub Copilot Configuration

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

🚀 Quick Start

Installation

1. Search "Dish AI Commit" in VS Code Extension Marketplace
2. Click Install
3. Restart VS Code
4. Configure your preferred AI provider

Basic Usage

Generate Commit Message

1. Open Source Control view (Git or SVN)
2. Select files to commit
3. Click "Dish AI Commit" icon in SCM title bar
4. Or use Command Palette: Dish AI Commit: Generate Commit Message
5. AI generates commit message automatically

Generate Branch Name

1. Use Command Palette: Dish AI Commit: Generate Branch Name
2. Choose mode:
   • From Description: Enter feature description
   • From Changes: Use current code changes
3. Select from suggested branch names
4. Branch is created automatically

Interactive Chat

1. Open Command Palette: Dish AI Commit: Open Chat Interface
2. Type your requirements in natural language
3. Use commands: /help, /template, /style, /language
4. Get real-time commit suggestions

📚 Documentation

Core Modules

• Project Structure - Complete architecture overview
• AI Model Registry - Model management system
• Generate Commit - Commit generation architecture
• Generate Branch Name - Branch generation architecture
• SVN SCM - SVN support with graceful degradation
• WebView UI - Modern React-based interface
• Commit Chat - Interactive chat features

Architecture Deep Dive

• Modular Design: All core commands follow SOLID principles
• Graceful Degradation: Multi-level fallback mechanisms
• Performance: LRU caching, incremental indexing, smart context management
• Security: Secret storage, input validation, error handling

🛠️ Development

Prerequisites

• Node.js 18.20.8+
• pnpm 10.0.0+
• VS Code 1.80.0+

Setup

# Clone repository
git clone https://github.com/littleCareless/dish-ai-commit
cd dish-ai-commit

# Install dependencies
pnpm install

# Start development
pnpm dev

# Build extension
pnpm build

# Package extension
pnpm package

Project Structure

src/
├── ai/                    # AI providers and model registry
├── commands/              # Feature commands (commit, branch, etc.)
├── scm/                   # Git/SVN integration
├── services/              # Business services (cache, notification)
├── config/                # Configuration schema
├── core/                  # Core extension logic
├── utils/                 # Utility functions
├── i18n/                  # Internationalization
├── prompt/                # AI prompt templates
└── extension.ts           # Extension entry point

webview-ui/
├── src/                   # React frontend
│   ├── components/        # UI components
│   ├── services/          # Webview services
│   └── hooks/             # React hooks
└── package.json           # Frontend dependencies

Code Quality Standards

• ✅ Single file < 500 lines (core classes < 200 lines)
• ✅ Clear separation of concerns
• ✅ Comprehensive TypeScript types
• ✅ Unit tests for critical paths
• ✅ Documentation for public APIs

💬 Community & Feedback

Get Help & Share Ideas

• 🐛 Report a Bug - Found an issue? Let us know!
• ✨ Request a Feature - Have an idea? We'd love to hear it!
• 📝 Share Feedback - Tell us what you think about the extension
• 💬 Join Discussions - Share ideas, ask questions, or chat with the community

Community Guidelines

• Be respectful and constructive
• Provide detailed information (version, OS, config)
• Include screenshots when applicable
• Search existing issues before creating new ones

Stay Updated

• ⭐ Star the repo to get notified of new releases
• 👀 Watch for issue and PR updates
• 📧 Follow for important announcements

🤝 Contributing

We welcome all contributions!

How to Contribute

1. Fork the repository
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Commit your changes: git commit -m 'feat: add amazing feature'
4. Push to the branch: git push origin feature/amazing-feature
5. Open a Pull Request

Contribution Guidelines

• Follow existing code style and patterns
• Add tests for new functionality
• Update documentation
• Ensure all checks pass
• Reference related issues

Development Workflow

# Install dependencies
pnpm install

# Start development mode
pnpm dev

# Run tests
pnpm test

# Check types
pnpm check-types

# Lint code
pnpm lint

# Format code
pnpm format

📊 Project Statistics

Code Metrics

• Total Files: 100+ TypeScript files
• Core Commands: 2 main commands (refactored to < 400 lines total)
• AI Providers: 20+ supported
• Languages: 18 supported languages
• Test Coverage: Comprehensive unit tests

Refactoring Achievements

• GenerateCommit: 636 lines → 222 lines (65% reduction)
• GenerateBranchName: 674 lines → 146 lines (78% reduction)
• Architecture: Monolithic → Modular (SOLID principles)

🙏 Acknowledgments

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

• svn-scm - SVN source control management
• vscode - VS Code editor and API
• vscode-gitlens - Git supercharged
• ai-commit - AI commit generation
• vscode-copilot-chat - AI chat features

📄 License

This project is MIT licensed.

Version: v0.56.1 Last Updated: December 2024 Architecture: SOLID Principles Status: ✅ Production Ready