@elsikora/commitizen-plugin-commitlint-ai 1.2.0 → 2.0.0-dev.2

package/README.md

@@ -3,7 +3,7 @@
 </p>
 
 <h1 align="center">Commitizen Plugin Commitlint AI 🤖</h1>
-<p align="center"><em>AI-powered Commitizen adapter that generates conventional commits with Commitlint integration</em></p>
+<p align="center"><em>AI-powered Commitizen adapter that generates conventional commits with Commitlint integration, built with clean architecture principles</em></p>
 
 <p align="center">
     <a aria-label="ElsiKora logo" href="https://elsikora.com">
@@ -15,29 +15,65 @@
 
 - [Description](#-description)
 - [Features](#-features)
+- [Architecture](#-architecture)
 - [Installation](#-installation)
 - [Usage](#-usage)
+- [Configuration](#-configuration)
 - [Roadmap](#-roadmap)
 - [FAQ](#-faq)
 - [License](#-license)
 
 ## 📖 Description
 
-This plugin enhances your Git workflow by combining the power of AI with conventional commit standards. It intelligently analyzes your code changes and generates meaningful commit messages that follow your project's commitlint rules. Whether you're working solo or in a team, this tool helps maintain consistent, high-quality commit history while reducing the cognitive load of writing commit messages.
+This plugin enhances your Git workflow by combining the power of AI with conventional commit standards. Built with clean architecture principles, it intelligently analyzes your code changes and generates meaningful commit messages that follow your project's commitlint rules. Whether you're working solo or in a team, this tool helps maintain consistent, high-quality commit history while reducing the cognitive load of writing commit messages.
 
 ## 🚀 Features
 
-- ✨ **AI-powered commit message generation using OpenAI or Anthropic models**
+- ✨ **AI-powered commit message generation using OpenAI, Anthropic, Google, Azure OpenAI, AWS Bedrock, or Ollama models**
 - ✨ **Full integration with Commitlint rules and configuration**
+- ✨ **Flexible configuration with Cosmiconfig support**
+- ✨ **Environment variable support for API keys (prioritized over config)**
+- ✨ **Automatic model migration for deprecated models**
+- ✨ **Configurable retry mechanism for generation and validation**
 - ✨ **Support for both manual and automatic commit modes**
 - ✨ **Smart scope detection based on changed files**
 - ✨ **Breaking change detection and documentation**
-- ✨ **Customizable commit message format**
-- ✨ **Interactive commit message confirmation**
-- ✨ **Supports multiple AI models including GPT-4, Claude 3, and more**
-- ✨ **Environment variable support for API keys**
+- ✨ **Interactive commit message confirmation with validation**
+- ✨ **Clean architecture with dependency injection**
+- ✨ **Real-time retry status updates in the UI**
+- ✨ **Supports latest AI models including GPT-4.1 and Claude 4**
 - ✨ **Fallback to manual mode if AI generation fails**
 
+## 🏗 Architecture
+
+The plugin is built using clean architecture principles with clear separation of concerns:
+
+### Layers
+
+- **Domain Layer**: Core business logic, entities, and value objects
+
+  - Entities: `CommitMessage`, `LLMConfiguration`
+  - Value Objects: `ApiKey`, `CommitBody`, `CommitHeader`
+  - Enums: `ECommitMode`, `ELLMProvider`, `ELogLevel`
+
+- **Application Layer**: Use cases and interfaces
+
+  - Use Cases: `GenerateCommitMessageUseCase`, `ValidateCommitMessageUseCase`, `ConfigureLLMUseCase`
+  - Interfaces: `ILLMService`, `ICommitValidator`, `IConfigService`, etc.
+
+- **Infrastructure Layer**: External services and implementations
+
+  - LLM Services: `OpenAILLMService`, `AnthropicLLMService`, `GoogleLLMService`, `AzureOpenAILLMService`, `AWSBedrockLLMService`, `OllamaLLMService`
+  - Services: `CommitlintValidatorService`, `CosmicConfigService`, `PromptsCliInterface`
+  - Repositories: `GitCommitRepository`
+
+- **Presentation Layer**: User interface adapters
+  - `CommitizenAdapter` as the main entry point
+
+### Dependency Injection
+
+The plugin uses `@elsikora/cladi` for dependency injection, ensuring loose coupling and testability.
+
 ## 🛠 Installation
 
 ```bash
@@ -64,86 +100,249 @@ git add .
 git cz
 ```
 
-### Configuration
+The plugin will:
 
-```javascript
-// commitlint.config.js
-module export default {
-  extends: ['@commitlint/config-conventional'],
-  rules: {
-    'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'style', 'refactor']],
-    'scope-case': [2, 'always', 'lower-case']
-  }
-}
-```
+1. Ask for your commit mode preference (auto/manual)
+2. If auto mode and no API key is configured, guide you through configuration
+3. Generate or help you write a commit message
+4. Validate against your commitlint rules
+5. Allow you to confirm or edit before committing
 
 ### Environment Variables
 
 ```bash
-# .env
-OPENAI_API_KEY=your-api-key
+# .env or shell environment
+OPENAI_API_KEY=your-openai-api-key
+# or
+ANTHROPIC_API_KEY=your-anthropic-api-key
 # or
-ANTHROPIC_API_KEY=your-api-key
+GOOGLE_API_KEY=your-google-api-key
+# or (for Azure OpenAI, use pipe-separated format)
+AZURE_OPENAI_API_KEY=https://your-resource.openai.azure.com|your-api-key|your-deployment-name
+# or (for AWS Bedrock, use pipe-separated format)
+AWS_BEDROCK_API_KEY=us-east-1|your-access-key-id|your-secret-access-key
+# or (for Ollama, specify host and optional model)
+OLLAMA_API_KEY=localhost:11434|custom-model-name
 ```
 
-### Manual Mode
+Environment variables take precedence over stored configuration.
 
-```bash
-# Create .elsikora/manual file to enable manual mode
-mkdir -p .elsikora
-touch .elsikora/manual
-```
+## ⚙️ Configuration
+
+The plugin supports multiple configuration methods using [Cosmiconfig](https://github.com/davidtheclark/cosmiconfig):
 
-### Advanced Usage with TypeScript
+### Configuration File Locations
 
-```typescript
-import { getLLMConfig, setLLMConfig } from "@elsikora/commitizen-plugin-commitlint-ai";
+Create a configuration file in any of these locations:
 
-// Configure AI provider
-setLLMConfig({
+- `.commitlintairc`
+- `.commitlintairc.json`
+- `.commitlintairc.yaml`
+- `.commitlintairc.yml`
+- `.commitlintairc.js`
+- `.commitlintairc.cjs`
+- `commitlintai.config.js`
+- `commitlintai.config.cjs`
+- `package.json` (under `"commitlintai"` key)
+
+### Configuration Options
+
+```javascript
+// commitlintai.config.js
+module.exports = {
+	// AI provider: 'openai', 'anthropic', 'google', 'azure-openai', 'aws-bedrock', or 'ollama'
 	provider: "openai",
-	model: "gpt-4",
+
+	// Model to use (auto-migrates deprecated models)
+	model: "gpt-4o",
+
+	// Mode: 'auto' or 'manual'
 	mode: "auto",
-	apiKey: process.env.OPENAI_API_KEY,
-});
+
+	// API key (optional - env vars recommended)
+	// Format varies by provider:
+	// - OpenAI/Anthropic/Google: 'your-api-key'
+	// - Azure OpenAI: 'endpoint|api-key|deployment-name'
+	// - AWS Bedrock: 'region|access-key-id|secret-access-key'
+	// - Ollama: 'host:port' or 'host:port|custom-model-name'
+	apiKey: "your-api-key",
+
+	// Retry configuration
+	maxGenerationRetries: 3,
+	maxValidationRetries: 3,
+
+	// Custom instructions for AI
+	instructions: "Focus on user-facing changes",
+};
 ```
 
-### Custom Prompt Configuration
+### Available Models
+
+## Supported LLM Providers
+
+### OpenAI
+
+- `gpt-4.1` (Latest 2025, most capable)
+- `gpt-4.1-nano` (Fastest 4.1 model)
+- `gpt-4.1-mini` (Balanced performance)
+- `gpt-4o` (Enhanced creative writing)
+- `gpt-4o-mini` (Faster, cost-effective)
+- `gpt-4-turbo`
+- `gpt-4` (Original)
+- `gpt-3.5-turbo` (Fastest, most economical)
+- `o1` (Enhanced reasoning)
+- `o1-mini` (Fast reasoning)
+
+### Anthropic
+
+- `claude-opus-4-20250514` (Latest 2025, most capable)
+- `claude-sonnet-4-20250514` (Latest 2025, high-performance)
+- `claude-3-7-sonnet-latest` (Extended thinking capabilities)
+- `claude-3-5-sonnet-latest` (Previous flagship)
+- `claude-3-5-haiku-latest` (Fastest)
+- `claude-3-opus-latest` (Complex tasks)
+
+### Google (Gemini)
+
+- `gemini-2.5-pro` (Latest 2025, most capable)
+- `gemini-2.5-flash` (Latest 2025, fast)
+- `gemini-2.0-flash-exp` (Experimental)
+- `gemini-1.5-pro` (Stable, capable)
+- `gemini-1.5-flash` (Fast, stable)
+- `gemini-1.5-flash-8b` (Lightweight)
+- `gemini-1.0-pro`
+
+### Google (Gemma - Open Models for Vertex AI)
+
+- `gemma-3-27b` (Most capable open model)
+- `gemma-3-12b` (Strong language capabilities)
+- `gemma-3-4b` (Balanced, multimodal support)
+- `gemma-3-1b` (Lightweight for edge deployment)
+
+### Azure OpenAI
+
+- `gpt-4.1-turbo-2024-12-17` (Latest 2025, most capable)
+- `gpt-4.1-preview-2024-12-17` (Latest preview)
+- `gpt-4.1-mini-2024-12-17` (Fast 4.1 model)
+- `gpt-4o-2024-11-20` (Enhanced creative)
+- `gpt-4o-mini-2024-07-18`
+- `gpt-4-turbo`
+- `gpt-3.5-turbo`
+- `o3-2024-12-17` (Enhanced reasoning)
+- `o4-mini-2024-12-17` (Fast reasoning)
+
+### AWS Bedrock
+
+- `anthropic.claude-opus-4-20250514-v1:0` (Claude Opus 4 - Latest 2025, most capable)
+- `anthropic.claude-sonnet-4-20250514-v1:0` (Claude Sonnet 4 - Latest 2025, balanced)
+- `anthropic.claude-3-5-sonnet-20241022-v2:0` (Claude 3.5 Sonnet v2)
+- `anthropic.claude-3-5-haiku-20241022-v1:0` (Fast)
+- `anthropic.claude-3-5-sonnet-20240620-v1:0`
+- `us.amazon.nova-pro-v1:0` (Latest Amazon model)
+- `us.deepseek.deepseek-r1:0` (Advanced reasoning)
+- `us.meta.llama3-2-90b-instruct-v1:0` (Open source)
+- `mistral.mistral-large-2411-v1:0` (Latest Mistral)
+
+### Ollama (Local Models)
+
+- `llama3.2` (Latest Llama)
+- `llama3.1`
+- `llama3`
+- `mistral`
+- `codellama`
+- `deepseek-coder`
+- `custom` (specify any Ollama model)
+
+### Commitlint Configuration
 
 ```javascript
-// .elsikora/commitlint-ai.config.js
+// commitlint.config.js
 export default {
-	provider: "anthropic",
-	model: "claude-3-opus-20240229",
-	mode: "auto",
+	extends: ["@commitlint/config-conventional"],
+	rules: {
+		"type-enum": [2, "always", ["feat", "fix", "docs", "style", "refactor"]],
+		"scope-case": [2, "always", "lower-case"],
+		"subject-max-length": [2, "always", 72],
+		"body-max-line-length": [2, "always", 100],
+	},
 };
 ```
 
+### Manual Mode
+
+To force manual mode without prompting:
+
+```bash
+# Create .elsikora/manual file
+mkdir -p .elsikora
+touch .elsikora/manual
+```
+
+### Package.json Configuration
+
+```json
+{
+	"commitlintai": {
+		"provider": "anthropic",
+		"model": "claude-3-5-sonnet-20241022",
+		"mode": "auto",
+		"maxGenerationRetries": 5
+	}
+}
+```
+
 ## 🛣 Roadmap
 
-| Task / Feature                                                               | Status         |
-| ---------------------------------------------------------------------------- | -------------- |
-| Future development plans include:                                            | 🚧 In Progress |
-| - Support for more AI providers                                              | 🚧 In Progress |
-| - Enhanced diff analysis for better commit suggestions                       | 🚧 In Progress |
-| - Custom prompt templates                                                    | 🚧 In Progress |
-| - Integration with more Git hosting platforms                                | 🚧 In Progress |
-| - Performance optimizations for large codebases                              | 🚧 In Progress |
-| - Multi-language support for commit messages                                 | 🚧 In Progress |
-| - Team collaboration features                                                | 🚧 In Progress |
-| (done) AI-powered commit message generation using OpenAI or Anthropic models | 🚧 In Progress |
-| (done) Full integration with Commitlint rules and configuration              | 🚧 In Progress |
-| (done) Support for both manual and automatic commit modes                    | 🚧 In Progress |
+| Task / Feature                                                        | Status      |
+| --------------------------------------------------------------------- | ----------- |
+| AI-powered commit message generation using OpenAI or Anthropic models | ✅ Complete |
+| Full integration with Commitlint rules and configuration              | ✅ Complete |
+| Support for both manual and automatic commit modes                    | ✅ Complete |
+| Clean architecture implementation                                     | ✅ Complete |
+| Cosmiconfig support for flexible configuration                        | ✅ Complete |
+| Environment variable support with priority over config                | ✅ Complete |
+| Automatic model migration for deprecated models                       | ✅ Complete |
+| Configurable retry mechanism with UI feedback                         | ✅ Complete |
+| Dependency injection with @elsikora/cladi                             | ✅ Complete |
+| Support for more AI providers (Google, Azure, AWS, Ollama)            | ✅ Complete |
+| Enhanced diff analysis for better commit suggestions                  | 🚧 Planned  |
+| Custom prompt templates per project                                   | 🚧 Planned  |
+| Integration with more Git hosting platforms                           | 🚧 Planned  |
+| Performance optimizations for large codebases                         | 🚧 Planned  |
+| Multi-language support for commit messages                            | 🚧 Planned  |
+| Team collaboration features                                           | 🚧 Planned  |
+| Web UI for configuration management                                   | 🚧 Planned  |
 
 ## ❓ FAQ
 
-**Q: How does the AI generate commit messages?** A: The plugin analyzes your git diff and changed files, then uses AI to understand the changes and generate appropriate conventional commit messages that comply with your commitlint rules.
+**Q: How does the AI generate commit messages?**  
+A: The plugin analyzes your git diff and changed files, then uses AI to understand the changes and generate appropriate conventional commit messages that comply with your commitlint rules.
+
+**Q: What happens if the AI service is unavailable?**  
+A: The plugin has a configurable retry mechanism and will automatically fall back to manual mode after exhausting retries, allowing you to enter commit messages traditionally.
+
+**Q: Can I use custom commit message formats?**  
+A: Yes, the plugin respects your commitlint configuration and generates messages accordingly. You can also provide custom instructions to guide the AI.
+
+**Q: Is my code sent to the AI service?**  
+A: Only the git diff and file names are sent to generate accurate commit messages. No full source code is transmitted unless it appears in the diff.
+
+**Q: How do I switch between providers or models?**  
+A: You can reconfigure at any time by running `git cz` and choosing to reconfigure when prompted, or by updating your configuration file.
+
+**Q: How do I use Ollama with custom models?**  
+A: Set the model to `custom` and include the model name in your API key: `localhost:11434|your-custom-model`.
 
-**Q: What happens if the AI service is unavailable?** A: The plugin automatically falls back to manual mode, allowing you to enter commit messages traditionally.
+**Q: What's the difference between provider API key formats?**  
+A: Each provider has specific requirements:
 
-**Q: Can I use custom commit message formats?** A: Yes, the plugin respects your commitlint configuration and generates messages accordingly.
+- OpenAI/Anthropic/Google: Simple API key string
+- Azure OpenAI: `endpoint|api-key|deployment-name`
+- AWS Bedrock: `region|access-key-id|secret-access-key`
+- Ollama: `host:port` or `host:port|custom-model-name`
 
-**Q: Is my code sent to the AI service?** A: Only the git diff and file names are sent to generate accurate commit messages. No full source code is transmitted.
+**Q: What if I'm using an older model that's deprecated?**  
+A: The plugin automatically migrates deprecated models to their latest versions (e.g., `claude-3-5-sonnet-20240620` → `claude-3-5-sonnet-20241022`).
 
 ## 🔒 License
 

package/dist/cjs/application/constant/config-file-directory.constant.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Directory where configuration files are stored
+ */
+export declare const CONFIG_FILE_DIRECTORY: string;

package/dist/cjs/application/constant/config-file-directory.constant.js

@@ -0,0 +1,9 @@
+'use strict';
+
+/**
+ * Directory where configuration files are stored
+ */
+const CONFIG_FILE_DIRECTORY = ".elsikora";
+
+exports.CONFIG_FILE_DIRECTORY = CONFIG_FILE_DIRECTORY;
+//# sourceMappingURL=config-file-directory.constant.js.map

package/dist/cjs/application/constant/config-file-directory.constant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-file-directory.constant.js","sources":["../../../../../src/application/constant/config-file-directory.constant.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;;AAEG;AACI,MAAM,qBAAqB,GAAW;;;;"}

package/dist/cjs/application/constant/config-module-name.constant.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Module name for configuration
+ */
+export declare const CONFIG_MODULE_NAME: string;

package/dist/cjs/application/constant/config-module-name.constant.js

@@ -0,0 +1,9 @@
+'use strict';
+
+/**
+ * Module name for configuration
+ */
+const CONFIG_MODULE_NAME = "commitlint-ai";
+
+exports.CONFIG_MODULE_NAME = CONFIG_MODULE_NAME;
+//# sourceMappingURL=config-module-name.constant.js.map

package/dist/cjs/application/constant/config-module-name.constant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-module-name.constant.js","sources":["../../../../../src/application/constant/config-module-name.constant.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA;;AAEG;AACI,MAAM,kBAAkB,GAAW;;;;"}

package/dist/cjs/application/constant/index.d.ts

@@ -0,0 +1,2 @@
+export * from './config-file-directory.constant';
+export * from './config-module-name.constant';

package/dist/cjs/application/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './interface/index';
+export * from './use-case/index';

package/dist/cjs/application/interface/cli-interface-service-select-options.interface.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Options for select inputs in the CLI interface
+ */
+export interface ICliInterfaceServiceSelectOptions {
+    /**
+     * Optional hint text for the option
+     */
+    hint?: string;
+    /**
+     * Whether the option is disabled
+     */
+    isDisabled?: boolean;
+    /**
+     * Display label for the option
+     */
+    label: string;
+    /**
+     * Value to be returned when the option is selected
+     */
+    value: string;
+}

package/dist/cjs/application/interface/cli-interface-service.interface.d.ts

@@ -0,0 +1,105 @@
+import type { ICliInterfaceServiceSelectOptions } from './cli-interface-service-select-options.interface';
+/**
+ * Interface for CLI user interaction services.
+ * Provides methods for displaying information and collecting input from users.
+ */
+export interface ICliInterfaceService {
+    /**
+     * Clears the console screen.
+     */
+    clear(): void;
+    /**
+     * Displays a confirmation prompt to the user.
+     * @param message - The message to display to the user
+     * @param isConfirmedByDefault - The default value for the confirmation, defaults to false
+     * @returns Promise that resolves to the user's response (true for confirmed, false for declined)
+     */
+    confirm(message: string, isConfirmedByDefault?: boolean): Promise<boolean>;
+    /**
+     * Displays an error message to the user.
+     * @param message - The error message to display
+     */
+    error(message: string): void;
+    /**
+     * Displays a grouped multi-select prompt to the user.
+     * @param message - The message to display to the user
+     * @param options - Record of groups and their options
+     * @param isRequired - Whether a selection is required, defaults to false
+     * @param initialValue - Initial selected values
+     * @returns Promise that resolves to an array of selected values
+     */
+    groupMultiselect<T>(message: string, options: Record<string, Array<ICliInterfaceServiceSelectOptions>>, isRequired?: boolean, initialValue?: Array<string>): Promise<Array<T>>;
+    /**
+     * Handles and displays an error message with additional error details.
+     * @param message - The error message to display
+     * @param error - The error object or details
+     */
+    handleError(message: string, error: unknown): void;
+    /**
+     * Displays an informational message to the user.
+     * @param message - The info message to display
+     */
+    info(message: string): void;
+    /**
+     * Displays a standard message to the user.
+     * @param message - The message to display
+     */
+    log(message: string): void;
+    /**
+     * Displays a multi-select prompt to the user.
+     * @param message - The message to display to the user
+     * @param options - Array of options to select from
+     * @param isRequired - Whether a selection is required, defaults to false
+     * @param initialValue - Initial selected values
+     * @returns Promise that resolves to an array of selected values
+     */
+    multiselect<T>(message: string, options: Array<ICliInterfaceServiceSelectOptions>, isRequired?: boolean, initialValue?: Array<string>): Promise<Array<T>>;
+    /**
+     * Displays a note to the user with a title and message.
+     * @param title - The title of the note
+     * @param message - The message content of the note
+     */
+    note(title: string, message: string): void;
+    /**
+     * Displays a single select prompt to the user.
+     * @param message - The message to display to the user
+     * @param options - Array of options to select from
+     * @param initialValue - Initial selected value
+     * @returns Promise that resolves to the selected value
+     */
+    select<T>(message: string, options: Array<ICliInterfaceServiceSelectOptions>, initialValue?: string): Promise<T>;
+    /**
+     * Starts a spinner with the specified message.
+     * @param message - The message to display while the spinner is active
+     */
+    startSpinner(message: string): void;
+    /**
+     * Stops the current spinner with an optional completion message.
+     * @param message - Optional message to display when the spinner stops
+     */
+    stopSpinner(message?: string): void;
+    /**
+     * Displays a success message to the user.
+     * @param message - The success message to display
+     */
+    success(message: string): void;
+    /**
+     * Displays a text input prompt to the user.
+     * @param message - The message to display to the user
+     * @param placeholder - Optional placeholder text for the input field
+     * @param initialValue - Optional initial value for the input field
+     * @param validate - Optional validation function for the input
+     * @returns Promise that resolves to the user's input text
+     */
+    text(message: string, placeholder?: string, initialValue?: string, validate?: (value: string) => Error | string | undefined): Promise<string>;
+    /**
+     * Updates the spinner message.
+     * @param message - The new message to display
+     */
+    updateSpinner(message: string): void;
+    /**
+     * Displays a warning message to the user.
+     * @param message - The warning message to display
+     */
+    warn(message: string): void;
+}

package/dist/cjs/application/interface/command-service.interface.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Interface for executing commands.
+ * Provides a method for executing shell commands.
+ */
+export interface ICommandService {
+    /**
+     * Executes a shell command.
+     * @param command - The shell command to execute
+     * @returns Promise that resolves when the command completes successfully
+     * @throws May throw an error if the command execution fails
+     */
+    execute(command: string): Promise<void>;
+    /**
+     * Execute a command and return its output
+     * @param command - The command to execute
+     * @returns Promise that resolves to the command output
+     */
+    executeWithOutput(command: string): Promise<string>;
+}

package/dist/cjs/application/interface/commit-repository.interface.d.ts

@@ -0,0 +1,32 @@
+import type { CommitMessage } from '../../domain/entity/commit-message.entity';
+/**
+ * Interface for commit repository operations
+ */
+export interface ICommitRepository {
+    /**
+     * Create a commit with the given message
+     * @param message - The commit message
+     * @returns Promise that resolves when the commit is created
+     */
+    commit(message: CommitMessage): Promise<void>;
+    /**
+     * Get the current branch name
+     * @returns Promise resolving to the current branch name
+     */
+    getCurrentBranch(): Promise<string>;
+    /**
+     * Get the staged diff
+     * @returns Promise resolving to the staged diff
+     */
+    getStagedDiff(): Promise<string>;
+    /**
+     * Get the list of staged files
+     * @returns Promise resolving to the list of staged files
+     */
+    getStagedFiles(): Promise<Array<string>>;
+    /**
+     * Check if there are staged changes
+     * @returns Promise resolving to true if there are staged changes
+     */
+    hasStagedChanges(): Promise<boolean>;
+}

package/dist/cjs/application/interface/commit-validator.interface.d.ts

@@ -0,0 +1,29 @@
+import type { CommitMessage } from '../../domain/entity/commit-message.entity';
+import type { ILlmPromptContext } from './llm-service.interface';
+/**
+ * Validation result for a commit message
+ */
+export interface ICommitValidationResult {
+    errors?: Array<string>;
+    isValid: boolean;
+    warnings?: Array<string>;
+}
+/**
+ * Interface for commit message validators
+ */
+export interface ICommitValidator {
+    /**
+     * Attempt to fix a commit message based on validation errors
+     * @param message - The commit message to fix
+     * @param validationResult - The validation result containing errors
+     * @param context - Optional original context (diff, files, etc.) for better fixing
+     * @returns Promise resolving to the fixed commit message or null if unfixable
+     */
+    fix(message: CommitMessage, validationResult: ICommitValidationResult, context?: ILlmPromptContext): Promise<CommitMessage | null>;
+    /**
+     * Validate a commit message
+     * @param message - The commit message to validate
+     * @returns Promise resolving to the validation result
+     */
+    validate(message: CommitMessage): Promise<ICommitValidationResult>;
+}