feat: 添加分支名生成功能并升级版本至0.1.3 (#5)

- 新增分支名生成功能(--gb/--generate-branch选项)
- 添加分支名前缀配置支持
- 更新README文档说明新功能
- 版本升级至0.1.3

Signed-off-by: jinlong <fslongjin@vip.qq.com>

Author: fslongjin

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "fastcommit"
-version = "0.1.2"
+version = "0.1.3"
 description = "AI-based command line tool to quickly generate standardized commit messages."
 edition = "2021"
 authors = ["longjin <fslongjin@vip.qq.com>"]

Cargo.toml

@@ -10,7 +10,7 @@ You can install `fastcommit` using the following method:
 
 ```bash
 # Install using cargo
-cargo install --git  https://github.com/fslongjin/fastcommit --tag 0.1.2
+cargo install --git  https://github.com/fslongjin/fastcommit --tag 0.1.3
 ```
 
 ## Usage
@@ -24,9 +24,13 @@ fastcommit
 
 ### Options
 
+NOTE: All common config can be configured via `~/.fastcommit/config.toml`
+
 - `-d, --diff-file <DIFF_FILE>`: Specify the path to the file containing the differences.
 - `--conventional <CONVENTIONAL>`: Enable or disable conventional commit style analysis. Acceptable values are `true` or `false`.
 - `-l, --language <LANGUAGE>`: Specify the language for the commit message. Acceptable values are `en` (English) or `zh` (Chinese).
+- `-gb, --generate-branch`: Generate branch name.
+   - `--branch-prefix`: prefix of the generated branch name
 - `-v, --verbosity <VERBOSITY>`: Set the detail level of the commit message. Acceptable values are `verbose` (detailed), `normal`, or `quiet` (concise). The default is `quiet`.
 - `-h, --help`: Print help information.
 - `-V, --version`: Print version information.

README.md

@@ -8,7 +8,7 @@
 
 ```bash
 # 使用 cargo 安装
-cargo install --git  https://github.com/fslongjin/fastcommit --tag 0.1.2
+cargo install --git  https://github.com/fslongjin/fastcommit --tag 0.1.3
 ```
 
 ## 使用
@@ -22,9 +22,13 @@ fastcommit
 
 ### 选项
 
+NOTE: All common config can be configured via `~/.fastcommit/config.toml`
+
 - `-d, --diff-file <DIFF_FILE>`: 指定包含差异的文件路径。
 - `--conventional <CONVENTIONAL>`: 启用或禁用规范提交风格分析。可选值为 `true` 或 `false`。
 - `-l, --language <LANGUAGE>`: 指定提交信息的语言。可选值为 `en`（英文）或 `zh`（中文）。
+- `-gb, --generate-branch`: 模式：生成分支名
+   - `--branch-prefix`: 生成的分支名的前缀 
 - `-v, --verbosity <VERBOSITY>`: 设置提交信息的详细级别。可选值为 `verbose`（详细）、`normal`（正常）或 `quiet`（简洁）。 默认为 `quiet`。
 - `-h, --help`: 打印帮助信息。
 - `-V, --version`: 打印版本信息。

README_CN.md

@@ -16,4 +16,14 @@ pub struct Args {
 
     #[clap(short, long, help = "Set the verbosity level")]
     pub verbosity: Option<Verbosity>,
+
+    #[clap(
+        long = "generate-branch",
+        alias = "gb",
+        help = "Generate a branch name based on changes (optionally with prefix)"
+    )]
+    pub generate_branch: bool,
+
+    #[clap(long, help = "Override branch prefix (default from config)")]
+    pub branch_prefix: Option<String>,
 }

src/cli.rs

@@ -5,7 +5,7 @@ use crate::constants::{DEFAULT_MAX_TOKENS, DEFAULT_OPENAI_API_BASE, DEFAULT_OPEN
 
 #[derive(Debug, Serialize, Deserialize)]
 pub struct Config {
-    pub api_base: Option<String>,
+    api_base: Option<String>,
     pub api_key: String,
     pub model: Option<String>,
     /// The maximum number of tokens to generate in the commit message.
@@ -14,6 +14,25 @@ pub struct Config {
     pub conventional: bool,
     pub language: CommitLanguage,
     pub verbosity: Verbosity,
+    /// Prefix for generated branch names (e.g. username in monorepo)
+    pub branch_prefix: Option<String>,
+}
+
+impl Config {
+    pub fn api_base(&self) -> String {
+        let api_base = self
+            .api_base
+            .as_deref()
+            .unwrap_or("https://api.openai.com/v1");
+
+        let api_base = if api_base.ends_with("/") {
+            api_base.to_owned()
+        } else {
+            format!("{}/", api_base)
+        };
+
+        api_base
+    }
 }
 
 /// Commit message verbosity level.
@@ -84,6 +103,7 @@ impl Default for Config {
             conventional: true,
             language: CommitLanguage::default(),
             verbosity: Verbosity::default(),
+            branch_prefix: None,
         }
     }
 }

src/config.rs

@@ -91,3 +91,42 @@ lazy_static! {
 }
 
 pub const DEFAULT_MAX_TOKENS: u32 = 2048;
