git_commit_helper/
lib.rs

1// ************************************************************************** //
2//                                                                            //
3//                                                        :::      ::::::::   //
4//   lib.rs                                             :+:      :+:    :+:   //
5//                                                    +:+ +:+         +:+     //
6//   By: dfine <coding@dfine.tech>                  +#+  +:+       +#+        //
7//                                                +#+#+#+#+#+   +#+           //
8//   Created: 2025/05/10 19:12:41 by dfine             #+#    #+#             //
9//   Updated: 2025/05/10 19:12:43 by dfine            ###   ########.fr       //
10//                                                                            //
11// ************************************************************************** //
12
13//! # git-commit-helper
14//!
15/// `git-commit-helper` is a library designed to simplify the process of generating high-quality
16/// Git commit messages using large language models like OpenAI's GPT.
17///
18/// It provides tools to:
19/// - Extract staged diffs and recent commit messages from a Git repository
20/// - Generate commit messages via OpenAI chat completion APIs
21/// - Automatically create commits with the generated messages
22///
23/// ## Example use cases
24/// - Enhance developer workflows with AI-generated commit messages
25/// - Integrate LLM commit generation into custom Git UIs or bots
26pub mod git;
27pub mod llm;
28
29/// Re-exports for convenient use in consumers of the library
30pub use git::{commit_with_git, get_recent_commit_message, get_staged_diff};
31pub use llm::call_openai;