Skip to content

Feat/improvements #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 7, 2025
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
dist/
node_modules/
vscode-extension/node_modules/
vscode-extension/out/
*.js.map
*.d.ts.map
CHANGELOG.md
11 changes: 11 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"semi": true,
"trailingComma": "none",
"singleQuote": true,
"printWidth": 100,
"tabWidth": 2,
"useTabs": false,
"bracketSpacing": true,
"arrowParens": "avoid",
"endOfLine": "lf"
}
38 changes: 31 additions & 7 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This file provides comprehensive context for Claude AI sessions working on the C
**CommitWeave** is a modern CLI tool for creating smart, structured, and beautiful git commit messages with emoji support, conventional commit rules, AI-powered summaries, and built-in hooks.

### Key Details
- **Version**: 1.0.3
- **Version**: 1.1.0
- **Package**: @typeweaver/commitweave
- **Language**: TypeScript (100%)
- **Runtime**: Node.js >= 18.0.0
Expand Down Expand Up @@ -51,6 +51,8 @@ commitweave/
│ ├── types/ # TypeScript definitions
│ │ └── ai.ts # AI provider types and custom error classes
│ ├── ui/ # User interface components
│ │ ├── banner.ts # ASCII art banners and branding
│ │ └── progress.ts # Progress indicators and loading animations
│ ├── utils/ # Utilities (git, ai)
│ │ ├── ai.ts # AI integration with enhanced error handling
│ │ ├── configStore.ts # Configuration loading and saving
Expand Down Expand Up @@ -101,6 +103,15 @@ commitweave/
- **Validation**: Commit message format and length validation
- **TypeScript**: 100% type coverage with comprehensive interfaces

### Enhanced UX Features (Latest) ✅
- **Native Check Command**: Full validation with detailed error messages and actionable solutions
- **Progress Indicators**: Spinning animations with contextual status updates for all async operations
- **Command Shortcuts**: Power user aliases (v, ls, ai, health, etc.) for faster workflow
- **Enhanced Error Messages**: Multiple solution paths with copy-paste commands for quick fixes
- **Diff Analysis**: Smart statistics showing file changes, additions, and deletions
- **UI Configuration**: Granular control over ASCII art, animations, colors, and fancy UI elements
- **Graceful Fallbacks**: Elegant error handling with informative guidance messages

### Performance Optimizations (Latest) ✅
- **Ultra-fast Cold-start**: 23ms average startup time (13x better than 300ms target)
- **Lazy Loading**: Heavy dependencies loaded only when needed
Expand Down Expand Up @@ -195,6 +206,13 @@ interface Config {
model: string;
maxTokens: number;
};
ui?: { // UI configuration options (new)
fancyUI: boolean; // Enable/disable fancy UI elements
asciiArt: boolean; // Show ASCII art banners
animations: boolean; // Enable loading animations
colors: boolean; // Use terminal colors
emoji: boolean; // Display emojis in output
};
maxSubjectLength: number;
maxBodyLength: number;
hooks?: {
Expand Down Expand Up @@ -229,15 +247,21 @@ commitweave --ai # AI-powered commit generation
commitweave --plain # Disable fancy UI (for performance)
commitweave --debug-perf # Enable performance reporting
commitweave init # Initialize configuration
commitweave check # Validate latest commit message
commitweave check # Validate latest commit message (aliases: validate, v)
commitweave --help # Show help

# Configuration Management Commands
commitweave export [options] # Export current configuration
commitweave import <source> [opts] # Import configuration from file/URL
commitweave list # Display current configuration
commitweave reset [options] # Reset configuration to defaults
commitweave doctor # Validate and diagnose configuration
commitweave list # Display current configuration (aliases: ls, show)
commitweave reset [options] # Reset configuration to defaults (alias: clear)
commitweave doctor # Validate and diagnose configuration (aliases: health, check-config)

# Command Shortcuts (Power User Aliases)
commitweave ai # Direct AI commit (no -- flag needed)
commitweave v # Quick validate (shortcut for check)
commitweave ls # Quick list config (shortcut for list)
commitweave health # Quick health check (shortcut for doctor)

# Performance Commands
npm run bench # Run cold-start performance benchmark
Expand Down Expand Up @@ -441,6 +465,6 @@ CommitWeave has been thoroughly tested across multiple dimensions:
---

**Last Updated**: Generated on 2025-08-07
**Context Version**: 4.0
**Context Version**: 4.1
**For**: Claude AI development sessions
**Recent Changes**: Enhanced VS Code extension with 5 commands, tabbed settings panel, Quick Commit workflow, commit history visualization, template system, real-time validation, Source Control integration, professional theming, and comprehensive git operations
**Recent Changes**: Enhanced UX with native check command, progress indicators, command shortcuts, enhanced error messages, diff analysis, UI configuration options, and graceful fallbacks. All UI elements now configurable via UI config schema with ASCII art enabled by default.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ commitweave --ai
- 🔧 **Git Integration** - stage and commit seamlessly
- 📦 **TypeScript First** with full IntelliSense
- 🛡️ **Cross-Platform** (Windows, macOS, Linux)
-**Command Shortcuts** for power users

</td>
<td valign="top" width="50%">
Expand All @@ -111,10 +112,12 @@ commitweave --ai
- 🤖 **AI Commit Generation** (OpenAI & Claude)
- 🧩 **VS Code Extension** with native integration
- 📋 **Team Config Sharing** via export/import
-**Message Validation** with helpful suggestions
- 📊 **Commit Analytics** and history visualization
-**Message Validation** with actionable solutions
- 📊 **Diff Analysis** with smart statistics
- 🎯 **Progress Indicators** for all operations
- 🔄 **Version Control** for configurations
- 🏥 **Health Monitoring** with doctor command
- 🎨 **UI Configuration** - customize all visual elements

</td>
</tr>
Expand All @@ -127,10 +130,19 @@ commitweave --ai
| Command | Description | Example |
|---------|-------------|---------|
| `commitweave` | Interactive commit creation | Creates commits with guided prompts |
| `commitweave --ai` | AI-powered commit generation | Analyzes changes, suggests commits |
| `commitweave ai` | AI-powered commit generation | Analyzes changes, suggests commits |
| `commitweave init` | Initialize project configuration | Sets up `glinr-commit.json` |
| `commitweave check` | Validate your last commit | Checks conventional commit compliance |

### ⚡ Command Shortcuts (Power Users)

| Shortcut | Full Command | Description |
|----------|-------------|-------------|
| `commitweave v` | `commitweave check` | Quick validate last commit |
| `commitweave ls` | `commitweave list` | Quick list configuration |
| `commitweave ai` | `commitweave --ai` | Direct AI commit (no flag) |
| `commitweave health` | `commitweave doctor` | Quick health check |

### Configuration Management

| Command | Description | Use Case |
Expand Down Expand Up @@ -179,6 +191,13 @@ commitweave --ai
"ai": {
"provider": "openai",
"model": "gpt-4"
},
"ui": {
"fancyUI": true,
"asciiArt": true,
"animations": true,
"colors": true,
"emoji": true
}
}
```
Expand Down
Loading
Loading