Merge branch 'release/v1.9.0'

Author: mingcheng

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "aigitcommit"
-version = "1.7.2"
+version = "1.9.0"
 edition = "2024"
 description = "A simple git commit message generator by OpenAI compaction model."
 license-file = "LICENSE"
@@ -9,11 +9,11 @@ keywords = ["git", "tools", "ai", "development"]
 authors = ["mingcheng <mingcheng@apache.org>"]
 repository = "https://github.com/mingcheng/aigitcommit"
 homepage = "https://github.com/mingcheng/aigitcommit"
-exclude = ["assets/*", "hooks/*"]
+exclude = ["assets/*"]
 categories = ["command-line-utilities", "development-tools"]
 
 [dependencies]
-reqwest = { version = "0.12", features = [
+reqwest = { version = "0.13", features = [
     "json",
     "stream",
     "socks",
@@ -23,8 +23,8 @@ reqwest = { version = "0.12", features = [
     "charset",
     "native-tls-vendored",
 ] }
-askama = "0.14"
-async-openai = "0.30"
+askama = "0.16"
+async-openai = { version = "0.37", features = ["chat-completion", "model"] }
 git2 = "0.20"
 tokio = { version = "1.52.2", features = ["full"] }
 serde = { version = "1.0", features = ["derive"] }
@@ -35,7 +35,7 @@ tracing = "0.1"
 tracing-subscriber = "0.3"
 arboard = "3.6"
 tabled = "0.20"
-cliclack = "0.3.8"
+cliclack = "0.5.4"
 regex = "1.12.3"
 
 [[bin]]

Cargo.toml

@@ -131,6 +131,10 @@ Install into a specific repository:
 aigitcommit install-hook /path/to/repo
 ```
 
+If a `prepare-commit-msg` hook already exists, it is renamed to
+`prepare-commit-msg.bak` before the new hook is written, so your previous
+hook is preserved (any prior `.bak` is overwritten).
+
 Prerequisite: `aigitcommit` is installed and available in your `PATH`.
 
 **Prerequisites**
@@ -191,8 +195,7 @@ Configure AIGitCommit by setting these environment variables (in your shell prof
 
 **Optional:**
 - `OPENAI_API_PROXY`: HTTP/SOCKS5 proxy URL (e.g., `http://127.0.0.1:1080`, `socks5://127.0.0.1:1086`)
-- `OPENAI_API_TIMEOUT`: Request timeout in seconds (default: 30)
-- `OPENAI_API_MAX_TOKENS`: Maximum tokens in response (default: model-specific)
+- `OPENAI_API_TIMEOUT`: HTTP request timeout in seconds. Unset, empty, invalid, or `0` means "use the HTTP client default (no timeout)"
 - `AIGITCOMMIT_SIGNOFF`: Enable auto sign-off (`true`, `1`, `yes`, `on`)
 
 **Example configuration:**

README.md

@@ -191,15 +191,24 @@ mod tests {
     }
 
     #[test]
-    fn put_then_get_roundtrip() {
-        let tmp = std::env::temp_dir().join(format!(
-            "aigitcommit-cache-roundtrip-{}",
-            std::process::id()
-        ));
+    fn clear_removes_entries_and_returns_count() {
+        let tmp =
+            std::env::temp_dir().join(format!("aigitcommit-cache-clear-{}", std::process::id()));
         let _ = fs::remove_dir_all(&tmp);
         let cache = Cache::new(&tmp);
-        cache.put("abc", "title\n\nbody");
-        assert_eq!(cache.get("abc").as_deref(), Some("title\n\nbody"));
-        let _ = cache.clear();
+        cache.put("a", "1");
+        cache.put("b", "2");
+        cache.put("c", "3");
+        let removed = cache.clear().unwrap();
+        assert_eq!(removed, 3);
+        // Subsequent clear on a non-existent dir is a no-op.
+        assert_eq!(cache.clear().unwrap(), 0);
+    }
+
+    #[test]
+    fn build_key_format_is_16_hex_chars() {
+        let k = Cache::build_key("m", "s", &[], &[]);
+        assert_eq!(k.len(), 16);
+        assert!(k.chars().all(|c| c.is_ascii_hexdigit()));
     }
 }

src/cache.rs

@@ -15,134 +15,96 @@
 use crate::built_info;
 use clap::{Parser, Subcommand};
 
+/// Command-line interface for `aigitcommit`.
+///
+/// Boolean flags omit `default_value_t = false` because that is already the
+/// default for `bool`. Optional positional arguments omit `required = false`
+/// for the same reason. This keeps the attribute noise down and makes the
+/// definition easier to scan.
 #[derive(Debug, Parser)]
-#[command(name = built_info::PKG_NAME, about = built_info::PKG_DESCRIPTION, version = built_info::PKG_VERSION, author = built_info::PKG_AUTHORS)]
+#[command(
+    name = built_info::PKG_NAME,
+    about = built_info::PKG_DESCRIPTION,
+    version = built_info::PKG_VERSION,
+    author = built_info::PKG_AUTHORS,
+)]
 pub struct Cli {
     #[command(subcommand)]
     pub command: Option<Command>,
-    #[arg(
-        default_value = ".",
-        help = r#"Specify the file path to repository directory.
-If not specified, the current directory will be used"#,
-        required = false
-    )]
+
+    /// Path to the repository directory. Defaults to the current directory.
+    #[arg(default_value = ".")]
     pub repo_path: String,
 
-    #[arg(
-        long,
-        short,
-        help = "Verbose mode",
-        default_value_t = false,
-        required = false
-    )]
+    /// Enable verbose (TRACE-level) logging.
+    #[arg(long, short)]
     pub verbose: bool,
 