+
+pub const BRANCH_NAME_PROMPT: &str = r#"
+# 角色
+作为代码版本控制专家，请根据以下变更生成一个简洁、描述性的分支名。
+
+# 要求：
+1. 使用英文小写字母和连字符
+2. 长度不超过40个字符
+3. 能准确反映变更内容
+4. 如果有前缀，请在前面加上前缀
+5. 直接返回分支名，不要包含其他内容或解释
+6. branch name内容要使用<aicommit></aicommit>标签包裹
+
+# 示例：
+
+branch name内容要使用<aicommit>标签包裹，例如：
+
+## 示例1：
+
+<aicommit>
+fix-login-issue
+</aicommit>
+
+## 示例2：
+
+<aicommit>
+feat-add-user-auth
+</aicommit>
+
+## 示例3：
+
+<aicommit>
+username-refactor-payment-module
+</aicommit>
+
+变更内容：
+
+{{diff}}
+"#;

src/constants.rs

@@ -4,24 +4,17 @@ use std::process::Command;
 
 use crate::cli;
 use crate::config::{self, Config};
+
+use crate::constants::BRANCH_NAME_PROMPT;
 use crate::constants::{
     DEFAULT_MAX_TOKENS, DEFAULT_OPENAI_MODEL, DEFAULT_PROMPT_TEMPLATE, STOP_WORDS,
 };
 use crate::template_engine::{render_template, TemplateContext};
 
 async fn generate_commit_message(diff: &str, config: &config::Config) -> anyhow::Result<String> {
     let auth = Auth::new(config.api_key.as_str());
-    let api_base = config
-        .api_base
-        .as_deref()
-        .unwrap_or("https://api.openai.com/v1");
 
-    let api_base_url = if api_base.ends_with("/") {
-        api_base.to_owned()
-    } else {
-        format!("{}/", api_base)
-    };
-    let openai = OpenAI::new(auth, &api_base_url);
+    let openai = OpenAI::new(auth, &config.api_base());
 
     let template_ctx =
         TemplateContext::new(config.conventional, config.language, config.verbosity, diff);
@@ -64,7 +57,7 @@ async fn generate_commit_message(diff: &str, config: &config::Config) -> anyhow:
         .ok_or(anyhow::anyhow!("No message in response"))?
         .content;
     // Extract content between <aicommit> tags
-    let commit_message = extract_commit_message(msg)?;
+    let commit_message = extract_aicommit_message(msg)?;
     Ok(commit_message)
 }
 
@@ -91,7 +84,7 @@ fn delete_thinking_contents(orig: &str) -> String {
     s
 }
 
-fn extract_commit_message(response: &str) -> anyhow::Result<String> {
+fn extract_aicommit_message(response: &str) -> anyhow::Result<String> {
     let start_tag = "<aicommit>";
     let end_tag = "</aicommit>";
 
@@ -133,3 +126,83 @@ pub async fn generate(args: &cli::Args, config: &Config) -> anyhow::Result<Strin
     let message = generate_commit_message(&diff, config).await?;
     Ok(message)
 }
+
+async fn generate_branch_name_with_ai(
+    diff: &str,
+    prefix: Option<&str>,
+    config: &Config,
+) -> anyhow::Result<String> {
+    let auth = Auth::new(config.api_key.as_str());
+
+    let openai = OpenAI::new(auth, &config.api_base());
+
+    let prompt = BRANCH_NAME_PROMPT.replace("{{diff}}", diff);
+    let messages = vec![
+        Message {
+            role: Role::System,
+            content: "你是一个代码版本控制专家，擅长创建描述性的分支名。".to_string(),
+        },
+        Message {
+            role: Role::User,
+            content: prompt,
+        },
+    ];
+
+    let chat = ChatBody {
+        model: config
+            .model
+            .as_deref()
+            .unwrap_or(DEFAULT_OPENAI_MODEL)
+            .to_owned(),
+        messages,
+        temperature: Some(0.2f32),
+        top_p: None,
+        n: None,
+        stream: Some(false),
+        stop: Some(STOP_WORDS.to_owned()),
+        max_tokens: Some(40),
+        presence_penalty: None,
+        frequency_penalty: None,
+        logit_bias: None,
+        user: None,
+    };
+
+    let response = openai
+        .chat_completion_create(&chat)
+        .map_err(|e| anyhow::anyhow!("Failed to create chat completion: {}", e))?;
+    let msg = response
+        .choices
+        .first()
+        .ok_or(anyhow::anyhow!("No choices in response"))?
+        .message
+        .as_ref()
+        .ok_or(anyhow::anyhow!("No message in response"))?
+        .content
+        .trim()
+        .to_string();
+
+    let branch_name = extract_aicommit_message(&msg)?;
+
+    // Clean up the branch name
+    let branch_name = if let Some(prefix) = prefix {
+        format!("{}{}", prefix.trim(), branch_name.trim())
+    } else {
+        branch_name.trim().to_string()
+    };
+
+    if branch_name.is_empty() {
+        return Err(anyhow::anyhow!("Failed to generate valid branch name"));
+    }
+
+    Ok(branch_name)
+}
+
+pub async fn generate_branch(args: &cli::Args, config: &Config) -> anyhow::Result<String> {
+    let diff = get_diff(args.diff_file.as_deref())?;
+    let prefix = args
+        .branch_prefix
+        .as_deref()
+        .or(config.branch_prefix.as_deref());
+    let branch_name = generate_branch_name_with_ai(&diff, prefix, config).await?;
+    Ok(branch_name)
+}

src/generate.rs

@@ -26,7 +26,12 @@ async fn main() -> anyhow::Result<()> {
         config.verbosity = v;
     }
 
-    let msg = generate::generate(&args, &config).await?;
-    println!("{}", msg);
+    if args.generate_branch {
+        let branch_name = generate::generate_branch(&args, &config).await?;
+        println!("Generated branch name: {}", branch_name);
+    } else {
+        let msg = generate::generate(&args, &config).await?;
+        println!("{}", msg);
+    }
     Ok(())
 }