@untools/commitgen 0.0.5 → 0.1.1

package/README.md

@@ -0,0 +1,333 @@
+<!-- ./README.md -->
+
+# @untools/commitgen
+
+🚀 AI-powered commit message generator for Git with modular AI provider support.
+
+## Features
+
+✨ **AI-Powered Generation**: Leverages advanced AI models to analyze your git changes and generate meaningful commit messages
+
+🎯 **Conventional Commits**: Follows the [Conventional Commits](https://www.conventionalcommits.org/) specification
+
+🔌 **Modular Providers**: Support for multiple AI providers:
+
+- ✅ Vercel AI SDK (Google Gemini)
+- 🔜 Vercel AI SDK (OpenAI)
+- 🔜 Groq
+- 🔜 OpenAI Direct
+- 🔜 Google Direct
+- 🔜 Local LLMs (Ollama, LM Studio, etc.)
+
+🎨 **Beautiful CLI**: Colorized output with interactive prompts using Inquirer
+
+📊 **Smart Analysis**: Analyzes file patterns, additions/deletions, and git diffs
+
+⚡ **Fast**: Efficient processing with fallback to rule-based suggestions
+
+## Installation
+
+```bash
+# Global installation (recommended)
+npm install -g @untools/commitgen
+
+# Or use with npx
+npx @untools/commitgen
+```
+
+## Quick Start
+
+1. **Stage your changes**:
+
+```bash
+git add .
+```
+
+2. **Generate commit message**:
+
+```bash
+commitgen
+```
+
+That's it! If it's your first time, CommitGen will automatically prompt you to configure your API key. The tool will then analyze your changes and suggest commit messages.
+
+### First-Time Setup
+
+When you run `commitgen` for the first time without an API key, you'll see:
+
+```
+⚠️  API key not found for the selected provider.
+? Would you like to configure your API key now? (Y/n)
+```
+
+Choose "Yes" to set up your configuration, or run `commitgen config` manually anytime.
+
+## Usage
+
+### Basic Commands
+
+```bash
+# Generate commit message (interactive)
+commitgen
+
+# Commit and push in one command
+commitgen --push
+
+# Skip git hooks
+commitgen --noverify
+
+# Use rule-based suggestions (no AI)
+commitgen --no-ai
+
+# Configure AI provider
+commitgen config
+
+# Show help
+commitgen --help
+
+# Show version
+commitgen --version
+```
+
+### Configuration
+
+The configuration file is stored at `~/.commitgenrc.json`:
+
+```json
+{
+  "provider": {
+    "provider": "vercel-google",
+    "model": "gemini-2.5-flash",
+    "apiKey": "optional-if-using-env-var"
+  }
+}
+```
+
+### Environment Variables
+
+You can use environment variables instead of storing API keys in the config:
+
+```bash
+# For Google Gemini (via Vercel AI SDK)
+export GOOGLE_GENERATIVE_AI_API_KEY="your-api-key"
+
+# Then run without configuring
+commitgen
+```
+
+## AI Providers
+
+### Vercel AI SDK - Google Gemini (Available Now)
+
+Uses the [Vercel AI SDK](https://sdk.vercel.ai/) with Google's Gemini models.
+
+**Setup:**
+
+1. Get a free API key from [Google AI Studio](https://aistudio.google.com/app/apikey)
+2. Run `commitgen config` and select "Vercel AI SDK - Google Gemini"
+3. Enter your API key or set `GOOGLE_GENERATIVE_AI_API_KEY` environment variable
+
+**Available Models:**
+
+- `gemini-2.5-flash` (Recommended - Fast and efficient)
+- `gemini-2.5-pro` (More capable, higher quality)
+- `gemini-1.5-flash`
+- `gemini-1.5-pro`
+
+### Coming Soon
+
+- **Vercel AI SDK - OpenAI**: GPT-4o, GPT-4o-mini
+- **Groq**: Ultra-fast inference with Llama models
+- **OpenAI Direct**: Direct OpenAI API integration
+- **Google Direct**: Direct Google Generative AI integration
+- **Local LLMs**: Ollama, LM Studio, LocalAI support
+
+## How It Works
+
+1. **Analysis**: Scans your staged git changes
+
+   - File patterns (tests, docs, configs, components)
+   - Addition/deletion statistics
+   - Git diff content
+
+2. **AI Generation**: Sends analysis to your configured AI provider
+
+   - Uses a specialized prompt for commit message generation
+   - Follows Conventional Commits specification
+   - Returns 3-5 contextual suggestions
+
+3. **Selection**: Interactive prompt to choose or customize
+
+   - Select from AI-generated suggestions
+   - Write a custom message
+   - Confirm before committing
+
+4. **Commit**: Executes git commit with your chosen message
+   - Optional: Push to remote with `--push` flag
+   - Optional: Skip hooks with `--noverify` flag
+
+## Examples
+
+### Typical Workflow
+
+```bash
+# Make some changes
+vim src/components/Button.tsx
+
+# Stage changes
+git add src/components/Button.tsx
+
+# Generate and commit
+commitgen
+```
+
+Output:
+
+```
+🚀 CommitGen - AI-Powered Commit Message Generator
+
+📊 Analysis:
+   Files changed: 1
+   Additions: +45
+   Deletions: -12
+
+📝 Changed files:
+   ⚛️ src/components/Button.tsx
+
+🤖 Generating commit messages using vercel-google...
+
+💡 Suggested commit messages:
+
+1. feat(components): add variant prop to Button component
+2. feat(Button): implement new button styles and variants
+3. refactor(components): restructure Button component props
+4. style(Button): update button styling system
+✏️  Write custom message
+
+? Choose a commit message: (Use arrow keys)
+```
+
+### Configuration Example
+
+```bash
+$ commitgen config
+
+⚙️  Configure CommitGen
+
+? Select AI provider: Vercel AI SDK - Google Gemini
+? Enter your Google AI API key: **********************
+? Select model: Gemini 2.5 Flash (Fast, Recommended)
+
+✅ Configuration saved successfully!
+Config file: /Users/you/.commitgenrc.json
+```
+
+## Commit Message Format
+
+Generated messages follow the Conventional Commits specification:
+
+```
+<type>(<scope>): <subject>
+
+<body>
+
+<footer>
+```
+
+**Types:**
+
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation changes
+- `style`: Code style changes
+- `refactor`: Code refactoring
+- `perf`: Performance improvements
+- `test`: Test updates
+- `build`: Build system changes
+- `ci`: CI/CD changes
+- `chore`: Maintenance tasks
+- `revert`: Revert previous commit
+
+**Example:**
+
+```
+feat(auth): add OAuth2 authentication
+
+Implemented OAuth2 flow with Google and GitHub providers.
+Added JWT token management and refresh logic.
+
+BREAKING CHANGE: Authentication API has changed
+```
+
+## Troubleshooting
+
+### "No staged changes found"
+
+Make sure you've staged your changes:
+
+```bash
+git add <files>
+# or
+git add .
+```
+
+### "API key is required"
+
+Set your API key either:
+
+1. Run `commitgen config` to save it in config file
+2. Set environment variable: `export GOOGLE_GENERATIVE_AI_API_KEY="your-key"`
+
+### AI generation fails
+
+The tool will automatically fall back to rule-based suggestions if AI generation fails. You can also force rule-based mode with `--no-ai`.
+
+## Development
+
+```bash
+# Clone the repository
+git clone https://github.com/aevrHQ/untools-commitgen.git
+cd untools-commitgen
+
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Link for local testing
+npm link
+
+# Run
+commitgen
+```
+
+## Dependencies
+
+```json
+{
+  "@ai-sdk/google": "^1.x.x",
+  "ai": "^4.x.x",
+  "chalk": "^4.1.2",
+  "commander": "^13.1.0",
+  "inquirer": "^12.5.2"
+}
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT © Miracle Onyenma
+
+## Links
+
+- [GitHub Repository](https://github.com/aevrHQ/untools-commitgen)
+- [npm Package](https://www.npmjs.com/package/@untools/commitgen)
+- [Issue Tracker](https://github.com/aevrHQ/untools-commitgen/issues)
+
+---
+
+Made with ❤️ by [Miracle Onyenma](https://github.com/miracleonyenma)

package/dist/commands/configure.d.ts

@@ -0,0 +1 @@
+export declare function configureCommand(): Promise<void>;

package/dist/commands/configure.js

@@ -0,0 +1,96 @@
+"use strict";
+// ./src/commands/configure.ts
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureCommand = configureCommand;
+const inquirer_1 = __importDefault(require("inquirer"));
+const chalk_1 = __importDefault(require("chalk"));
+const config_1 = require("../config");
+async function configureCommand() {
+    console.log(chalk_1.default.cyan.bold("\n⚙️  Configure CommitGen\n"));
+    const configManager = new config_1.ConfigManager();
+    const currentConfig = configManager.getProviderConfig();
+    // Show current configuration if it exists
+    if (currentConfig.provider) {
+        console.log(chalk_1.default.gray("Current configuration:"));
+        console.log(chalk_1.default.gray(`  Provider: ${currentConfig.provider}`));
+        console.log(chalk_1.default.gray(`  Model: ${currentConfig.model || "default"}`));
+        console.log(chalk_1.default.gray(`  API Key: ${currentConfig.apiKey ? "***configured***" : "not set"}`));
+        console.log();
+    }
+    const { provider } = await inquirer_1.default.prompt([
+        {
+            type: "list",
+            name: "provider",
+            message: "Select AI provider:",
+            choices: [
+                { name: "Vercel AI SDK - Google Gemini", value: "vercel-google" },
+                {
+                    name: "Vercel AI SDK - OpenAI (Coming Soon)",
+                    value: "vercel-openai",
+                    disabled: true,
+                },
+                { name: "Groq (Coming Soon)", value: "groq", disabled: true },
+                {
+                    name: "OpenAI Direct (Coming Soon)",
+                    value: "openai",
+                    disabled: true,
+                },
+                {
+                    name: "Google Direct (Coming Soon)",
+                    value: "google",
+                    disabled: true,
+                },
+                { name: "Local LLM (Coming Soon)", value: "local", disabled: true },
+            ],
+            default: currentConfig.provider || "vercel-google",
+        },
+    ]);
+    let config = { provider };
+    // Provider-specific configuration
+    if (provider === "vercel-google") {
+        const hasEnvKey = !!process.env.GOOGLE_GENERATIVE_AI_API_KEY;
+        const { apiKey, model } = await inquirer_1.default.prompt([
+            {
+                type: "password",
+                name: "apiKey",
+                message: hasEnvKey
+                    ? "Enter your Google AI API key (or press Enter to use GOOGLE_GENERATIVE_AI_API_KEY env var):"
+                    : "Enter your Google AI API key (get one at https://aistudio.google.com/app/apikey):",
+                mask: "*",
+                validate: (input) => {
+                    if (!input.trim() && !hasEnvKey) {
+                        return "API key is required. Get one at https://aistudio.google.com/app/apikey";
+                    }
+                    return true;
+                },
+                default: currentConfig.provider === provider
+                    ? currentConfig.apiKey
+                    : undefined,
+            },
+            {
+                type: "list",
+                name: "model",
+                message: "Select model:",
+                choices: [
+                    {
+                        name: "Gemini 2.5 Flash (Fast, Recommended)",
+                        value: "gemini-2.5-flash",
+                    },
+                    { name: "Gemini 2.5 Pro (More Capable)", value: "gemini-2.5-pro" },
+                    { name: "Gemini 1.5 Flash", value: "gemini-1.5-flash" },
+                    { name: "Gemini 1.5 Pro", value: "gemini-1.5-pro" },
+                ],
+                default: currentConfig.model || "gemini-2.5-flash",
+            },
+        ]);
+        config.apiKey = apiKey || undefined;
+        config.model = model;
+    }
+    configManager.setProvider(config);
+    console.log(chalk_1.default.green("\n✅ Configuration saved successfully!"));
+    console.log(chalk_1.default.gray(`Config file: ${require("os").homedir()}/.commitgenrc.json`));
+}
+//# sourceMappingURL=configure.js.map

package/dist/commands/configure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configure.js","sourceRoot":"","sources":["../../src/commands/configure.ts"],"names":[],"mappings":";AAAA,8BAA8B;;;;;AAO9B,4CAoGC;AAzGD,wDAAgC;AAChC,kDAA0B;AAC1B,sCAA0C;AAGnC,KAAK,UAAU,gBAAgB;IACpC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAE5D,MAAM,aAAa,GAAG,IAAI,sBAAa,EAAE,CAAC;IAC1C,MAAM,aAAa,GAAG,aAAa,CAAC,iBAAiB,EAAE,CAAC;IAExD,0CAA0C;IAC1C,IAAI,aAAa,CAAC,QAAQ,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC;QAClD,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,eAAe,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QACjE,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,IAAI,CAAC,YAAY,aAAa,CAAC,KAAK,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC;QACxE,OAAO,CAAC,GAAG,CACT,eAAK,CAAC,IAAI,CACR,cAAc,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,EAAE,CACtE,CACF,CAAC;QACF,OAAO,CAAC,GAAG,EAAE,CAAC;IAChB,CAAC;IAED,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,kBAAQ,CAAC,MAAM,CAAC;QACzC;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE,qBAAqB;YAC9B,OAAO,EAAE;gBACP,EAAE,IAAI,EAAE,+BAA+B,EAAE,KAAK,EAAE,eAAe,EAAE;gBACjE;oBACE,IAAI,EAAE,sCAAsC;oBAC5C,KAAK,EAAE,eAAe;oBACtB,QAAQ,EAAE,IAAI;iBACf;gBACD,EAAE,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;gBAC7D;oBACE,IAAI,EAAE,6BAA6B;oBACnC,KAAK,EAAE,QAAQ;oBACf,QAAQ,EAAE,IAAI;iBACf;gBACD;oBACE,IAAI,EAAE,6BAA6B;oBACnC,KAAK,EAAE,QAAQ;oBACf,QAAQ,EAAE,IAAI;iBACf;gBACD,EAAE,IAAI,EAAE,yBAAyB,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;aACpE;YACD,OAAO,EAAE,aAAa,CAAC,QAAQ,IAAI,eAAe;SACnD;KACF,CAAC,CAAC;IAEH,IAAI,MAAM,GAAmB,EAAE,QAAQ,EAAE,CAAC;IAE1C,kCAAkC;IAClC,IAAI,QAAQ,KAAK,eAAe,EAAE,CAAC;QACjC,MAAM,SAAS,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC;QAE7D,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,kBAAQ,CAAC,MAAM,CAAC;YAC9C;gBACE,IAAI,EAAE,UAAU;gBAChB,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,SAAS;oBAChB,CAAC,CAAC,4FAA4F;oBAC9F,CAAC,CAAC,mFAAmF;gBACvF,IAAI,EAAE,GAAG;gBACT,QAAQ,EAAE,CAAC,KAAa,EAAE,EAAE;oBAC1B,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC;wBAChC,OAAO,wEAAwE,CAAC;oBAClF,CAAC;oBACD,OAAO,IAAI,CAAC;gBACd,CAAC;gBACD,OAAO,EACL,aAAa,CAAC,QAAQ,KAAK,QAAQ;oBACjC,CAAC,CAAC,aAAa,CAAC,MAAM;oBACtB,CAAC,CAAC,SAAS;aAChB;YACD;gBACE,IAAI,EAAE,MAAM;gBACZ,IAAI,EAAE,OAAO;gBACb,OAAO,EAAE,eAAe;gBACxB,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,sCAAsC;wBAC5C,KAAK,EAAE,kBAAkB;qBAC1B;oBACD,EAAE,IAAI,EAAE,+BAA+B,EAAE,KAAK,EAAE,gBAAgB,EAAE;oBAClE,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,kBAAkB,EAAE;oBACvD,EAAE,IAAI,EAAE,gBAAgB,EAAE,KAAK,EAAE,gBAAgB,EAAE;iBACpD;gBACD,OAAO,EAAE,aAAa,CAAC,KAAK,IAAI,kBAAkB;aACnD;SACF,CAAC,CAAC;QAEH,MAAM,CAAC,MAAM,GAAG,MAAM,IAAI,SAAS,CAAC;QACpC,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;IAED,aAAa,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAElC,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC,CAAC;IAClE,OAAO,CAAC,GAAG,CACT,eAAK,CAAC,IAAI,CAAC,gBAAgB,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,oBAAoB,CAAC,CACxE,CAAC;AACJ,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,15 @@
+import { ProviderConfig } from "./types";
+interface CommitGenConfig {
+    provider?: ProviderConfig;
+    defaultProvider?: "vercel-google" | "vercel-openai" | "groq" | "openai" | "google" | "local";
+}
+export declare class ConfigManager {
+    private configPath;
+    private config;
+    constructor();
+    private loadConfig;
+    saveConfig(config: CommitGenConfig): void;
+    getProviderConfig(): ProviderConfig;
+    setProvider(config: ProviderConfig): void;
+}
+export {};

package/dist/config.js

@@ -0,0 +1,56 @@
+"use strict";
+// ./src/config.ts
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigManager = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+class ConfigManager {
+    constructor() {
+        this.configPath = path_1.default.join(os_1.default.homedir(), ".commitgenrc.json");
+        this.config = this.loadConfig();
+    }
+    loadConfig() {
+        try {
+            if (fs_1.default.existsSync(this.configPath)) {
+                const content = fs_1.default.readFileSync(this.configPath, "utf8");
+                return JSON.parse(content);
+            }
+        }
+        catch (error) {
+            console.warn("Failed to load config file:", error);
+        }
+        return {};
+    }
+    saveConfig(config) {
+        try {
+            fs_1.default.writeFileSync(this.configPath, JSON.stringify(config, null, 2), "utf8");
+            this.config = config;
+        }
+        catch (error) {
+            console.error("Failed to save config:", error);
+        }
+    }
+    getProviderConfig() {
+        if (this.config.provider) {
+            return this.config.provider;
+        }
+        // Default to vercel-google
+        return {
+            provider: this.config.defaultProvider || "vercel-google",
+            apiKey: process.env.GOOGLE_GENERATIVE_AI_API_KEY,
+            model: "gemini-2.5-flash",
+        };
+    }
+    setProvider(config) {
+        this.saveConfig({
+            ...this.config,
+            provider: config,
+        });
+    }
+}
+exports.ConfigManager = ConfigManager;
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";AAAA,kBAAkB;;;;;;AAElB,4CAAoB;AACpB,gDAAwB;AACxB,4CAAoB;AAcpB,MAAa,aAAa;IAIxB;QACE,IAAI,CAAC,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,YAAE,CAAC,OAAO,EAAE,EAAE,mBAAmB,CAAC,CAAC;QAC/D,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;IAClC,CAAC;IAEO,UAAU;QAChB,IAAI,CAAC;YACH,IAAI,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBACnC,MAAM,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;gBACzD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,IAAI,CAAC,6BAA6B,EAAE,KAAK,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,UAAU,CAAC,MAAuB;QAChC,IAAI,CAAC;YACH,YAAE,CAAC,aAAa,CACd,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAC/B,MAAM,CACP,CAAC;YACF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACvB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IAED,iBAAiB;QACf,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC9B,CAAC;QAED,2BAA2B;QAC3B,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe,IAAI,eAAe;YACxD,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,4BAA4B;YAChD,KAAK,EAAE,kBAAkB;SAC1B,CAAC;IACJ,CAAC;IAED,WAAW,CAAC,MAAsB;QAChC,IAAI,CAAC,UAAU,CAAC;YACd,GAAG,IAAI,CAAC,MAAM;YACd,QAAQ,EAAE,MAAM;SACjB,CAAC,CAAC;IACL,CAAC;CACF;AArDD,sCAqDC"}