-    #[arg(
-        long,
-        help = "Check the openai api key and model name whether is available",
-        default_value_t = false,
-        required = false
-    )]
+    /// Verify that the configured OpenAI model is available.
+    #[arg(long)]
     pub check_model: bool,
 
-    #[arg(
-        long,
-        help = "Prompt the commit after generating the message",
-        default_value_t = false,
-        required = false
-    )]
+    /// Prompt to commit after generating the message.
+    #[arg(long)]
     pub commit: bool,
 
-    #[arg(
-        long,
-        help = "Mark whether the commit is a signoff commit",
-        default_value_t = false,
-        required = false
-    )]
+    /// Append a `Signed-off-by` trailer to the commit message.
+    #[arg(long)]
     pub signoff: bool,
 
-    #[arg(
-        long,
-        short,
-        help = "Accept the commit message without prompting",
-        default_value_t = false,
-        required = false
-    )]
+    /// Accept the generated commit message without prompting.
+    #[arg(long, short)]
     pub yes: bool,
 
-    #[arg(
-        long,
-        help = "Copy the commit message to clipboard",
-        default_value_t = false,
-        required = false
-    )]
+    /// Copy the generated commit message to the system clipboard.
+    #[arg(long)]
     pub copy_to_clipboard: bool,
 
-    #[arg(
-        long,
-        help = "Print the commit message in JSON format",
-        default_value_t = false,
-        required = false
-    )]
+    /// Print the commit message as JSON.
+    #[arg(long)]
     pub json: bool,
 
-    #[arg(
-        long,
-        help = "Print the commit message in a table format",
-        default_value_t = false,
-        required = false
-    )]
+    /// Print the commit message as plain text instead of a table.
+    #[arg(long)]
     pub no_table: bool,
 
-    #[arg(
-        long,
-        help = "Check current environment variables for OpenAI API key and model name",
-        default_value_t = false,
-        required = false
-    )]
+    /// Print the values of the OpenAI-related environment variables and exit.
+    #[arg(long)]
     pub check_env: bool,
 
-    #[arg(
-        long,
-        short,
-        default_value = "",
-        help = "Save the commit message to a file",
-        required = false
-    )]
+    /// Save the generated commit message to the given file.
+    #[arg(long, short, default_value = "")]
     pub save: String,
 
-    #[arg(
-        long,
-        help = "Disable the local cache and always request a fresh message from the API",
-        default_value_t = false,
-        required = false
-    )]
+    /// Bypass the local cache and always request a fresh message from the API.
+    #[arg(long)]
     pub no_cache: bool,
 
