GitFlow Pro

A powerful VS Code extension that automates Git operations with AI-powered commit messages and subscription management via MPESA STK push.

Features

🚀 Core Functionality

• Automated Git Workflow: Streamlined commit and push operations with a single keyboard shortcut
• AI-Powered Commit Messages: Generate conventional commit messages using OpenAI or Google Gemini
• Subscription Management: Secure MPESA STK push payment integration
• Smart Repository Detection: Automatically detects and sets up Git repositories
• Branch Management: Easy branch selection and switching

💡 Smart Features

• Change Detection: Automatically detects staged and unstaged changes
• Error Handling: Graceful handling of Git conflicts, authentication issues, and API errors
• Progress Tracking: Real-time progress indicators for all operations
• Secure Storage: Uses VS Code's SecretStorage API for sensitive data

🎯 User Experience

• Native VS Code UI: Seamless integration with VS Code's interface
• Keyboard Shortcut: Quick activation with Alt + C + P
• Wizard-Style Workflows: Step-by-step guidance for complex operations
• Configurable Settings: Customizable AI provider and phone number preferences

Installation

From VS Code Marketplace

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "GitFlow Pro"
4. Click Install

From Source

1. Clone this repository
2. Install dependencies: npm install
3. Compile TypeScript: npm run compile
4. Package extension: npm run package
5. Install the generated .vsix file

Usage

Quick Start

1. Open a workspace folder in VS Code
2. Press Alt + C + P to activate GitFlow Pro
3. Follow the on-screen instructions

Workflow Steps

1. Subscription Check

• GitFlow Pro verifies your subscription status
• If no active subscription, prompts for MPESA payment
• Securely stores subscription data using VS Code's SecretStorage

2. Repository Setup

• Detects if current workspace is a Git repository
• If not, prompts for repository URL and initializes Git
• Automatically adds remote origin

3. Branch Selection

• Lists all available branches (local and remote)
• Allows user to select target branch
• Remembers last used branch for convenience

4. Change Detection

• Runs git status to check for changes
• Shows summary of modified, added, and deleted files
• Exits gracefully if no changes found

5. Commit Message

• Option to enter commit message manually
• AI-powered generation with OpenAI or Gemini
• Conventional commit format validation
• Preview and edit before committing

6. Commit and Push

• Stages all changes with git add .
• Creates commit with generated message
• Pushes to selected branch
• Handles conflicts and authentication errors

Configuration

Settings

Open VS Code settings and search for "GitFlow Pro":

• gitflowpro.defaultAIProvider: Default AI provider (openai or gemini)
• gitflowpro.mpesaPhoneNumber: Default MPESA phone number
• gitflowpro.openaiApiKey: OpenAI API key (stored securely)
• gitflowpro.geminiApiKey: Gemini API key (stored securely)

API Keys

GitFlow Pro supports two AI providers for commit message generation:

OpenAI

• Requires OpenAI API key
• Uses GPT-3.5-turbo model
• Follows conventional commit format
• Cost-effective for frequent use

Google Gemini

• Requires Google AI API key
• Uses Gemini Pro model
• Fast response times
• Good for rapid development

Subscription

Pricing

• Monthly Subscription: KES 100/month
• Payment Method: MPESA STK Push
• Auto-Renewal: Manual renewal required

Subscription Process

1. Enter MPESA phone number (format: 254XXXXXXXXX)
2. Receive STK push on your phone
3. Enter MPESA PIN to complete payment
4. Subscription activated immediately
5. Valid for 30 days from activation

Subscription Management

• Check subscription status anytime
• View expiry date
• Cancel subscription (stops auto-renewal)
• Reactivate expired subscriptions

Development

Prerequisites

• Node.js 18+
• VS Code 1.85+
• Git

Setup

# Clone repository
git clone https://github.com/gitflow-pro/gitflow-pro-extension.git
cd gitflow-pro-extension

# Install dependencies
npm install

# Compile TypeScript
npm run compile

# Run tests
npm test

# Start development mode
npm run watch

Project Structure

gitflow-pro/
├── src/
│   ├── extension.ts          # Main extension entry point
│   ├── gitHandler.ts         # Git operations
│   ├── subscription.ts       # MPESA subscription handling
│   ├── aiCommit.ts          # AI commit message generation
│   ├── ui.ts                 # VS Code UI helpers
│   └── utils.ts              # Utility functions
├── src/test/                 # Test files
├── .vscode/                  # VS Code configuration
├── assets/                   # Extension assets
├── package.json             # Extension manifest
├── tsconfig.json            # TypeScript configuration
└── README.md                # This file

Testing

# Run unit tests
npm test

# Run with coverage
npm run test:coverage

# Run integration tests
npm run test:integration

Building

# Compile for development
npm run compile

# Package for marketplace
npm run package

# Publish to marketplace
npm run publish

Troubleshooting

Common Issues

"No workspace folder found"

• Ensure you have a folder open in VS Code
• GitFlow Pro requires a workspace to operate

"Git repository not detected"

• Initialize Git repository: git init
• Or provide repository URL when prompted

"MPESA payment failed"

• Verify phone number format (254XXXXXXXXX)
• Check network connectivity
• Ensure sufficient MPESA balance

"AI API error"

• Verify API key is correct
• Check API quota and billing
• Ensure network connectivity

"Git push failed"

• Check Git credentials: git config --list
• Verify repository permissions
• Resolve any merge conflicts

Debug Mode

Enable debug logging in VS Code:

1. Open Command Palette (Ctrl+Shift+P)
2. Type "Developer: Toggle Developer Tools"
3. Check console for GitFlow Pro logs

Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Email: support@gitflowpro.com

Security

Data Protection

• API keys stored using VS Code SecretStorage
• Subscription data encrypted at rest
• No data shared with third parties
• Local processing only

Privacy

• No telemetry or analytics
• No personal data collection
• Git changes processed locally
• AI API calls made directly to providers

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Workflow

1. Fork the repository
2. Create feature branch
3. Make changes with tests
4. Ensure all tests pass
5. Submit pull request

Code Style

• TypeScript with strict mode
• ESLint for linting
• Prettier for formatting
• Conventional commits for changes

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

See CHANGELOG.md for version history and updates.

Acknowledgments

• VS Code Extension API
• simple-git library
• OpenAI and Google Gemini APIs
• MPESA payment integration

GitFlow Pro - Streamline your Git workflow with AI-powered automation. 🚀