commitor 0.1.0

Automatically generate conventional commit messages based on git diff using AI
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

//! Common types and data structures used throughout the commitor application

use serde::{Deserialize, Serialize};
use std::fmt;

/// Represents a conventional commit type
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum CommitType {
    Feat,
    Fix,
    Docs,
    Style,
    Refactor,
    Test,
    Chore,
    Perf,
    Ci,
    Build,
}

impl fmt::Display for CommitType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let type_str = match self {
            CommitType::Feat => "feat",
            CommitType::Fix => "fix",
            CommitType::Docs => "docs",
            CommitType::Style => "style",
            CommitType::Refactor => "refactor",
            CommitType::Test => "test",
            CommitType::Chore => "chore",
            CommitType::Perf => "perf",
            CommitType::Ci => "ci",
            CommitType::Build => "build",
        };
        write!(f, "{}", type_str)
    }
}

impl CommitType {
    /// Get all available commit types
    pub fn all() -> Vec<CommitType> {
        vec![
            CommitType::Feat,
            CommitType::Fix,
            CommitType::Docs,
            CommitType::Style,
            CommitType::Refactor,
            CommitType::Test,
            CommitType::Chore,
            CommitType::Perf,
            CommitType::Ci,
            CommitType::Build,
        ]
    }

    /// Get the description of the commit type
    pub fn description(&self) -> &'static str {
        match self {
            CommitType::Feat => "A new feature",
            CommitType::Fix => "A bug fix",
            CommitType::Docs => "Documentation only changes",
            CommitType::Style => "Changes that do not affect the meaning of the code",
            CommitType::Refactor => "A code change that neither fixes a bug nor adds a feature",
            CommitType::Test => "Adding missing tests or correcting existing tests",
            CommitType::Chore => "Changes to the build process or auxiliary tools",
            CommitType::Perf => "A code change that improves performance",
            CommitType::Ci => "Changes to CI configuration files and scripts",
            CommitType::Build => "Changes that affect the build system or external dependencies",
        }
    }
}

/// Represents a conventional commit message
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ConventionalCommit {
    pub commit_type: CommitType,
    pub scope: Option<String>,
    pub description: String,
    pub breaking: bool,
}

impl ConventionalCommit {
    /// Create a new conventional commit
    pub fn new(commit_type: CommitType, description: String) -> Self {
        Self {
            commit_type,
            scope: None,
            description,
            breaking: false,
        }
    }

    /// Set the scope of the commit
    pub fn with_scope(mut self, scope: String) -> Self {
        self.scope = Some(scope);
        self
    }

    /// Mark the commit as breaking
    pub fn with_breaking(mut self) -> Self {
        self.breaking = true;
        self
    }
}

impl fmt::Display for ConventionalCommit {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let breaking_indicator = if self.breaking { "!" } else { "" };

        match &self.scope {
            Some(scope) => write!(
                f,
                "{}({}){}: {}",
                self.commit_type, scope, breaking_indicator, self.description
            ),
            None => write!(
                f,
                "{}{}: {}",
                self.commit_type, breaking_indicator, self.description
            ),
        }
    }
}

/// Represents a git diff change
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct DiffChange {
    pub file_path: String,
    pub change_type: DiffChangeType,
    pub additions: usize,
    pub deletions: usize,
}

/// Type of change in a git diff
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub enum DiffChangeType {
    Added,
    Modified,
    Deleted,
    Renamed,
    Copied,
}

impl fmt::Display for DiffChangeType {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let type_str = match self {
            DiffChangeType::Added => "added",
            DiffChangeType::Modified => "modified",
            DiffChangeType::Deleted => "deleted",
            DiffChangeType::Renamed => "renamed",
            DiffChangeType::Copied => "copied",
        };
        write!(f, "{}", type_str)
    }
}

/// Represents the result of generating commit messages
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GenerationResult {
    pub messages: Vec<String>,
    pub model_used: String,
    pub generation_time: std::time::Duration,
}

/// Error types specific to commitor
#[derive(Debug, thiserror::Error)]
pub enum CommitorError {
    #[error("Git repository not found")]
    GitRepoNotFound,

    #[error("No staged changes found")]
    NoStagedChanges,

    #[error("AI Provider error: {0}")]
    AIProviderError(String),

    #[error("Git operation failed: {0}")]
    GitError(String),

    #[error("Invalid commit message format: {0}")]
    InvalidCommitFormat(String),

    #[error("Configuration error: {0}")]
    ConfigError(String),
}