-    #[arg(
-        long,
-        help = "Clear the local cache for the current repository and exit",
-        default_value_t = false,
-        required = false
-    )]
+    /// Clear the local cache for the current repository and exit.
+    #[arg(long)]
     pub clear_cache: bool,
 }
 
 #[derive(Debug, Subcommand)]
 pub enum Command {
-    #[command(
-        name = "install-hook",
-        about = "Install git hook script into the specified repository directory"
-    )]
+    /// Install the `prepare-commit-msg` git hook into the given repository.
+    #[command(name = "install-hook")]
     InstallHook {
-        #[arg(
-            default_value = ".",
-            help = "Repository directory to install the git hook into",
-            required = false
-        )]
+        /// Repository directory to install the git hook into.
+        #[arg(default_value = ".")]
         repo_path: String,
     },
 }
 
 #[cfg(test)]
-mod tests {}
+mod tests {
+    use super::*;
+    use clap::CommandFactory;
+
+    #[test]
+    fn cli_definition_is_valid() {
+        // Catches programmer mistakes (duplicate short flags, bad attrs)
+        // at test time instead of at first user invocation.
+        Cli::command().debug_assert();
+    }
+}

src/cli.rs

@@ -13,6 +13,7 @@
  */
 
 use crate::git::repository::Repository;
+use std::fmt::Write as _;
 use std::{error::Error, fmt::Display};
 use tracing::trace;
 
@@ -71,12 +72,13 @@ impl GitMessage {
         if signoff {
             trace!("adding Signed-off-by line to commit message");
             let author = repository.get_author()?;
-
-            // Ensure proper spacing before signoff
-            final_content.push_str(&format!(
+            // Writing into the existing String avoids the intermediate alloc
+            // that `format!` + `push_str` would create.
+            write!(
+                final_content,
                 "\n\nSigned-off-by: {} <{}>",
                 author.name, author.email
-            ));
+            )?;
         }
 
         trace!("created commit message with title: {}", title_trimmed);
@@ -87,21 +89,51 @@ impl GitMessage {
             content: final_content,
         })
     }
+}
 
-    /// Check if the commit message is empty
-    ///
-    /// Returns true only if both title and content are empty strings
-    pub fn is_empty(&self) -> bool {
-        self.title.is_empty() && self.content.is_empty()
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use std::env;
+
+    fn setup() -> Option<Repository> {
+        let path = env::var("TEST_REPO_PATH").unwrap_or_else(|_| ".".to_string());
+        Repository::new(&path).ok()
+    }
+
+    #[test]
+    fn rejects_empty_title() {
+        let Some(repo) = setup() else { return };
+        let err = GitMessage::new(&repo, "   ", "body", false).unwrap_err();
+        assert!(err.to_string().contains("title"));
+    }
+
+    #[test]
+    fn rejects_empty_content() {
+        let Some(repo) = setup() else { return };
+        let err = GitMessage::new(&repo, "title", "   ", false).unwrap_err();
+        assert!(err.to_string().contains("content"));
     }
 
-    /// Get the total character count of the commit message
-    pub fn char_count(&self) -> usize {
-        self.title.len() + 2 + self.content.len() // +2 for "\n\n"
+    #[test]
+    fn trims_inputs_and_formats_display() {
+        let Some(repo) = setup() else { return };
+        let msg = GitMessage::new(&repo, "  feat: x  ", "  body line  ", false).unwrap();
+        assert_eq!(msg.title, "feat: x");
+        assert_eq!(msg.content, "body line");
+        assert_eq!(format!("{msg}"), "feat: x\n\nbody line");
     }
 
-    /// Get the number of lines in the commit message
-    pub fn line_count(&self) -> usize {
-        1 + self.content.lines().count() // +1 for title, +blank line is implicit
+    #[test]
+    fn appends_signoff_line_when_requested() {
+        let Some(repo) = setup() else { return };
+        let msg = GitMessage::new(&repo, "feat: x", "body", true).unwrap();
+        assert!(
+            msg.content.contains("Signed-off-by:"),
+            "signoff line missing: {}",
+            msg.content
+        );
+        // Signoff is separated from body by a blank line.
+        assert!(msg.content.contains("\n\nSigned-off-by:"));
     }
 }