orcommit 1.0.0 → 1.0.2

package/README.md

@@ -1,4 +1,4 @@
-# OpenRouter Commit
+# ORCommit Git Manager
 
 > AI-powered Git commit message generator with efficient chunk processing for large files
 
@@ -6,19 +6,21 @@
 [![TypeScript](https://badges.frapsoft.com/typescript/code/typescript.svg?v=101)](https://github.com/ellerbrock/typescript-badges/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-A sophisticated CLI tool that generates meaningful, contextual commit messages using OpenRouter and OpenAI APIs. Designed with a modular TypeScript architecture and optimized for handling large codebases through intelligent diff chunking.
+A sophisticated CLI tool that generates meaningful, contextual commit messages using ORCommit and OpenAI APIs. Designed with a modular TypeScript architecture and optimized for handling large codebases through intelligent diff chunking.
 
 ## ✨ Features
 
-- 🤖 **AI-Powered**: Generate commit messages using OpenRouter and OpenAI models
-- 📦 **Chunked Processing**: Efficiently handle large diffs by breaking them into manageable pieces
-- 🔧 **Configurable**: Support for multiple providers, models, and preferences
+- 🤖 **AI-Powered**: Generate commit messages using ORCommit and OpenAI models
+- 📦 **Token-Aware Chunking**: Intelligently split large diffs based on actual token limits
+- 🚀 **Smart Push Integration**: Interactive push prompts with automatic upstream setup
+- 🎨 **Elegant UI**: Structured progress with phase indicators and timing
+- ⚡ **Lightning Fast**: Intelligent caching with memory and disk persistence
+- 🔧 **Highly Configurable**: Extensive CLI options and provider settings
 - 🔒 **Secure**: Safe storage of API keys with proper file permissions (600)
-- 🎯 **Conventional Commits**: Support for conventional commit format
-- ⚡ **Fast & Reliable**: Async processing with retry logic and error handling
-- 🎨 **Beautiful CLI**: Colored output with progress indicators
-- 🔄 **Auto-Updates**: Built-in update notifications
-- 🧪 **Well-Tested**: Comprehensive test suite with Jest
+- 🎯 **Conventional Commits**: Full support for conventional commit format with emoji
+- 🛡️ **Robust**: Comprehensive error handling with timeouts and auto-recovery
+- 🧠 **Smart Filtering**: Automatically filters generated files and whitespace
+- 🧪 **Production Ready**: Comprehensive test suite with 90%+ coverage
 
 ## 🚀 Installation
 
@@ -61,30 +63,60 @@ That's it! The tool will analyze your staged changes and generate an appropriate
 Generate and create a commit message for staged changes.
 
 **Options:**
+
+**Basic Options:**
 - `-y, --yes` - Skip confirmation and auto-commit
+- `-d, --dry-run` - Generate message without creating commit
+- `-v, --verbose` - Enable verbose logging
+- `-w, --watch` - Watch for changes and auto-generate commits
+
+**Commit Format:**
 - `-s, --scope <scope>` - Specify commit scope (e.g., auth, ui, api)
 - `-t, --type <type>` - Specify commit type (feat, fix, docs, etc.)
 - `-b, --breaking` - Mark as breaking change
-- `-d, --dry-run` - Generate message without creating commit
-- `-v, --verbose` - Enable verbose logging
+- `--emoji` - Include appropriate emoji in commit message
+- `--one-line` - Generate single-line commit message
+- `--description-length <length>` - Maximum description length
+
+**Provider & Processing:**
 - `-p, --provider <provider>` - Specify AI provider (openrouter|openai)
+- `--max-files <count>` - Maximum number of files to analyze
+- `--ignore-generated` - Ignore auto-generated files (default: true)
+- `--ignore-whitespace` - Ignore whitespace-only changes (default: true)
+
+**Caching:**
+- `--no-cache` - Disable caching for this commit
+- `--clear-cache` - Clear cache before generating
+
+**Git Integration:**
+- `--push` - Push changes to remote after commit
+- `--auto-push` - Automatically push all future commits
 
 **Examples:**
 ```bash
-# Basic usage
+# Basic usage with interactive push prompt
 orc commit
 
-# Auto-confirm with specific type and scope
-orc commit --yes --type feat --scope auth
+# Auto-confirm and push
+orc commit --yes --push
+
+# Generate with emoji and one-line format
+orc commit --emoji --one-line
+
+# Specify type, scope and auto-push
+orc commit --type feat --scope auth --auto-push
 
 # Dry run to see generated message
-orc commit --dry-run
+orc commit --dry-run --verbose
+
+# Breaking change with description limit
+orc commit --breaking --type feat --description-length 50
 
-# Use specific provider
-orc commit --provider openai
+# Clear cache and use specific provider
+orc commit --clear-cache --provider openai
 
-# Breaking change
-orc commit --breaking --type feat
+# Process only 5 files with no caching
+orc commit --max-files 5 --no-cache
 ```
 
 ### `orc config`
@@ -108,6 +140,20 @@ orc config get openrouter
 orc config path
 ```
 
+### `orc cache`
+Manage intelligent caching system.
+
+```bash
+# Show cache statistics
+orc cache stats
+
+# Clear all cached data
+orc cache clear
+
+# Clean up expired entries
+orc cache cleanup
+```
+
 ### `orc test`
 Test API connection for configured providers.
 
@@ -171,20 +217,26 @@ The tool is built with a modular TypeScript architecture:
 
 ### Core Modules
 
-- **CLI Module**: Command-line interface using Commander.js
-- **Config Module**: Secure configuration management with file permissions
-- **Git Module**: Git repository interaction and diff parsing
-- **API Module**: HTTP client with retry logic and rate limiting
-- **Logger Module**: Structured logging with progress indicators
-- **Core Orchestrator**: Main coordination and business logic
+- **CLI Module**: Command-line interface using Commander.js with @clack/prompts
+- **Config Module**: Secure configuration management with file permissions (600)
+- **Git Module**: Advanced Git repository interaction with intelligent diff parsing
+- **API Module**: Robust HTTP client with exponential backoff and concurrency control
+- **Logger Module**: Elegant progress indicators with timing and structured output
+- **Tokenizer Module**: Token-aware chunking using tiktoken for accurate processing
+- **Cache Module**: Two-level caching (memory + disk) with TTL and cleanup
+- **Diff Filter Module**: Smart filtering of generated files and irrelevant changes
+- **Core Orchestrator**: Main coordination with phase-based processing
 
 ### Key Features
 
-- **Chunked Processing**: Large diffs are intelligently split while preserving context
-- **Retry Logic**: Exponential backoff for API failures and rate limits
-- **Error Handling**: Comprehensive error types with proper error propagation
-- **Type Safety**: Full TypeScript coverage with strict type checking
-- **Testing**: Jest-based test suite with mocking for external dependencies
+- **Token-Based Chunking**: Uses tiktoken to respect actual model token limits
+- **Intelligent Caching**: Memory + disk caching with automatic cleanup and TTL
+- **Smart Filtering**: Automatically filters out generated files, lock files, and whitespace-only changes
+- **Interactive Push**: Prompts user for push with automatic upstream configuration
+- **Elegant UI**: Phase-based progress with emojis, timing, and structured output
+- **Robust Error Handling**: Comprehensive error types with timeout protection
+- **Type Safety**: Full TypeScript coverage with strict mode enabled
+- **Production Ready**: Extensive test suite with unit and integration tests
 
 ## 🔧 Advanced Usage
 
@@ -197,20 +249,33 @@ export OPENROUTER_API_KEY="your-key-here"
 export OPENAI_API_KEY="your-openai-key"
 ```
 
-### Large File Handling
+### Smart File Processing
+
+The tool intelligently processes large codebases:
+
+**Token-Aware Chunking:**
+- Uses tiktoken for accurate token counting
+- Respects model-specific token limits (GPT-4: 8K, Claude: 100K)
+- Preserves context at logical boundaries (files, functions)
+- Dynamic chunk sizing based on available tokens
 
-The tool automatically chunks large diffs to stay within API token limits:
+**Intelligent Filtering:**
+- Auto-detects and skips generated files (dist/, build/, .lock files)
+- Filters out whitespace-only changes
+- Relevancy scoring to focus on meaningful changes
+- Configurable file size limits (default: 1MB per file)
 
-- Maximum chunk size: 8,000 characters
-- Maximum concurrent requests: 3
-- Context preservation: File and function boundaries respected
+**Performance:**
+- Memory + disk caching for instant repeated requests
+- Concurrent API processing (up to 3 parallel requests)
+- Exponential backoff for rate limit handling
 
 ### Custom Models
 
 Configure specific models for each provider:
 
 ```bash
-# OpenRouter models
+# ORCommit models
 orc config model openrouter anthropic/claude-3-haiku:beta
 orc config model openrouter openai/gpt-4-turbo-preview
 
@@ -219,6 +284,33 @@ orc config model openai gpt-4
 orc config model openai gpt-3.5-turbo
 ```
 
+### Interactive Experience
+
+**Elegant Progress Display:**
+```
+🔍 Analyzing changes...
+✓ Found 15 staged files
+✓ Ready to analyze 12 files
+
+🤖 Generating commit message...
+✓ Commit message generated (1.2s)
+
+💾 Creating commit...
+✓ Commit created
+✓ Commit: feat(ui): add interactive push prompts
+
+Do you want to push to remote? › Yes
+🚀 Pushing to remote...
+✓ Pushed to main (2.1s)
+✓ Changes pushed successfully
+```
+
+**Smart Push Integration:**
+- Interactive prompts for push decisions
+- Automatic upstream branch setup
+- Support for multiple remotes
+- Graceful handling of push failures
+
 ## 🧪 Development
 
 ### Setup
@@ -259,7 +351,7 @@ npm test -- utils.test.ts
 
 - Node.js >= 16.0.0
 - Git repository
-- OpenRouter or OpenAI API key
+- ORCommit or OpenAI API key
 
 ## 🔐 Security
 
@@ -276,13 +368,26 @@ npm test -- utils.test.ts
 
 **"No staged changes found"**
 - Use `git add` to stage files before generating commits
+- Check if files are in .gitignore
 
 **"API key not configured"**
 - Set your API key: `orc config set openrouter your-key`
+- Verify with: `orc config get`
 
-**"Connection timeout"**
+**"All changes were filtered out"**
+- Check if only generated files were changed
+- Try with `--ignore-generated=false` to include all files
+- Use `--verbose` to see what was filtered
+
+**"Operation timed out"**
+- Large repositories may take time - operations auto-timeout at 30s
+- Try with `--max-files 10` to limit scope
 - Check your internet connection and API key validity
-- Try with `--verbose` flag for detailed error information
+
+**"Push failed"**
+- Ensure you have push permissions to the repository
+- Check if upstream branch is configured: `git branch -vv`
+- Try manual push first: `git push`
 
 ### Debug Mode
 
@@ -314,5 +419,7 @@ MIT License - see [LICENSE](LICENSE) file for details.
 - [OpenRouter](https://openrouter.ai/) for providing access to multiple AI models
 - [OpenAI](https://openai.com/) for their powerful language models
 - The open-source community for the excellent tools and libraries used in this project
-# Push functionality added
-# Improved elegant UI
+
+---
+
+**Built with ❤️ using TypeScript, Commander.js, and cutting-edge AI technology.**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orcommit",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Efficient CLI tool for generating commit messages using OpenRouter and OpenAI APIs with chunked processing for large files",
   "keywords": [
     "git",